Annofab v0.206.0対応 #725
Merged
Annofab v0.206.0対応 #725
Conversation
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
TitleAdd api Description・バルク取得APIとレスポンスモデルを追加 Changes walkthrough 📝
|
There was a problem hiding this comment.
Pull Request Overview
このPRはAnnofab Web APIのv0.206.0への対応を行うもので、主にAPI仕様の更新とドキュメンテーションの改善を含んでいます。
- バージョンの更新: 0.203.1から0.206.0へ
- セキュリティスキーマの統合と簡素化（EveryoneからAnnofabUserへ）
- 新しいバルク取得APIエンドポイントの追加
Reviewed Changes
Copilot reviewed 23 out of 23 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| generate/swagger/swagger.yaml | APIバージョン更新、セキュリティスキーマ統合、新規バルクAPIエンドポイント追加 |
| generate/swagger/swagger.v2.yaml | バージョン更新とセキュリティスキーマ統合、一部エンドポイント削除 |
| generate/swagger/swagger-api-components.yaml | セキュリティスキーマ統合、新規データモデル追加、ドキュメントリンク更新 |
| docs/api_reference/pydantic_models.rst | 新規Pydanticモデルのドキュメント追加 |
| annofabapi/pydantic_models/*.py | 新規バルク操作用のPydanticモデル実装、既存モデルの更新 |
| annofabapi/models.py | 新規データ型定義の追加とドキュメントリンク更新 |
| annofabapi/generated_api*.py | 新規APIメソッド追加と既存APIの更新 |
| annofabapi/dataclass/annotation_specs.py | ドキュメントリンクの更新 |
Comments suppressed due to low confidence (1)
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| また、AggregationResultの集約の件数は、合計で10000件以下に制限されており、それを超える件数がある場合は上位10000件が取得されます。もし、省略された部分を取得したい場合は、検索条件を縛って結果に上る集約の数を減らしてください。 | ||
| version: 0.203.1 | ||
| version: 0.206.0 |
There was a problem hiding this comment.
The typo 'SON構造' should be corrected to 'JSON構造' in line 2097.
Copilot uses AI. Check for mistakes.
| $ref: "swagger-api-components.yaml#/components/schemas/Project" | ||
| "202": | ||
| description: 組織変更実施時 | ||
| description: クエリパラメータに`v=2`を指定して、所属組織変更を実施した場合 |
There was a problem hiding this comment.
The description for the 202 response should be more specific about when this response occurs. It currently only mentions the query parameter but doesn't clarify that this only applies when an organization change is actually performed.
Suggested change
| description: クエリパラメータに`v=2`を指定して、所属組織変更を実施した場合 | |
| description: クエリパラメータに`v=2`を指定し、かつ実際に所属組織の変更が行われた場合に返されます。 |
Copilot uses AI. Check for mistakes.
PR Reviewer Guide 🔍Here are some key observations to aid the review process:
|
![kci-pr-agent[bot]](https://avatars.githubusercontent.com/in/1245598?s=60&v=4){kind=small}
Comment on lines
+238
to
+267
| def get_editor_annotations_in_bulk( | ||
| self, project_id: str, task_id: str, query_params: Optional[dict[str, Any]] = None, **kwargs | ||
| ) -> tuple[Any, requests.Response]: | ||
| """アノテーションのバルク取得 | ||
| https://annofab.com/docs/api/#operation/getEditorAnnotationsInBulk | ||
| authorizations: AllProjectMember | ||
| アノテーションをバルク取得します。 このAPIは、[getEditorAnnotation](#operation/getEditorAnnotation) APIと似た機能を持ちますが、`input_data_id`を複数指定できる点が異なります。 | ||
| Args: | ||
| project_id (str): プロジェクトID (required) | ||
| task_id (str): タスクID (required) | ||
| query_params (dict[str, Any]): Query Parameters | ||
| input_data_id (list[str]): 入力データID (required) | ||
| Returns: | ||
| tuple[GetEditorAnnotationsInBulkResponse, requests.Response] | ||
| """ | ||
| url_path = f"/projects/{project_id}/tasks/{task_id}/annotations-in-bulk" | ||
| http_method = "GET" | ||
| keyword_params: dict[str, Any] = { | ||
| "query_params": query_params, | ||
| } | ||
| keyword_params.update(**kwargs) | ||
| return self._request_wrapper(http_method, url_path, **keyword_params) |
There was a problem hiding this comment.
Suggestion: query_params が None または必須キー input_data_id を含まない場合に早期に例外を投げるようバリデーションを追加してください。API 呼び出し前に必須パラメータの漏れを検知できます。 [possible issue, importance: 5]
Suggested change
| def get_editor_annotations_in_bulk( | |
| self, project_id: str, task_id: str, query_params: Optional[dict[str, Any]] = None, **kwargs | |
| ) -> tuple[Any, requests.Response]: | |
| """アノテーションのバルク取得 | |
| https://annofab.com/docs/api/#operation/getEditorAnnotationsInBulk | |
| authorizations: AllProjectMember | |
| アノテーションをバルク取得します。 このAPIは、[getEditorAnnotation](#operation/getEditorAnnotation) APIと似た機能を持ちますが、`input_data_id`を複数指定できる点が異なります。 | |
| Args: | |
| project_id (str): プロジェクトID (required) | |
| task_id (str): タスクID (required) | |
| query_params (dict[str, Any]): Query Parameters | |
| input_data_id (list[str]): 入力データID (required) | |
| Returns: | |
| tuple[GetEditorAnnotationsInBulkResponse, requests.Response] | |
| """ | |
| url_path = f"/projects/{project_id}/tasks/{task_id}/annotations-in-bulk" | |
| http_method = "GET" | |
| keyword_params: dict[str, Any] = { | |
| "query_params": query_params, | |
| } | |
| keyword_params.update(**kwargs) | |
| return self._request_wrapper(http_method, url_path, **keyword_params) | |
| def get_editor_annotations_in_bulk( | |
| self, project_id: str, task_id: str, query_params: Optional[dict[str, Any]] = None, **kwargs | |
| ) -> tuple[Any, requests.Response]: | |
| """アノテーションのバルク取得 ...""" | |
| if not query_params or "input_data_id" not in query_params: | |
| raise ValueError("`query_params` に必須キー `input_data_id` を含めて指定してください") | |
| url_path = f"/projects/{project_id}/tasks/{task_id}/annotations-in-bulk" | |
| http_method = "GET" | |
| keyword_params: dict[str, Any] = {"query_params": query_params} | |
| keyword_params.update(**kwargs) | |
| return self._request_wrapper(http_method, url_path, **keyword_params) |
Comment on lines
+642
to
+668
| def get_input_data_in_bulk(self, project_id: str, query_params: Optional[dict[str, Any]] = None, **kwargs) -> tuple[Any, requests.Response]: | ||
| """入力データのバルク取得 | ||
| https://annofab.com/docs/api/#operation/getInputDataInBulk | ||
| authorizations: AllProjectMember | ||
| 入力データをバルク取得します。 このAPIは、[getInputData](#operation/getInputData) APIと似た機能を持ちますが、`input_data_id`を複数指定できる点が異なります。 | ||
| Args: | ||
| project_id (str): プロジェクトID (required) | ||
| query_params (dict[str, Any]): Query Parameters | ||
| input_data_id (list[str]): 入力データIDのカンマ区切りリスト (required) | ||
| Returns: | ||
| tuple[GetInputDataInBulkResponse, requests.Response] | ||
| """ | ||
| url_path = f"/projects/{project_id}/input-data-in-bulk" | ||
| http_method = "GET" | ||
| keyword_params: dict[str, Any] = { | ||
| "query_params": query_params, | ||
| } | ||
| keyword_params.update(**kwargs) | ||
| return self._request_wrapper(http_method, url_path, **keyword_params) |
There was a problem hiding this comment.
Suggestion: query_params が指定されていない場合や input_data_id キーがない場合に ValueError を投げるバリデーションを追加してください。不正リクエストを防止できます。 [possible issue, importance: 5]
Suggested change
| def get_input_data_in_bulk(self, project_id: str, query_params: Optional[dict[str, Any]] = None, **kwargs) -> tuple[Any, requests.Response]: | |
| """入力データのバルク取得 | |
| https://annofab.com/docs/api/#operation/getInputDataInBulk | |
| authorizations: AllProjectMember | |
| 入力データをバルク取得します。 このAPIは、[getInputData](#operation/getInputData) APIと似た機能を持ちますが、`input_data_id`を複数指定できる点が異なります。 | |
| Args: | |
| project_id (str): プロジェクトID (required) | |
| query_params (dict[str, Any]): Query Parameters | |
| input_data_id (list[str]): 入力データIDのカンマ区切りリスト (required) | |
| Returns: | |
| tuple[GetInputDataInBulkResponse, requests.Response] | |
| """ | |
| url_path = f"/projects/{project_id}/input-data-in-bulk" | |
| http_method = "GET" | |
| keyword_params: dict[str, Any] = { | |
| "query_params": query_params, | |
| } | |
| keyword_params.update(**kwargs) | |
| return self._request_wrapper(http_method, url_path, **keyword_params) | |
| def get_input_data_in_bulk( | |
| self, project_id: str, query_params: Optional[dict[str, Any]] = None, **kwargs | |
| ) -> tuple[Any, requests.Response]: | |
| """入力データのバルク取得 ...""" | |
| if not query_params or "input_data_id" not in query_params: | |
| raise ValueError("`query_params` に必須キー `input_data_id` を含めて指定してください") | |
| url_path = f"/projects/{project_id}/input-data-in-bulk" | |
| http_method = "GET" | |
| keyword_params: dict[str, Any] = {"query_params": query_params} | |
| keyword_params.update(**kwargs) | |
| return self._request_wrapper(http_method, url_path, **keyword_params) |
Comment on lines
+2760
to
+2788
| def get_supplementary_data_in_bulk( | ||
| self, project_id: str, query_params: Optional[dict[str, Any]] = None, **kwargs | ||
| ) -> tuple[Any, requests.Response]: | ||
| """補助情報のバルク取得 | ||
| https://annofab.com/docs/api/#operation/getSupplementaryDataInBulk | ||
| authorizations: AllProjectMember | ||
| 補助情報をバルク取得します。 このAPIは、[getSupplementaryDataList](#operation/getSupplementaryDataList) APIと似た機能を持ちますが、`input_data_id`を複数指定できる点が異なります。 | ||
| Args: | ||
| project_id (str): プロジェクトID (required) | ||
| query_params (dict[str, Any]): Query Parameters | ||
| input_data_id (list[str]): 入力データIDのカンマ区切りリスト (required) | ||
| Returns: | ||
| tuple[GetSupplementaryDataInBulkResponse, requests.Response] | ||
| """ | ||
| url_path = f"/projects/{project_id}/supplementary-data-in-bulk" | ||
| http_method = "GET" | ||
| keyword_params: dict[str, Any] = { | ||
| "query_params": query_params, | ||
| } | ||
| keyword_params.update(**kwargs) | ||
| return self._request_wrapper(http_method, url_path, **keyword_params) |
There was a problem hiding this comment.
Suggestion: query_params が None または input_data_id が空の場合に例外を投げるチェックを入れてください。不正な呼び出しを防げます。 [possible issue, importance: 5]
Suggested change
| def get_supplementary_data_in_bulk( | |
| self, project_id: str, query_params: Optional[dict[str, Any]] = None, **kwargs | |
| ) -> tuple[Any, requests.Response]: | |
| """補助情報のバルク取得 | |
| https://annofab.com/docs/api/#operation/getSupplementaryDataInBulk | |
| authorizations: AllProjectMember | |
| 補助情報をバルク取得します。 このAPIは、[getSupplementaryDataList](#operation/getSupplementaryDataList) APIと似た機能を持ちますが、`input_data_id`を複数指定できる点が異なります。 | |
| Args: | |
| project_id (str): プロジェクトID (required) | |
| query_params (dict[str, Any]): Query Parameters | |
| input_data_id (list[str]): 入力データIDのカンマ区切りリスト (required) | |
| Returns: | |
| tuple[GetSupplementaryDataInBulkResponse, requests.Response] | |
| """ | |
| url_path = f"/projects/{project_id}/supplementary-data-in-bulk" | |
| http_method = "GET" | |
| keyword_params: dict[str, Any] = { | |
| "query_params": query_params, | |
| } | |
| keyword_params.update(**kwargs) | |
| return self._request_wrapper(http_method, url_path, **keyword_params) | |
| def get_supplementary_data_in_bulk( | |
| self, project_id: str, query_params: Optional[dict[str, Any]] = None, **kwargs | |
| ) -> tuple[Any, requests.Response]: | |
| """補助情報のバルク取得 ...""" | |
| if not query_params or "input_data_id" not in query_params: | |
| raise ValueError("`query_params` に必須キー `input_data_id` を含めて指定してください") | |
| url_path = f"/projects/{project_id}/supplementary-data-in-bulk" | |
| http_method = "GET" | |
| keyword_params: dict[str, Any] = {"query_params": query_params} | |
| keyword_params.update(**kwargs) | |
| return self._request_wrapper(http_method, url_path, **keyword_params) |
Comment on lines
+3027
to
+3053
| def get_tasks_in_bulk(self, project_id: str, query_params: Optional[dict[str, Any]] = None, **kwargs) -> tuple[Any, requests.Response]: | ||
| """タスクのバルク取得 | ||
| https://annofab.com/docs/api/#operation/getTasksInBulk | ||
| authorizations: AllProjectMember | ||
| タスクをバルク取得します。 このAPIは、[getTask](#operation/getTask) APIと似た機能を持ちますが、`task_id`を複数指定できる点が異なります。 | ||
| Args: | ||
| project_id (str): プロジェクトID (required) | ||
| query_params (dict[str, Any]): Query Parameters | ||
| task_id (list[str]): タスクIDのカンマ区切りリスト (required) | ||
| Returns: | ||
| tuple[GetTasksInBulkResponse, requests.Response] | ||
| """ | ||
| url_path = f"/projects/{project_id}/tasks-in-bulk" | ||
| http_method = "GET" | ||
| keyword_params: dict[str, Any] = { | ||
| "query_params": query_params, | ||
| } | ||
| keyword_params.update(**kwargs) | ||
| return self._request_wrapper(http_method, url_path, **keyword_params) |
There was a problem hiding this comment.
Suggestion: query_params に必須の task_id が含まれているかをチェックし、欠如時は早期にエラーを返すバリデーションを追加してください。 [possible issue, importance: 5]
Suggested change
| def get_tasks_in_bulk(self, project_id: str, query_params: Optional[dict[str, Any]] = None, **kwargs) -> tuple[Any, requests.Response]: | |
| """タスクのバルク取得 | |
| https://annofab.com/docs/api/#operation/getTasksInBulk | |
| authorizations: AllProjectMember | |
| タスクをバルク取得します。 このAPIは、[getTask](#operation/getTask) APIと似た機能を持ちますが、`task_id`を複数指定できる点が異なります。 | |
| Args: | |
| project_id (str): プロジェクトID (required) | |
| query_params (dict[str, Any]): Query Parameters | |
| task_id (list[str]): タスクIDのカンマ区切りリスト (required) | |
| Returns: | |
| tuple[GetTasksInBulkResponse, requests.Response] | |
| """ | |
| url_path = f"/projects/{project_id}/tasks-in-bulk" | |
| http_method = "GET" | |
| keyword_params: dict[str, Any] = { | |
| "query_params": query_params, | |
| } | |
| keyword_params.update(**kwargs) | |
| return self._request_wrapper(http_method, url_path, **keyword_params) | |
| def get_tasks_in_bulk( | |
| self, project_id: str, query_params: Optional[dict[str, Any]] = None, **kwargs | |
| ) -> tuple[Any, requests.Response]: | |
| """タスクのバルク取得 ...""" | |
| if not query_params or "task_id" not in query_params: | |
| raise ValueError("`query_params` に必須キー `task_id` を含めて指定してください") | |
| url_path = f"/projects/{project_id}/tasks-in-bulk" | |
| http_method = "GET" | |
| keyword_params: dict[str, Any] = {"query_params": query_params} | |
| keyword_params.update(**kwargs) | |
| return self._request_wrapper(http_method, url_path, **keyword_params) |
| type: array | ||
| items: | ||
| $ref: "swagger-api-components.yaml#/components/schemas/TaskId" | ||
| example: [task_1,task_2,task_3] |
There was a problem hiding this comment.
Suggestion: exampleの配列要素は有効なJSON文字列として引用符で囲みます。他のbulk取得エンドポイントのexampleも同様に修正してください。 [general, importance: 7]
Suggested change
| example: [task_1,task_2,task_3] | |
| example: ["task_1","task_2","task_3"] |
Comment on lines
2910
to
2911
| security: | ||
| - AllProjectMember: [] |
There was a problem hiding this comment.
Suggestion: security下のリスト要素はインデントを2スペース深くして正しくネストしてください。 [possible issue, importance: 4]
Suggested change
| security: | |
| - AllProjectMember: [] | |
| security: | |
| - AllProjectMember: [] |
Comment on lines
+42
to
+45
| def to_json(self) -> str: | ||
| """Returns the JSON representation of the model using alias""" | ||
| # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead | ||
| return json.dumps(self.to_dict()) |
There was a problem hiding this comment.
Suggestion: TODOの通り、model_dump_jsonを直接使用してJSON文字列を生成すると余計なjson.dumpsを避けられます。 [general, importance: 5]
Suggested change
| def to_json(self) -> str: | |
| """Returns the JSON representation of the model using alias""" | |
| # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead | |
| return json.dumps(self.to_dict()) | |
| def to_json(self) -> str: | |
| """Returns the JSON representation of the model using alias""" | |
| return self.model_dump_json(by_alias=True, exclude_unset=True) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
generated_api.py
以下のメソッドが追加されました。