Skip to content

swagger.yamlのonlyAdministratedByMeの説明文を修正#1220

Open
reiroop wants to merge 3 commits intomainfrom
fix/swagger/onlyAdministratedByMeInQuery
Open

swagger.yamlのonlyAdministratedByMeの説明文を修正#1220
reiroop wants to merge 3 commits intomainfrom
fix/swagger/onlyAdministratedByMeInQuery

Conversation

@reiroop
Copy link
Copy Markdown
Contributor

@reiroop reiroop commented May 2, 2024

自分が管理者になっているもののみ取得 (true), 管理者になっていないものも含めてすべて取得 (false)。デフォルトはfalse。

Summary by CodeRabbit

Documentation

  • onlyAdministratedByMe クエリパラメータの説明を修正しました。パラメータが true のときはユーザーが管理者であるアイテムのみを返し、false のときはすべてのアイテムを返すことを正確に説明するよう日本語の記述を更新しました。

自分が管理者になっているもののみ取得 (true), 管理者になっていないものも含めてすべて取得 (false)。デフォルトはfalse。
@reiroop reiroop requested review from cp-20 and kaitoyama May 2, 2024 07:44
@reiroop reiroop self-assigned this May 2, 2024
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 16, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 1569294c-b7cc-4ab5-ae3d-c75fc8b90003

📥 Commits

Reviewing files that changed from the base of the PR and between 6a1bbd4 and c57bac9.

📒 Files selected for processing (3)
  • docs/swagger/swagger.yaml
  • openapi/spec.go
  • openapi/types.go

📝 Walkthrough

Walkthrough

onlyAdministratedByMeクエリパラメータの日本語説明テキストを複数のファイルで修正した。ブール値の意味を明確化し、trueで管理者である項目のみ、falseで全項目を返すことを正確に記述。OpenAPI仕様の符号化版も更新。

Changes

Cohort / File(s) Summary
ドキュメント・説明の更新
docs/swagger/swagger.yaml, openapi/spec.go, openapi/types.go
onlyAdministratedByMeパラメータの日本語説明を修正。true時は管理者である項目のみ、false時は全項目を返すという正確な記述に統一。基盤となるロジックやAPI署名に変更なし。

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed PRタイトルは、swagger.yaml内のonlyAdministratedByMeパラメータの説明文を修正するという変更内容を正確に反映しており、主な変更を明確かつ簡潔に要約しています。
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/swagger/onlyAdministratedByMeInQuery

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@Eraxyso Eraxyso enabled auto-merge April 16, 2026 14:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants