Merge pull request #106 from kurusugawa-computer/support-annofab-v0.69.2

Annofab v0.69.2に対応

Author: yuji38kwmt

annofabapi/__version__.py

@@ -1 +1 @@
-__version__ = '0.24.1'
+__version__ = '0.24.2'

annofabapi/dataclass/inspection.py

@@ -47,7 +47,7 @@ class Inspection:
     """"""
 
     annotation_id: Optional[str]
-    """"""
+    """特定のアノテーションに対するコメントの場合はそのアノテーションのID、座標に対する場合は値なし。 [詳細はこちら](#section/AnnotationId)。 """
 
     data: OneOfInspectionDataPointInspectionDataPolylineInspectionDataTime
     """"""

annofabapi/generated_api.py

@@ -265,7 +265,7 @@ def batch_update_annotations(self, project_id: str, request_body: Optional[Any]
         authorizations: ProjectAccepter
 
 
-        複数のアノテーションを一括更新します。  リクエストボディは、1個以上の「操作」オブジェクトを含むJSON配列になります。 操作オブジェクトには、「更新」と「削除」の2通りがあり、それぞれJSONオブジェクト構造が異なります。 これら操作オブジェクトを複数含めることで、1リクエストで複数の更新や削除ができます。  **現時点で、このAPIは複数のアノテーションを修正するためのもので、新しいアノテーションを作成することはできません**。 新しいアノテーションを更新や削除の対象に指定した場合、無視されます。  既に作成済みのアノテーションのうち、リクエストボディの配列に含まれないアノテーションは更新されません。  更新対象のアノテーションのうち、属性配列に含まれない属性は更新されません。  更新対象のアノテーションのラベルを変更する場合、変更後のラベルに含まれない属性は削除されます。  また、画像全体アノテーションのラベルは変更することができません。  複数の操作のうち、1つでも失敗するとAPIのレスポンス全体としては失敗になります。 成功した部分までは反映されます。  受入が完了しているタスクのアノテーション更新を含む場合、オーナー以上の権限が必要になります。 
+        複数のアノテーションを一括更新します。  リクエストボディは、1個以上の「操作」オブジェクトを含むJSON配列になります。 操作オブジェクトには、「更新」と「削除」の2通りがあり、それぞれJSONオブジェクト構造が異なります。 これら操作オブジェクトを複数含めることで、1リクエストで複数の更新や削除ができます。  **現時点で、このAPIは複数のアノテーションを修正するためのもので、新しいアノテーションを作成することはできません**。 新しいアノテーションを更新や削除の対象に指定した場合、無視されます。  既に作成済みのアノテーションのうち、リクエストボディの配列に含まれないアノテーションは更新されません。  更新対象のアノテーションのうち、属性配列に含まれない属性は更新されません。  更新対象のアノテーションのラベルを変更する場合、異なるアノテーション種別のラベルに変更することはできません。 また、変更後のラベルに含まれない属性は削除されます。  画像全体のアノテーションは、他のラベルに変更することはできません。  塗りつぶしv2アノテーションは、1ラベル1アノテーションの制約のため、他の塗りつぶしv2ラベルに変更することはできません。  複数の操作のうち、1つでも失敗するとAPIのレスポンス全体としては失敗になります。 成功した部分までは反映されます。  受入が完了しているタスクのアノテーション更新を含む場合、オーナー以上の権限が必要になります。 
 
         Args:
             project_id (str):  プロジェクトID (required)

annofabapi/models.py

@@ -1940,7 +1940,7 @@ class InputDataType(Enum):
 * commenter_account_id: str
     
 * annotation_id: str
-    
+    特定のアノテーションに対するコメントの場合はそのアノテーションのID、座標に対する場合は値なし。 [詳細はこちら](#section/AnnotationId)。 
 * data: OneOfInspectionDataPointInspectionDataPolylineInspectionDataTime
     
 * parent_inspection_id: str
@@ -2822,8 +2822,6 @@ class PricePlan(Enum):
     「アノテーション」をコピーするかどうかを指定します。  この属性の値を true とする場合、他の属性の値を必ず次のように指定してください。  * copy_inputs の値を true とする * copy_tasks の値を true とする 
 * copy_webhooks: bool
     「Webhook」をコピーするかどうかを指定します。 
-* copy_tasks_with_annotations: bool
-    「タスク」および「アノテーション」をコピーするかどうかを指定します。  廃止予定の属性のためこの属性は使用せず、「タスク」および「アノテーション」をコピーする場合には他の属性の値を必ず次のように指定してください。  * copy_tasks の値を true とする * copy_inputs の値を true とする * copy_annotations の値を true とする  やむを得ない理由でこの属性の値を true とする場合、他の属性の値を必ず次のように指定してください。  * copy_tasks の値を false とする * copy_inputs の値を true とする * copy_annotations の値を false とする 
 * copy_supplementaly_data: bool
     「補助情報」をコピーするかどうかを指定します。  この属性の値を true とする場合、他の属性の値を必ず次のように指定してください。  * copy_inputs の値を true とする 
 * copy_instructions: bool
@@ -3297,17 +3295,6 @@ class SupplementaryDataType(Enum):
 
 """
 
-
-class TaskAssginmentType(Enum):
-    """
-    * `random` -  タスクフェーズのみを指定してランダムにタスクを自身に割当する方式です。 * `selection` - 担当者とタスクを明示的に指定してタスクを割当する方式です。プロジェクトオーナーもしくはチェッカーのみ、自身以外のプロジェクトメンバーを担当者に指定できます。 * `random_and_selection` - ランダム割当と選択割当の両機能を使用する方式です。 
-    """
-
-    RANDOM = "random"
-    SELECTION = "selection"
-    RANDOM_AND_SELECTION = "random_and_selection"
-
-
 TaskAssignRequest = Dict[str, Any]
 """
 
@@ -3326,7 +3313,7 @@ class TaskAssginmentType(Enum):
 Kyes of Dict
 
 * phase: TaskPhase
-    割当するタスクフェーズ
+    割当するタスクフェーズ。[詳細はこちら](#section/TaskPhase)
 * type: str
     Random
 
@@ -3350,6 +3337,7 @@ class TaskAssginmentType(Enum):
 
 class TaskAssignmentType(Enum):
     """
+    プロジェクトで使用するタスクの割当方式。  * `random` -  タスクフェーズのみを指定してランダムにタスクを自身に割当する方式です。 * `selection` - 担当者とタスクを明示的に指定してタスクを割当する方式です。プロジェクトオーナーもしくはチェッカーのみ、自身以外のプロジェクトメンバーを担当者に指定できます。 * `random_and_selection` - ランダム割当と選択割当の両機能を使用する方式です。 
     """
 
     RANDOM = "random"
@@ -3491,7 +3479,7 @@ class TaskAssignmentType(Enum):
 Kyes of Dict
 
 * status: TaskStatus
-    
+    次に遷移させるタスクの状態。[詳細はこちら](#section/TaskStatus)。 
 * last_updated_datetime: str
     新規作成時は未指定、更新時は必須（更新前の日時） 
 * account_id: str

generate/swagger/swagger-api-components.yaml

@@ -908,12 +908,6 @@
     TaskHistoryId:
       type: string
       example: "12345678-abcd-1234-abcd-1234abcd5678"
-    TaskAssignmentType:
-      type: string
-      enum:
-        - random
-        - selection
-        - random_and_selection
     AnnotationId:
       type: string
       example: "12345678-abcd-1234-abcd-1234abcd5678"
@@ -1034,9 +1028,7 @@
           $ref: "#/components/schemas/AssigneeRuleOfResubmittedTask"
           default: no_assignee
         task_assignment_type:
-          description: タスクの割当方式。
           $ref: "#/components/schemas/TaskAssignmentType"
-          default: random
         max_tasks_per_member:
           description: 保留中のタスクを除き、1人（オーナー以外）に割り当てられるタスク数上限。未指定の場合は10件として扱う。
           type: integer
@@ -1084,13 +1076,16 @@
         last_tasks_updated_datetime:
           type: string
           format: date-time
-    TaskAssginmentType:
+    TaskAssignmentType:
       type: string
+      default: random
       enum:
         - random
         - selection
         - random_and_selection
       description: |
+        プロジェクトで使用するタスクの割当方式。
+  
         * `random` -  タスクフェーズのみを指定してランダムにタスクを自身に割当する方式です。
         * `selection` - 担当者とタスクを明示的に指定してタスクを割当する方式です。プロジェクトオーナーもしくはチェッカーのみ、自身以外のプロジェクトメンバーを担当者に指定できます。
         * `random_and_selection` - ランダム割当と選択割当の両機能を使用する方式です。
@@ -1274,24 +1269,6 @@
           description: |
             「Webhook」をコピーするかどうかを指定します。
           default: false
-        copy_tasks_with_annotations:
-          deprecated: true
-          type: boolean
-          description: |
-            「タスク」および「アノテーション」をコピーするかどうかを指定します。
-  
-            廃止予定の属性のためこの属性は使用せず、「タスク」および「アノテーション」をコピーする場合には他の属性の値を必ず次のように指定してください。
-  
-            * copy_tasks の値を true とする
-            * copy_inputs の値を true とする
-            * copy_annotations の値を true とする
-  
-            やむを得ない理由でこの属性の値を true とする場合、他の属性の値を必ず次のように指定してください。
-  
-            * copy_tasks の値を false とする
-            * copy_inputs の値を true とする
-            * copy_annotations の値を false とする
-          default: false
         copy_supplementaly_data:
           type: boolean
           description: |
@@ -2360,9 +2337,10 @@
       type: object
       properties:
         status:
+          description: |
+            次に遷移させるタスクの状態。[詳細はこちら](#section/TaskStatus)。
           allOf:
             - $ref: "#/components/schemas/TaskStatus"
-            - description: 次に遷移させるタスクの状態
         last_updated_datetime:
           $ref: "#/components/schemas/LastUpdatedDatetime"
         account_id:
@@ -2394,7 +2372,7 @@
         - phase
       properties:
         phase:
-          description: 割当するタスクフェーズ
+          description: 割当するタスクフェーズ。[詳細はこちら](#section/TaskPhase)
           allOf:
             - $ref: "#/components/schemas/TaskPhase"
         _type:
@@ -3533,10 +3511,11 @@
         commenter_account_id:
           $ref: "#/components/schemas/AccountId"
         annotation_id:
+          description: |
+            特定のアノテーションに対するコメントの場合はそのアノテーションのID、座標に対する場合は値なし。
+            [詳細はこちら](#section/AnnotationId)。
           allOf:
             - $ref: "#/components/schemas/AnnotationId"
-            - description: |
-                特定のアノテーションに対するコメントの場合はそのアノテーションのID、座標に対する場合は値なし
         data:
           oneOf:
             - $ref: "#/components/schemas/InspectionDataPoint"

generate/swagger/swagger.v2.yaml

@@ -76,7 +76,7 @@ info:
     WebhookID | プロジェクト内で一意
     入力データセットID | 組織内で一意
 
-  version: 0.69.1
+  version: 0.69.2
   title: AnnoFab Web API
   x-logo:
     url: "https://annofab.com/images/logo_landscape.png"
@@ -1542,12 +1542,6 @@ components:
     TaskHistoryId:
       type: string
       example: "12345678-abcd-1234-abcd-1234abcd5678"
-    TaskAssignmentType:
-      type: string
-      enum:
-        - random
-        - selection
-        - random_and_selection
     AnnotationId:
       type: string
       example: "12345678-abcd-1234-abcd-1234abcd5678"
@@ -1668,9 +1662,7 @@ components:
           $ref: "#/components/schemas/AssigneeRuleOfResubmittedTask"
           default: no_assignee
         task_assignment_type:
-          description: タスクの割当方式。
           $ref: "#/components/schemas/TaskAssignmentType"
-          default: random
         max_tasks_per_member:
           description: 保留中のタスクを除き、1人（オーナー以外）に割り当てられるタスク数上限。未指定の場合は10件として扱う。
           type: integer
@@ -1718,13 +1710,16 @@ components:
         last_tasks_updated_datetime:
           type: string
           format: date-time
-    TaskAssginmentType:
+    TaskAssignmentType:
       type: string
+      default: random
       enum:
         - random
         - selection
         - random_and_selection
       description: |
+        プロジェクトで使用するタスクの割当方式。
+  
         * `random` -  タスクフェーズのみを指定してランダムにタスクを自身に割当する方式です。
         * `selection` - 担当者とタスクを明示的に指定してタスクを割当する方式です。プロジェクトオーナーもしくはチェッカーのみ、自身以外のプロジェクトメンバーを担当者に指定できます。
         * `random_and_selection` - ランダム割当と選択割当の両機能を使用する方式です。
@@ -1908,24 +1903,6 @@ components:
           description: |
             「Webhook」をコピーするかどうかを指定します。
           default: false
-        copy_tasks_with_annotations:
-          deprecated: true
-          type: boolean
-          description: |
-            「タスク」および「アノテーション」をコピーするかどうかを指定します。
-  
-            廃止予定の属性のためこの属性は使用せず、「タスク」および「アノテーション」をコピーする場合には他の属性の値を必ず次のように指定してください。
-  
-            * copy_tasks の値を true とする
-            * copy_inputs の値を true とする
-            * copy_annotations の値を true とする
-  
-            やむを得ない理由でこの属性の値を true とする場合、他の属性の値を必ず次のように指定してください。
-  
-            * copy_tasks の値を false とする
-            * copy_inputs の値を true とする
-            * copy_annotations の値を false とする
-          default: false
         copy_supplementaly_data:
           type: boolean
           description: |
@@ -2994,9 +2971,10 @@ components:
       type: object
       properties:
         status:
+          description: |
+            次に遷移させるタスクの状態。[詳細はこちら](#section/TaskStatus)。
           allOf:
             - $ref: "#/components/schemas/TaskStatus"
-            - description: 次に遷移させるタスクの状態
         last_updated_datetime:
           $ref: "#/components/schemas/LastUpdatedDatetime"
         account_id:
@@ -3028,7 +3006,7 @@ components:
         - phase
       properties:
         phase:
-          description: 割当するタスクフェーズ
+          description: 割当するタスクフェーズ。[詳細はこちら](#section/TaskPhase)
           allOf:
             - $ref: "#/components/schemas/TaskPhase"
         _type:
@@ -4167,10 +4145,11 @@ components:
         commenter_account_id:
           $ref: "#/components/schemas/AccountId"
         annotation_id:
+          description: |
+            特定のアノテーションに対するコメントの場合はそのアノテーションのID、座標に対する場合は値なし。
+            [詳細はこちら](#section/AnnotationId)。
           allOf:
             - $ref: "#/components/schemas/AnnotationId"
-            - description: |
-                特定のアノテーションに対するコメントの場合はそのアノテーションのID、座標に対する場合は値なし
         data:
           oneOf:
             - $ref: "#/components/schemas/InspectionDataPoint"