Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Swagger UI 上のドキュメントを整備する #126

Merged
merged 19 commits into from
Nov 2, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docs: topics を複数指定した場合の挙動を追記
sushichan044 committed Oct 25, 2024

Verified

This commit was signed with the committer’s verified signature.
BenCheung0422 Ben Forge
commit a4290cb59b4bafb448ca5eda8927f830ca611446
2 changes: 2 additions & 0 deletions api/birdxplorer_api/routers/openapi_doc.py
Original file line number Diff line number Diff line change
@@ -233,6 +233,8 @@ class V1DataPostsQueryDocs:
取得するコミュニティノートが紐づいているトピックの ID。

`GET /api/v1/data/topics` で取得できるトピックの ID を指定することで、そのトピックに紐づいたコミュニティノートを取得できる。

複数指定した場合は、 **いずれかのトピックに紐づいたコミュニティノート** を取得する。 (AND 検索ではなく OR 検索になる)
""",
"openapi_examples": {
"single": {