Project

General

Profile

Task(タスク) #4433

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

Added by kaoru n about 2 months ago. Updated 27 days ago.

Status:
Accepted(着手)
Priority:
Normal(通常)
Assignee:
Target version:
Start date:
2020-04-06
Due date:
% Done:

0%


Description

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

History

#1 Updated by kaoru n about 1 month 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 29 days ago

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

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

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

#3 Updated by isao sano 27 days ago

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

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

Also available in: Atom PDF