Project

General

Profile

Task(タスク) #4433

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

Added by kaoru n 3 months ago. Updated 20 days ago.

Status:
Pending Review(レビュー待ち)
Priority:
Normal(通常)
Assignee:
Target version:
Start date:
2020-04-06
Due date:
% Done:

50%


Description

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


Related issues

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

History

#1 Updated by kaoru n 3 months ago

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 Updated by isao sano 2 months ago

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

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

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

#3 Updated by isao sano 2 months ago

  • Status changed from New(新規) to Accepted(着手)
  • Assignee set to isao sano

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

#4 Updated by isao sano about 1 month ago

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

#5 Updated by isao sano 29 days ago

  • Status changed from Accepted(着手) to Pending Review(レビュー待ち)
  • % Done changed from 0 to 50

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

#6 Updated by kaoru n 21 days ago

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

#7 Updated by kaoru n 20 days ago

#8 Updated by isao sano 14 days ago

#9 Updated by isao sano 14 days ago

#10 Updated by isao sano 14 days ago

  • Related to Bug(バグ) #4450: JSON API activity/friends.json が GET に対応していない added

#11 Updated by isao sano 14 days ago

  • Related to Bug(バグ) #4451: JSON API activity/community.json が GET に対応していない added

#12 Updated by isao sano 14 days ago

#13 Updated by isao sano 14 days ago

  • Related to Bug(バグ) #4453: JSON API activity/mentions.json が GET に対応していない added

#14 Updated by isao sano 14 days ago

  • Related to Bug(バグ) #4454: JSON API member/community.json が GET に対応していない added

#15 Updated by isao sano 14 days ago

#16 Updated by isao sano 14 days ago

  • Related to Bug(バグ) #4456: JSON API member/friend_accept.json が GET に対応していない added

#17 Updated by isao sano 14 days ago

  • Related to Bug(バグ) #4457: JSON API member/friend_request.json が GET に対応していない added

#18 Updated by isao sano 14 days ago

  • Related to Bug(バグ) #4458: JSON API community/search.json が GET に対応していない added

#19 Updated by isao sano 14 days ago

  • Related to Bug(バグ) #4459: JSON API community/member.json が GET に対応していない added

#20 Updated by isao sano 14 days ago

#21 Updated by isao sano 14 days ago

#22 Updated by isao sano 14 days ago

#23 Updated by isao sano 14 days ago

#24 Updated by isao sano 14 days ago

  • Related to Bug(バグ) #4465: JSON API topic_comment/post.json が GET に対応していない added

#25 Updated by isao sano 14 days ago

  • Related to Bug(バグ) #4466: JSON API topic_comment/delete.json が GET に対応していない added

#26 Updated by isao sano 14 days ago

  • Related to Bug(バグ) #4467: JSON API topic_comment/search.json が GET に対応していない added

#27 Updated by isao sano 14 days ago

#28 Updated by isao sano 14 days ago

#29 Updated by isao sano 14 days ago

#30 Updated by isao sano 14 days ago

#31 Updated by isao sano 14 days ago

#32 Updated by isao sano 14 days ago

#34 Updated by isao sano 14 days ago

Also available in: Atom PDF