Hm/add api reference#25
Open
Masaya1022 wants to merge 50 commits into
Open
Conversation
KaRU3-dev
requested changes
Dec 22, 2025
Member
There was a problem hiding this comment.
これはCoreAPIの仕様を外部または開発者に共有するための資料です。なので、gRPCサービスの説明と各gRPCメソッドの説明、リクエストデータとレスポンスデータの説明、認証の有無などを含める必要があります。また、このドキュメントはCoreAPIのものなので内部サービスのドキュメントは含めないでください。マークダウン記法も活用してください。
例）
V0SampleService.md
V0SampleService
これは、サンプルのgRPCサービスです。ユーザーに 目的 を提供します。
メソッドは、Method1 / Method2 を実装しています。
Method1
リクエスト： google.protobuf.Empty リクエストの説明
レスポンス：google.protobuf.Empty レスポンスの説明
RPC
rpc Method1(google.protobuf.Empty) returns (google.protobuf.Empty);- リクエストとレスポンスを含め、説明を追加。 - わかりやすいように、見た目の修正。 - 認証が必要か必要じゃないかの確認を追加。
- リクエストとレスポンスを含め、説明を追加。 - わかりやすいように、見た目の修正。 - 認証が必要か必要じゃないかの確認を追加。
- リクエストとレスポンスを含め、説明を追加。 - わかりやすいように、見た目の修正。 - 認証が必要か必要じゃないかの確認を追加。
- リクエストとレスポンスを含め、説明を追加。 - わかりやすいように、見た目の修正。 - 認証が必要か必要じゃないかの確認を追加
- リクエストとレスポンスを含め、説明を追加。 - わかりやすいように、見た目の修正。 - 認証が必要か必要じゃないかの確認を追加。
- リクエストとレスポンスを含め、説明を追加。 - わかりやすいように、見た目の修正。 - 認証が必要か必要じゃないかの確認を追加。
- リクエストとレスポンスを含め、説明を追加。 - わかりやすいように、見た目の修正。 - 認証が必要か必要じゃないかの確認を追加。
KaRU3-dev
requested changes
Dec 27, 2025
Comment on lines
+15
to
+23
| ## 認証方法 | ||
| 認証が必要な RPC では、Metadata に以下の形式でトークンを付与します。 | ||
|
|
||
| ## 認証が必要な RPC | ||
| - GetProfile | ||
| - UpdateProfile | ||
| - DeleteAccount | ||
|
|
||
| ## 認証が不要な RPC |
Comment on lines
+28
to
+32
| # 2.サービス一覧 | ||
|
|
||
| | サービス名 | 説明 | | ||
| |--------------|--------------------------------------------------| | ||
| | V0ApiService | ユーザーのアカウントを登録するAPI gRPCサービスです。| |
Member
There was a problem hiding this comment.
これは、docsフォルダに直接V0.mdファイルを配置し、そこに移動してください。
Comment on lines
+40
to
+43
| | Register | V0AccountRegisterRequest | google.protobuf.Empty | ユーザーのメールアドレスとパスワードを利用してアカウントを登録するためのメソッド。| 不要 | | ||
| | GetProfile | V0AccountGetProfileRequest | V0BaseAccount | ユーザーのIDを利用してアカウントの情報を取得するためのメソッド。| 必要 | | ||
| | UpdateProfile | V0AccountUpdateProfileRequest| V0BaseAccount | ユーザーID、更新するユーザー名、更新するアバターURL、更新するメールアドレス、更新する通知設定、更新するパスワード(ハッシュ化済み)、更新するステータスを利用してアカウントの情報を更新するためのメソッド。| 必要 | | ||
| | DeleteAccount | google.protobuf.Empty| google.protobuf.Empty | 空を送り、アカウントを削除するためのメソッド。| 必要 | |
Member
There was a problem hiding this comment.
RPCがどういうリクエストやレスポンスを行うかを別々のセクションにまとめること。また、リクエストやレスポンスがどのようなデータを含めることができるかをまとめてください。
KaRU3-dev
reviewed
Dec 27, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
変更