プロジェクト

全般

プロフィール

Task(タスク) #4433

JSON API ドキュメントの見直しと修正

kaoru nほぼ4年前に追加. 約3年前に更新.

ステータス:
Pending Testing(テスト待ち)
優先度:
Normal(通常)
担当者:
対象バージョン:
開始日:
2020-04-06
期日:
進捗率:

70%


説明

http://houou.github.io/api.php/index.html
ドキュメント製作時からの時間経過とともにソースのみ変更されてドキュメントの整備がされていないものが散見されるため、全体的に見直す必要がある。


関連するチケット

関連している OpenPNE 3 - Bug(バグ) #4448: JSON API activity/search.json が GET に対応していない Works for me(再現せず) 2020-06-22
関連している OpenPNE 3 - Bug(バグ) #4449: JSON API activity/member.json が GET に対応していない Works for me(再現せず) 2020-06-22
関連している OpenPNE 3 - Bug(バグ) #4450: JSON API activity/friends.json が GET に対応していない Works for me(再現せず) 2020-06-22
関連している OpenPNE 3 - Bug(バグ) #4451: JSON API activity/community.json が GET に対応していない Works for me(再現せず) 2020-06-22
関連している OpenPNE 3 - Bug(バグ) #4452: JSON API activity/post.json が GET に対応していない Works for me(再現せず) 2020-06-22
関連している OpenPNE 3 - Bug(バグ) #4453: JSON API activity/mentions.json が GET に対応していない Invalid(無効) 2020-06-22
関連している OpenPNE 3 - Bug(バグ) #4454: JSON API member/community.json が GET に対応していない Works for me(再現せず) 2020-06-22
関連している OpenPNE 3 - Bug(バグ) #4455: JSON API member/search.json が GET に対応していない Works for me(再現せず) 2020-06-22
関連している OpenPNE 3 - Bug(バグ) #4456: JSON API member/friend_accept.json が GET に対応していない Works for me(再現せず) 2020-06-22
関連している OpenPNE 3 - Bug(バグ) #4457: JSON API member/friend_request.json が GET に対応していない Works for me(再現せず) 2020-06-22
関連している OpenPNE 3 - Bug(バグ) #4458: JSON API community/search.json が GET に対応していない Works for me(再現せず) 2020-06-22
関連している OpenPNE 3 - Bug(バグ) #4459: JSON API community/member.json が GET に対応していない Works for me(再現せず) 2020-06-22
関連している OpenPNE 3 - Bug(バグ) #4460: JSON API community/join.json が GET に対応していない Works for me(再現せず) 2020-06-22
関連している OpenPNE 3 - Bug(バグ) #4461: JSON API push/read.json が GET に対応していない Works for me(再現せず) 2020-06-22
関連している OpenPNE 3 - Bug(バグ) #4463: JSON API topic/delete.json が GET に対応していない Works for me(再現せず) 2020-06-22
関連している OpenPNE 3 - Bug(バグ) #4464: JSON API topic/search.json が GET に対応していない Works for me(再現せず) 2020-06-22
関連している OpenPNE 3 - Bug(バグ) #4465: JSON API topic_comment/post.json が GET に対応していない Works for me(再現せず) 2020-06-22
関連している OpenPNE 3 - Bug(バグ) #4466: JSON API topic_comment/delete.json が GET に対応していない Works for me(再現せず) 2020-06-22
関連している OpenPNE 3 - Bug(バグ) #4467: JSON API topic_comment/search.json が GET に対応していない Works for me(再現せず) 2020-06-22
関連している OpenPNE 3 - Bug(バグ) #4468: JSON API diary/delete が GET に対応していない Works for me(再現せず) 2020-06-22
関連している opDiaryPlugin - Bug(バグ) #4469: JSON API diary/search が 401 エラーになる Accepted(着手) 2020-06-22
関連している opDiaryPlugin - Bug(バグ) #4470: JSON API diary_comment/search が 401 エラーになる Invalid(無効) 2020-06-22
関連している OpenPNE 3 - Bug(バグ) #4471: JSON API diary_comment/post が GET に対応していない Works for me(再現せず) 2020-06-22
関連している OpenPNE 3 - Bug(バグ) #4472: JSON API diary_comment/delete が GET に対応していない Works for me(再現せず) 2020-06-22
関連している OpenPNE 3 - Bug(バグ) #4473: JSON API activity/delete.json が GET に対応していない Works for me(再現せず) 2020-06-22
関連している OpenPNE 3 - Bug(バグ) #4475: JSON API diary/post が GET に対応していない Works for me(再現せず) 2020-06-22

履歴

#1 kaoru nほぼ4年前に更新

diary/search.json

エラー内容

サンプルリクエスト normal を実行すると下記エラーが発生する

400 Bad Request: invalid target

原因

実行時パラメータに 'target' が存在しないため
https://github.com/tejimaya/opDiaryPlugin/blob/dev-1.5.x/lib/action/opDiaryPluginAPIActions.class.php#L22-L60

#2 isao sanoほぼ4年前に更新

JSON API ドキュメントの検証を行いました。
結果は以下の表です。

https://docs.google.com/spreadsheets/d/1OHcM1lTD_GHHd_KGvSQ5QY9LEtxv6nttidbV0qNMdAE/edit#gid=0

※API自体の修正時には個別にチケットを作成する必要あり

#3 isao sanoほぼ4年前に更新

  • ステータスNew(新規) から Accepted(着手) に変更
  • 担当者isao sano にセット

https://github.com/houou/api.php/pull/11
にてPOSTのみを受け付けるAPIのサンプルリクエストを修正しました。

#4 isao sanoほぼ4年前に更新

https://github.com/houou/api.php/pull/11
にてコミュニティイベントのページを追加しました。

#5 isao sanoほぼ4年前に更新

  • ステータスAccepted(着手) から Pending Review(レビュー待ち) に変更
  • 進捗率0 から 50 に変更

https://github.com/houou/api.php/pull/11
にてmember/friend_request.json の内容を修正しました。

#6 kaoru nほぼ4年前に更新

https://docs.google.com/spreadsheets/d/1OHcM1lTD_GHHd_KGvSQ5QY9LEtxv6nttidbV0qNMdAE/edit#gid=0
のアクセス権をリンクを知っている全員が閲覧できるように変更してください。
編集権限は今のままで良いです。

#7 kaoru nほぼ4年前に更新

#8 isao sanoほぼ4年前に更新

  • 関連している Bug(バグ) #4448: JSON API activity/search.json が GET に対応していない を追加

#9 isao sanoほぼ4年前に更新

  • 関連している Bug(バグ) #4449: JSON API activity/member.json が GET に対応していない を追加

#10 isao sanoほぼ4年前に更新

  • 関連している Bug(バグ) #4450: JSON API activity/friends.json が GET に対応していない を追加

#11 isao sanoほぼ4年前に更新

  • 関連している Bug(バグ) #4451: JSON API activity/community.json が GET に対応していない を追加

#12 isao sanoほぼ4年前に更新

  • 関連している Bug(バグ) #4452: JSON API activity/post.json が GET に対応していない を追加

#13 isao sanoほぼ4年前に更新

  • 関連している Bug(バグ) #4453: JSON API activity/mentions.json が GET に対応していない を追加

#14 isao sanoほぼ4年前に更新

  • 関連している Bug(バグ) #4454: JSON API member/community.json が GET に対応していない を追加

#15 isao sanoほぼ4年前に更新

  • 関連している Bug(バグ) #4455: JSON API member/search.json が GET に対応していない を追加

#16 isao sanoほぼ4年前に更新

  • 関連している Bug(バグ) #4456: JSON API member/friend_accept.json が GET に対応していない を追加

#17 isao sanoほぼ4年前に更新

  • 関連している Bug(バグ) #4457: JSON API member/friend_request.json が GET に対応していない を追加

#18 isao sanoほぼ4年前に更新

  • 関連している Bug(バグ) #4458: JSON API community/search.json が GET に対応していない を追加

#19 isao sanoほぼ4年前に更新

  • 関連している Bug(バグ) #4459: JSON API community/member.json が GET に対応していない を追加

#20 isao sanoほぼ4年前に更新

  • 関連している Bug(バグ) #4460: JSON API community/join.json が GET に対応していない を追加

#21 isao sanoほぼ4年前に更新

  • 関連している Bug(バグ) #4461: JSON API push/read.json が GET に対応していない を追加

#22 isao sanoほぼ4年前に更新

  • 関連している Bug(バグ) #4463: JSON API topic/delete.json が GET に対応していない を追加

#23 isao sanoほぼ4年前に更新

  • 関連している Bug(バグ) #4464: JSON API topic/search.json が GET に対応していない を追加

#24 isao sanoほぼ4年前に更新

  • 関連している Bug(バグ) #4465: JSON API topic_comment/post.json が GET に対応していない を追加

#25 isao sanoほぼ4年前に更新

  • 関連している Bug(バグ) #4466: JSON API topic_comment/delete.json が GET に対応していない を追加

#26 isao sanoほぼ4年前に更新

  • 関連している Bug(バグ) #4467: JSON API topic_comment/search.json が GET に対応していない を追加

#27 isao sanoほぼ4年前に更新

  • 関連している Bug(バグ) #4468: JSON API diary/delete が GET に対応していない を追加

#28 isao sanoほぼ4年前に更新

#29 isao sanoほぼ4年前に更新

  • 関連している Bug(バグ) #4470: JSON API diary_comment/search が 401 エラーになる を追加

#30 isao sanoほぼ4年前に更新

  • 関連している Bug(バグ) #4471: JSON API diary_comment/post が GET に対応していない を追加

#31 isao sanoほぼ4年前に更新

  • 関連している Bug(バグ) #4472: JSON API diary_comment/delete が GET に対応していない を追加

#32 isao sanoほぼ4年前に更新

  • 関連している Bug(バグ) #4473: JSON API activity/delete.json が GET に対応していない を追加

#34 isao sanoほぼ4年前に更新

  • 関連している Bug(バグ) #4475: JSON API diary/post が GET に対応していない を追加

#35 isao sano3年以上前に更新

https://github.com/houou/api.php/pull/11
にてdiary/delete.json のパラメーター名を変更しました。

#36 isao sano3年以上前に更新

JSON API ドキュメントの検証を再度行い、最新の結果に更新しました。
https://docs.google.com/spreadsheets/d/1OHcM1lTD_GHHd_KGvSQ5QY9LEtxv6nttidbV0qNMdAE/edit#gid=0

#37 isao sano3年以上前に更新

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

#38 kaoru n約3年前に更新

  • ステータスPending Review(レビュー待ち) から Fixed(完了) に変更
  • 進捗率50 から 100 に変更

#39 kaoru n約3年前に更新

  • ステータスFixed(完了) から Rejected(差し戻し) に変更
  • 進捗率100 から 50 に変更

#40 kaoru n約3年前に更新

  • ステータスRejected(差し戻し) から Fixed(完了) に変更
  • 進捗率50 から 100 に変更

#41 kaoru n約3年前に更新

  • ステータスFixed(完了) から Rejected(差し戻し) に変更
  • 進捗率100 から 50 に変更

参照: https://redmine.openpne.jp/issues/4453#note-6

curl でリクエストを投げる際に複数パラメータを「&」でつないで渡す場合は、「&」をエスケープしなければいけないので、サンプルリクエストの修正をお願いします。

#42 isao sano約3年前に更新

  • ステータスRejected(差し戻し) から Pending Testing(テスト待ち) に変更
  • 進捗率50 から 70 に変更

に関して
https://github.com/houou/api.php/pull/12
にてプルリクエストしました。

#43 isao sano約3年前に更新

  • #4469#note-8
  • 「開発版API VER. 3.9.X〜」の表記の削除

に関しても
https://github.com/houou/api.php/pull/12
にてプルリクエストしました。

他の形式にエクスポート: Atom PDF