Annofab v0.90.0対応 (#178)

* annofab v0.90.0対応

* version up

Author: yuji38kwmt

annofabapi/__version__.py

@@ -1 +1 @@
-__version__ = "0.34.0"
+__version__ = "0.35.0"

annofabapi/dataclass/annotation_specs.py

@@ -21,6 +21,8 @@
 
 AdditionalDataRestrictionCondition = Dict[str, Any]
 
+AnnotationSpecsOption = Dict[str, Any]
+
 
 @dataclass_json
 @dataclass
@@ -412,6 +414,9 @@ class AnnotationSpecsV1:
     updated_datetime: Optional[str]
     """アノテーション仕様の最終更新時刻 """
 
+    option: Optional[AnnotationSpecsOption]
+    """"""
+
 
 @dataclass_json
 @dataclass
@@ -440,3 +445,6 @@ class AnnotationSpecsV2:
 
     updated_datetime: Optional[str]
     """アノテーション仕様の最終更新時刻 """
+
+    option: Optional[AnnotationSpecsOption]
+    """"""

annofabapi/generated_api.py

@@ -47,6 +47,7 @@ def get_annotation_specs_v2(
         authorizations: SignedCookieKeyPairId, SignedCookiePolicy, SignedCookieSignature
 
 
+        指定したプロジェクトのアノテーション仕様を取得します。  本 API は `cache` クエリパラメータが同じであれば結果がキャッシュされ、以降は高速にレスポンスが返ります。 
 
         Args:
             project_id (str):  プロジェクトID (required)
@@ -137,12 +138,13 @@ def get_organization_members_v2(
     def get_organization_by_name_v2(
         self, organization_name: str, query_params: Optional[Dict[str, Any]] = None, **kwargs
     ) -> Tuple[Any, requests.Response]:
-        """組織情報取得
+        """組織名で組織情報取得
 
 
         authorizations: SignedCookieKeyPairId, SignedCookiePolicy, SignedCookieSignature
 
 
+        指定された組織を取得します。  本 API は `cache` クエリパラメータが同じであれば結果がキャッシュされ、以降は高速にレスポンスが返ります。 
 
         Args:
             organization_name (str):  組織名 (required)
@@ -162,12 +164,13 @@ def get_organization_by_name_v2(
         return self._request_wrapper(http_method, url_path, **keyword_params)
 
     def get_organization_cache_by_name_v2(self, organization_name: str, **kwargs) -> Tuple[Any, requests.Response]:
-        """キャッシュレコード
+        """組織名で組織キャッシュレコード取得
 
 
         authorizations: SignedCookieKeyPairId, SignedCookiePolicy, SignedCookieSignature
 
 
+        組織の各リソースのキャッシュタイムスタンプを格納したキャッシュレコードを取得します。  これらタイムスタンプは、各リソースを取得する API の `cache` クエリパラメータに使用します。 
 
         Args:
             organization_name (str):  組織名 (required)
@@ -183,12 +186,13 @@ def get_organization_cache_by_name_v2(self, organization_name: str, **kwargs) ->
         return self._request_wrapper(http_method, url_path, **keyword_params)
 
     def get_organization_cache_v2(self, organization_id: str, **kwargs) -> Tuple[Any, requests.Response]:
-        """キャッシュレコード
+        """組織IDで組織キャッシュレコード取得
 
 
         authorizations: SignedCookieKeyPairId, SignedCookiePolicy, SignedCookieSignature
 
 
+        組織の各リソースのキャッシュタイムスタンプを格納したキャッシュレコードを取得します。  これらタイムスタンプは、各リソースを取得する API の `cache` クエリパラメータに使用します。 
 
         Args:
             organization_id (str):  組織ID (required)
@@ -206,12 +210,13 @@ def get_organization_cache_v2(self, organization_id: str, **kwargs) -> Tuple[Any
     def get_organization_v2(
         self, organization_id: str, query_params: Optional[Dict[str, Any]] = None, **kwargs
     ) -> Tuple[Any, requests.Response]:
-        """組織情報取得
+        """組織IDで組織情報取得
 
 
         authorizations: SignedCookieKeyPairId, SignedCookiePolicy, SignedCookieSignature
 
 
+        指定された組織を取得します。  本 API は `cache` クエリパラメータが同じであれば結果がキャッシュされ、以降は高速にレスポンスが返ります。 
 
         Args:
             organization_id (str):  組織ID (required)
@@ -239,6 +244,7 @@ def get_project_task_count_v2(
         authorizations: SignedCookieKeyPairId, SignedCookiePolicy, SignedCookieSignature
 
 
+        プロジェクトのタスク件数を取得します。 
 
         Args:
             organization_id (str):  組織ID (required)
@@ -268,6 +274,7 @@ def get_project_member_v2(
         authorizations: SignedCookieKeyPairId, SignedCookiePolicy, SignedCookieSignature
 
 
+        指定したプロジェクトメンバーを取得します。 
 
         Args:
             project_id (str):  プロジェクトID (required)
@@ -290,12 +297,13 @@ def get_project_member_v2(
     def get_project_members_v2(
         self, project_id: str, query_params: Optional[Dict[str, Any]] = None, **kwargs
     ) -> Tuple[Any, requests.Response]:
-        """プロジェクトメンバー一括取得
+        """プロジェクトメンバー検索
 
 
         authorizations: SignedCookieKeyPairId, SignedCookiePolicy, SignedCookieSignature
 
 
+        指定されたプロジェクトのメンバーを検索します。  パフォーマンスのため、結果はページング形式で返ります。全件取得したい場合は、レスポンスを見て、ページ移動してください。 
 
         Args:
             project_id (str):  プロジェクトID (required)
@@ -321,12 +329,13 @@ def get_project_members_v2(
     #########################################
 
     def get_project_cache_v2(self, project_id: str, **kwargs) -> Tuple[Any, requests.Response]:
-        """キャッシュレコード
+        """プロジェクトキャッシュレコード取得
 
 
         authorizations: SignedCookieKeyPairId, SignedCookiePolicy, SignedCookieSignature
 
 
+        プロジェクトの各種リソースのキャッシュタイムスタンプを取得します。  これらタイムスタンプは、各リソースを取得する API の `cache` クエリパラメータに使用します。 
 
         Args:
             project_id (str):  プロジェクトID (required)
@@ -355,6 +364,7 @@ def get_account_statistics_v2(
         authorizations: SignedCookieKeyPairId, SignedCookiePolicy, SignedCookieSignature
 
 
+        指定したプロジェクトのユーザー別タスク集計をすべて取得します。 
 
         Args:
             project_id (str):  プロジェクトID (required)
@@ -382,6 +392,7 @@ def get_inspection_statistics_v2(
         authorizations: SignedCookieKeyPairId, SignedCookiePolicy, SignedCookieSignature
 
 
+        指定したプロジェクトの検査コメント集計をすべて取得します。 
 
         Args:
             project_id (str):  プロジェクトID (required)
@@ -409,6 +420,7 @@ def get_label_statistics_v2(
         authorizations: SignedCookieKeyPairId, SignedCookiePolicy, SignedCookieSignature
 
 
+        指定したプロジェクトのラベル別アノテーション数集計をすべて取得します。 
 
         Args:
             project_id (str):  プロジェクトID (required)
@@ -436,6 +448,7 @@ def get_task_phase_statistics_v2(
         authorizations: SignedCookieKeyPairId, SignedCookiePolicy, SignedCookieSignature
 
 
+        指定したプロジェクトのフェーズ別タスク集計をすべて取得します。 
 
         Args:
             project_id (str):  プロジェクトID (required)
@@ -463,6 +476,7 @@ def get_task_statistics_v2(
         authorizations: SignedCookieKeyPairId, SignedCookiePolicy, SignedCookieSignature
 
 
+        指定したプロジェクトのタスク集計をすべて取得します。 
 
         Args:
             project_id (str):  プロジェクトID (required)
@@ -517,12 +531,13 @@ def get_worktime_statistics_v2(
     def get_account_v2(
         self, account_id: str, query_params: Optional[Dict[str, Any]] = None, **kwargs
     ) -> Tuple[Any, requests.Response]:
-        """個人情報取得
+        """ユーザーアカウント情報取得
 
 
         authorizations: SignedCookieKeyPairId, SignedCookiePolicy, SignedCookieSignature
 
 
+        指定したユーザーの組織のアカウント情報を取得します。  本 API は `cache` クエリパラメータが同じであれば結果がキャッシュされ、以降は高速にレスポンスが返ります。 
 
         Args:
             account_id (str):  アカウントID (required)
@@ -548,6 +563,7 @@ def get_user_cache_v2(self, account_id: str, **kwargs) -> Tuple[Any, requests.Re
         authorizations: SignedCookieKeyPairId, SignedCookiePolicy, SignedCookieSignature
 
 
+        ユーザー別の各リソースのキャッシュタイムスタンプを格納したキャッシュレコードを取得します。  これらタイムスタンプは、各リソースを取得する API の `cache` クエリパラメータに使用します。 
 
         Args:
             account_id (str):  アカウントID (required)
@@ -565,12 +581,13 @@ def get_user_cache_v2(self, account_id: str, **kwargs) -> Tuple[Any, requests.Re
     def get_user_organizations_v2(
         self, account_id: str, query_params: Optional[Dict[str, Any]] = None, **kwargs
     ) -> Tuple[Any, requests.Response]:
-        """個人の所属組織一括取得
+        """個人の所属組織検索
 
 
         authorizations: SignedCookieKeyPairId, SignedCookiePolicy, SignedCookieSignature
 
 
+        指定したユーザーが所属する組織を検索します。  本 API は `cache` クエリパラメータが同じであれば結果がキャッシュされ、以降は高速にレスポンスが返ります。 
 
         Args:
             account_id (str):  アカウントID (required)
@@ -598,6 +615,7 @@ def get_user_project_members_v2(
         authorizations: SignedCookieKeyPairId, SignedCookiePolicy, SignedCookieSignature
 
 
+        指定したユーザーが所属するプロジェクトメンバー情報をすべて取得します。  本 API は `cache` クエリパラメータが同じであれば結果がキャッシュされ、以降は高速にレスポンスが返ります。 
 
         Args:
             account_id (str):  アカウントID (required)
@@ -619,12 +637,13 @@ def get_user_project_members_v2(
     def get_user_projects_v2(
         self, account_id: str, query_params: Optional[Dict[str, Any]] = None, **kwargs
     ) -> Tuple[Any, requests.Response]:
-        """自分のプロジェクトメンバー情報一括取得
+        """自分のプロジェクトメンバー情報検索
 
 
         authorizations: SignedCookieKeyPairId, SignedCookiePolicy, SignedCookieSignature
 
 
+        指定したユーザーが所属するプロジェクトを検索します。  本 API は `cache` クエリパラメータが同じであれば結果がキャッシュされ、以降は高速にレスポンスが返ります。 
 
         Args:
             account_id (str):  アカウントID (required)

annofabapi/generated_api2.py

@@ -728,6 +728,8 @@ class AnnotationDataHoldingType(Enum):
     
 * updated_datetime: str
     アノテーション仕様の最終更新時刻 
+* option: AnnotationSpecsOption
+    
 * additionals: List[AdditionalDataDefinitionV2]
     
 * restrictions: List[AdditionalDataRestriction]
@@ -756,6 +758,26 @@ class AnnotationDataHoldingType(Enum):
 * comment: str
     
 
+"""
+
+AnnotationSpecsMovieOption = Dict[str, Any]
+"""
+
+
+Kyes of Dict
+
+* can_overwrap: bool
+    動画プロジェクトのアノテーションに重複配置を許すか否か。 
+
+"""
+
+AnnotationSpecsOption = Dict[str, Any]
+"""
+アノテーション仕様のオプション設定。  現時点では動画プロジェクトでのみ利用・指定可能。動画以外のプロジェクトでは値なし。  動画プロジェクトで値が未指定の場合、AnnotationSpecsOption内の値はすべてデフォルト値が指定されたものとして扱われる。 
+
+Kyes of Dict
+
+
 """
 
 AnnotationSpecsRequest = Dict[str, Any]
@@ -774,6 +796,8 @@ class AnnotationDataHoldingType(Enum):
     trueが指定された場合、各統計グラフにマーカーを自動追加します。 マーカーのタイトルには `comment` に指定された文字列が設定されます。 `comment` が指定されていなかった場合は \"アノテーション仕様の変更\" という文字列が設定されます。 
 * last_updated_datetime: str
     新規作成時は未指定、更新時は必須（更新前の日時） 
+* option: AnnotationSpecsOption
+    
 * additionals: List[AdditionalDataDefinitionV2]
     
 * restrictions: List[AdditionalDataRestriction]
@@ -799,6 +823,8 @@ class AnnotationDataHoldingType(Enum):
     trueが指定された場合、各統計グラフにマーカーを自動追加します。 マーカーのタイトルには `comment` に指定された文字列が設定されます。 `comment` が指定されていなかった場合は \"アノテーション仕様の変更\" という文字列が設定されます。 
 * last_updated_datetime: str
     新規作成時は未指定、更新時は必須（更新前の日時） 
+* option: AnnotationSpecsOption
+    
 
 """
 
@@ -824,6 +850,8 @@ class AnnotationDataHoldingType(Enum):
     
 * last_updated_datetime: str
     新規作成時は未指定、更新時は必須（更新前の日時） 
+* option: AnnotationSpecsOption
+    
 
 """
 
@@ -841,6 +869,8 @@ class AnnotationDataHoldingType(Enum):
     
 * updated_datetime: str
     アノテーション仕様の最終更新時刻 
+* option: AnnotationSpecsOption
+    
 
 """
 
@@ -864,6 +894,8 @@ class AnnotationDataHoldingType(Enum):
     
 * updated_datetime: str
     アノテーション仕様の最終更新時刻 
+* option: AnnotationSpecsOption
+    
 
 """
 
@@ -2126,7 +2158,7 @@ class JobStatus(Enum):
 
 class JobType(Enum):
     """
-    * `copy-project` - プロジェクトのコピー。[initiateProjectCopy](#operation/initiateProjectCopy) APIを実行したときに登録されるジョブ。 * `gen-inputs` - zipファイルから入力データの作成。[putInputData](#operation/putInputData) APIを実行して、zipファイルから入力データを作成したときに登録されるジョブ。 * `gen-tasks` - タスクの一括作成。[initiateTasksGeneration](#operation/initiateTasksGeneration) APIを実行したときに登録されるジョブ。 * `gen-annotation` - アノテーションZIPの更新。[postAnnotationArchiveUpdate](#operation/postAnnotationArchiveUpdate) APIを実行したときに登録されるジョブ。 * `gen-tasks-list` - タスク全件ファイルの更新。[postProjectTasksUpdate](#operation/postProjectTasksUpdate) APIを実行したときに登録されるジョブ。 * `gen-inputs-list` - 入力データ情報全件ファイルの更新。[postProjectInputsUpdate](#operation/postProjectInputsUpdate) APIを実行したときに登録されるジョブ。 * `delete-project` - プロジェクトの削除。[deleteProject](#operation/deleteProject) APIを実行したときに登録されるジョブ。 * `invoke-hook` - Webhookの起動。 * `move-project` - プロジェクトの組織移動。[putProject](#operation/putProject) API で組織を変更したときに登録されるジョブ。 
+    * `copy-project` - プロジェクトのコピー。[initiateProjectCopy](#operation/initiateProjectCopy) APIを実行したときに登録されるジョブ。 * `gen-inputs` - zipファイルから入力データの作成。[putInputData](#operation/putInputData) APIを実行して、zipファイルから入力データを作成したときに登録されるジョブ。 * `gen-tasks` - タスクの一括作成。[initiateTasksGeneration](#operation/initiateTasksGeneration) APIを実行したときに登録されるジョブ。 * `gen-annotation` - アノテーションZIPの更新。[postAnnotationArchiveUpdate](#operation/postAnnotationArchiveUpdate) APIを実行したときに登録されるジョブ。 * `gen-tasks-list` - タスク全件ファイルの更新。[postProjectTasksUpdate](#operation/postProjectTasksUpdate) APIを実行したときに登録されるジョブ。 * `gen-inputs-list` - 入力データ情報全件ファイルの更新。[postProjectInputsUpdate](#operation/postProjectInputsUpdate) APIを実行したときに登録されるジョブ。 * `delete-project` - プロジェクトの削除。[deleteProject](#operation/deleteProject) APIを実行したときに登録されるジョブ。 * `invoke-hook` - Webhookの起動。 * `move-project` - プロジェクトの組織移動。[putProject](#operation/putProject) API で組織を変更したときに登録されるジョブ。  ## ジョブの同時実行制限  AnnoFab上に登録されているデータの整合性を保つため、プロジェクト内で特定のジョブが実行中の間は他のジョブが実行できないよう制限をかけています。  ジョブの同時実行可否はジョブの種別によって異なります。  ### copy-project 次のジョブが実行されている場合、このジョブを実行することはできません。  * `gen-inputs` * `gen-tasks` * `delete-project` * `move-project`  ### gen-inputs 次のジョブが実行されている場合、このジョブを実行することはできません。  * `copy-project` * `gen-inputs` * `gen-tasks` * `gen-inputs-list` * `delete-project` * `move-project`  ### gen-tasks 次のジョブが実行されている場合、このジョブを実行することはできません。  * `copy-project` * `gen-inputs` * `gen-tasks` * `gen-annotation` * `gen-tasks-list` * `delete-project` * `move-project`  ### gen-annotation 次のジョブが実行されている場合、このジョブを実行することはできません。  * `gen-tasks` * `gen-annotation` * `delete-project` * `move-project`  ### gen-tasks-list 次のジョブが実行されている場合、このジョブを実行することはできません。  * `gen-tasks` * `gen-tasks-list` * `delete-project` * `move-project`  ### gen-inputs-list 次のジョブが実行されている場合、このジョブを実行することはできません。  * `gen-inputs` * `gen-inputs-list` * `delete-project` * `move-project`  ### delete-project 他のジョブが実行されていない場合**のみ**実行できます。  ### invoke-hook 次のジョブが実行されている場合、このジョブを実行することはできません。  * `delete-project` * `move-project`  ### move-project 他のジョブが実行されていない場合**のみ**実行できます。 
     """
 
     COPY_PROJECT = "copy-project"