Task(タスク) #4433
未完了JSON API ドキュメントの見直しと修正
70%
説明
http://houou.github.io/api.php/index.html
ドキュメント製作時からの時間経過とともにソースのみ変更されてドキュメントの整備がされていないものが散見されるため、全体的に見直す必要がある。
isao sano さんが4年以上前に更新
JSON API ドキュメントの検証を行いました。
結果は以下の表です。
https://docs.google.com/spreadsheets/d/1OHcM1lTD_GHHd_KGvSQ5QY9LEtxv6nttidbV0qNMdAE/edit#gid=0
※API自体の修正時には個別にチケットを作成する必要あり
isao sano さんが4年以上前に更新
- ステータス を New(新規) から Accepted(着手) に変更
- 担当者 を isao sano にセット
https://github.com/houou/api.php/pull/11
にてPOSTのみを受け付けるAPIのサンプルリクエストを修正しました。
isao sano さんが4年以上前に更新
- ステータス を Accepted(着手) から Pending Review(レビュー待ち) に変更
- 進捗率 を 0 から 50 に変更
https://github.com/houou/api.php/pull/11
にてmember/friend_request.json の内容を修正しました。
kaoru n さんが4年以上前に更新
https://docs.google.com/spreadsheets/d/1OHcM1lTD_GHHd_KGvSQ5QY9LEtxv6nttidbV0qNMdAE/edit#gid=0
のアクセス権をリンクを知っている全員が閲覧できるように変更してください。
編集権限は今のままで良いです。
isao sano さんが4年以上前に更新
- 関連している Bug(バグ) #4448: JSON API activity/search.json が GET に対応していない を追加
isao sano さんが4年以上前に更新
- 関連している Bug(バグ) #4449: JSON API activity/member.json が GET に対応していない を追加
isao sano さんが4年以上前に更新
- 関連している Bug(バグ) #4450: JSON API activity/friends.json が GET に対応していない を追加
isao sano さんが4年以上前に更新
- 関連している Bug(バグ) #4451: JSON API activity/community.json が GET に対応していない を追加
isao sano さんが4年以上前に更新
- 関連している Bug(バグ) #4452: JSON API activity/post.json が GET に対応していない を追加
isao sano さんが4年以上前に更新
- 関連している Bug(バグ) #4453: JSON API activity/mentions.json が GET に対応していない を追加
isao sano さんが4年以上前に更新
- 関連している Bug(バグ) #4454: JSON API member/community.json が GET に対応していない を追加
isao sano さんが4年以上前に更新
- 関連している Bug(バグ) #4455: JSON API member/search.json が GET に対応していない を追加
isao sano さんが4年以上前に更新
- 関連している Bug(バグ) #4456: JSON API member/friend_accept.json が GET に対応していない を追加
isao sano さんが4年以上前に更新
- 関連している Bug(バグ) #4457: JSON API member/friend_request.json が GET に対応していない を追加
isao sano さんが4年以上前に更新
- 関連している Bug(バグ) #4458: JSON API community/search.json が GET に対応していない を追加
isao sano さんが4年以上前に更新
- 関連している Bug(バグ) #4459: JSON API community/member.json が GET に対応していない を追加
isao sano さんが4年以上前に更新
- 関連している Bug(バグ) #4460: JSON API community/join.json が GET に対応していない を追加
isao sano さんが4年以上前に更新
- 関連している Bug(バグ) #4461: JSON API push/read.json が GET に対応していない を追加
isao sano さんが4年以上前に更新
- 関連している Bug(バグ) #4463: JSON API topic/delete.json が GET に対応していない を追加
isao sano さんが4年以上前に更新
- 関連している Bug(バグ) #4464: JSON API topic/search.json が GET に対応していない を追加
isao sano さんが4年以上前に更新
- 関連している Bug(バグ) #4465: JSON API topic_comment/post.json が GET に対応していない を追加
isao sano さんが4年以上前に更新
- 関連している Bug(バグ) #4466: JSON API topic_comment/delete.json が GET に対応していない を追加
isao sano さんが4年以上前に更新
- 関連している Bug(バグ) #4467: JSON API topic_comment/search.json が GET に対応していない を追加
isao sano さんが4年以上前に更新
- 関連している Bug(バグ) #4470: JSON API diary_comment/search が 401 エラーになる を追加
isao sano さんが4年以上前に更新
- 関連している Bug(バグ) #4471: JSON API diary_comment/post が GET に対応していない を追加
isao sano さんが4年以上前に更新
- 関連している Bug(バグ) #4472: JSON API diary_comment/delete が GET に対応していない を追加
isao sano さんが4年以上前に更新
- 関連している Bug(バグ) #4473: JSON API activity/delete.json が GET に対応していない を追加
isao sano さんが4年以上前に更新
https://github.com/houou/api.php/pull/11
にてdiary/delete.json のパラメーター名を変更しました。
isao sano さんが4年以上前に更新
JSON API ドキュメントの検証を再度行い、最新の結果に更新しました。
https://docs.google.com/spreadsheets/d/1OHcM1lTD_GHHd_KGvSQ5QY9LEtxv6nttidbV0qNMdAE/edit#gid=0
isao sano さんが約4年前に更新
https://github.com/houou/api.php/pull/11
にてdiary/post.json のサンプルリクエストの誤記を修正しました。
残りの問題は下記の3チケットです。
・https://redmine.openpne.jp/issues/4453
※下記の修正により現行のopTimelinePlugin ではスクリーンネームの設定が削除されています。
https://github.com/kashiwasan/opTimelinePlugin/issues/34
・https://redmine.openpne.jp/issues/4469
・https://redmine.openpne.jp/issues/4470
kaoru n さんがほぼ4年前に更新
- ステータス を Fixed(完了) から Rejected(差し戻し) に変更
- 進捗率 を 100 から 50 に変更
参照: https://redmine.openpne.jp/issues/4453#note-6
curl でリクエストを投げる際に複数パラメータを「&」でつないで渡す場合は、「&」をエスケープしなければいけないので、サンプルリクエストの修正をお願いします。
isao sano さんがほぼ4年前に更新
- ステータス を Rejected(差し戻し) から Pending Testing(テスト待ち) に変更
- 進捗率 を 50 から 70 に変更
に関して
https://github.com/houou/api.php/pull/12
にてプルリクエストしました。
isao sano さんがほぼ4年前に更新
- #4469#note-8
- 「開発版API VER. 3.9.X〜」の表記の削除
に関しても
https://github.com/houou/api.php/pull/12
にてプルリクエストしました。