Annofab v0.142.0 (#445)

* update swagger

* add dataclass

* account系APIの削除

* update models

* updatet test api

annofabapi/dataclass/my.py

@@ -35,13 +35,13 @@ class MyOrganization(DataClassJsonMixin):
     """"""
 
     summary: Optional[Dict[str, Any]]
-    """"""
+    """廃止予定のプロパティです。常に中身は空です。 """
 
     created_datetime: Optional[str]
-    """"""
+    """作成日時"""
 
     updated_datetime: Optional[str]
-    """"""
+    """更新日時"""
 
     my_role: Optional[OrganizationMemberRole]
     """"""

annofabapi/dataclass/organization.py

@@ -26,10 +26,10 @@ class OrganizationActivity(DataClassJsonMixin):
     """組織ID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
 
     created_datetime: str
-    """"""
+    """作成日時"""
 
-    storage_usage_bytes: float
-    """"""
+    storage_usage_bytes: int
+    """Annofabストレージの使用量[バイト]"""
 
 
 @dataclass
@@ -40,19 +40,19 @@ class Organization(DataClassJsonMixin):
     """組織ID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
 
     organization_name: str
-    """"""
+    """組織名。[値の制約についてはこちら。](#section/API-Convention/APIID) """
 
     email: str
-    """"""
+    """メールアドレス"""
 
     price_plan: PricePlan
     """"""
 
     summary: Dict[str, Any]
-    """"""
+    """廃止予定のプロパティです。常に中身は空です。 """
 
     created_datetime: str
-    """"""
+    """作成日時"""
 
     updated_datetime: str
-    """"""
+    """更新日時"""

annofabapi/dataclass/project.py

@@ -26,15 +26,19 @@
 
 @dataclass
 class ProjectSummary(DataClassJsonMixin):
-    """ """
+    """
+    プロジェクトのサマリー情報
+    """
 
     last_tasks_updated_datetime: Optional[str]
     """タスクの最終更新日時"""
 
 
 @dataclass
 class ProjectConfiguration(DataClassJsonMixin):
-    """ """
+    """
+    プロジェクトの設定情報
+    """
 
     number_of_inspections: Optional[int]
     """検査回数。 * 0回：教師付け -> 受入 * 1回：教師付け -> 検査 -> 受入 * n回(n >= 2)：教師付け -> 検査1 -> ... -> 検査n -> 受入 """
@@ -52,7 +56,7 @@ class ProjectConfiguration(DataClassJsonMixin):
     """保留中のタスクを除き、1人（オーナー以外）に割り当てられるタスク数の上限。 """
 
     max_tasks_per_member_including_hold: Optional[int]
-    """保留中のタスクを含めて、1人（オーナー以外）に割り当てられるタスク数上限の保留分。 割り当て時の上限チェックは、max_tasks_per_memberとこの数字の合計で行われます。  例えばmax_tasks_per_memberが10,max_tasks_per_member_including_holdが20の場合、保留中を含むタスク数の割り当て上限は30になります。 """
+    """保留中のタスクを含めて、1人（オーナー以外）に割り当てられるタスク数上限の保留分。 割り当て時の上限チェックは、max_tasks_per_memberとこの数字の合計で行われます。  例えばmax_tasks_per_memberが10、max_tasks_per_member_including_holdが20の場合、保留中を含むタスク数の割り当て上限は30になります。 """
 
     input_data_set_id_list: Optional[List[str]]
     """このフィールドは内部用でまだ何も意味を成しません。今は空配列を指定してください。"""
@@ -61,10 +65,10 @@ class ProjectConfiguration(DataClassJsonMixin):
     """入力データ画像の長辺の最大値（未指定時は4096px）。  画像をアップロードすると、長辺がこの値になるように画像が自動で圧縮されます。 アノテーションの座標は、もとの解像度の画像でつけたものに復元されます。  大きな数値を設定すると入力データ画像のサイズが大きくなり、生産性低下やブラウザで画像を表示できない懸念があります。注意して設定してください。 """
 
     sampling_inspection_rate: Optional[int]
-    """抜取検査率。0-100のパーセント値で指定し、未指定の場合は100%として扱う。"""
+    """抜取検査率[%]。未指定の場合は100%として扱う。"""
 
     sampling_acceptance_rate: Optional[int]
-    """抜取受入率。0-100のパーセント値で指定し、未指定の場合は100%として扱う。"""
+    """抜取受入率[%]。未指定の場合は100%として扱う。"""
 
     private_storage_aws_iam_role_arn: Optional[str]
     """AWS IAMロール。ビジネスプランでのS3プライベートストレージの認可で使います。 [S3プライベートストレージの認可の設定についてはこちら](/docs/faq/#m0b240)をご覧ください。 """
@@ -82,7 +86,7 @@ class ProjectConfiguration(DataClassJsonMixin):
     """標準アノテーションエディタのバージョン。  * `stable`     * 安定版。通常はこちらを利用してください。 * `preview`     * 最新版。新機能やUI変更の先行リリース版。  プロジェクト更新時に未指定の場合は `stable` が指定されたものとみなします。 """
 
     use_beginner_navigation: Optional[bool]
-    """true の場合、プロジェクトの画面でナビゲーションUIを表示します（ログインユーザーがプロジェクトオーナーの場合のみ）。  未指定の場合、 false が指定されたものとして扱います。 """
+    """true の場合、プロジェクトの画面でナビゲーションUIを表示します（ログインユーザーがプロジェクトオーナーの場合のみ）。 """
 
 
 @dataclass
@@ -111,10 +115,10 @@ class Project(DataClassJsonMixin):
     """"""
 
     created_datetime: str
-    """"""
+    """作成日時"""
 
     updated_datetime: str
-    """"""
+    """更新日時"""
 
     summary: ProjectSummary
     """"""

annofabapi/dataclass/task.py

@@ -31,13 +31,13 @@ class TaskHistory(DataClassJsonMixin):
     """タスクID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
 
     task_history_id: str
-    """"""
+    """タスク履歴ID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
 
     started_datetime: Optional[str]
-    """"""
+    """開始日時"""
 
     ended_datetime: Optional[str]
-    """"""
+    """終了日時"""
 
     accumulated_labor_time_milliseconds: str
     """累計実作業時間（ISO 8601 duration）"""
@@ -46,7 +46,7 @@ class TaskHistory(DataClassJsonMixin):
     """"""
 
     phase_stage: int
-    """"""
+    """タスクのフェーズのステージ番号"""
 
     account_id: Optional[str]
     """アカウントID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
@@ -85,7 +85,7 @@ class Task(DataClassJsonMixin):
     """"""
 
     phase_stage: int
-    """"""
+    """タスクのフェーズのステージ番号"""
 
     status: TaskStatus
     """"""
@@ -106,13 +106,13 @@ class Task(DataClassJsonMixin):
     """このタスクが差戻しされた回数（すべてのフェーズでの差戻し回数の合計  このフィールドは、どのフェーズで何回差戻されたかを区別できないため、廃止予定です。 `histories_by_phase` で各フェーズの回数を計算することで、差戻し回数が分かります。  例）`acceptance`フェーズが3回ある場合、`acceptance`フェーズで2回差し戻しされたことになります。 """
 
     started_datetime: Optional[str]
-    """"""
+    """現在のフェーズが開始された日時"""
 
     updated_datetime: str
-    """"""
+    """更新日時"""
 
     sampling: Optional[str]
-    """* `inspection_skipped` - このタスクが抜取検査の対象外となり、検査フェーズをスキップしたことを表す。 * `inspection_stages_skipped` - このタスクが抜取検査の対象外となり、検査フェーズのステージを一部スキップしたことを表す。 * `acceptance_skipped` - このタスクが抜取検査の対象外となり、受入フェーズをスキップしたことを表す。 * `inspection_and_acceptance_skipped` - このタスクが抜取検査の対象外となり、検査・受入フェーズをスキップしたことを表す  未指定時はこのタスクが抜取検査の対象となったことを表す。(通常のワークフローを通過する) """
+    """検査抜取検査/抜取受入によって、どのフェーズがスキップされたか  * `inspection_skipped` - 抜取検査の対象外となり、検査フェーズがスキップされた * `inspection_stages_skipped` - 抜取検査の対象外となり、検査フェーズのステージの一部がスキップされた * `acceptance_skipped` - 抜取受入の対象外となり、受入フェーズがスキップされた * `inspection_and_acceptance_skipped` - 抜取検査・抜取受入の対象外となり、検査・受入フェーズがスキップされた  未指定ならば、どのフェーズもスキップされていません。 """
 
     metadata: Optional[Dict[str, Any]]
     """ユーザーが自由に登録できるkey-value型のメタデータです。 keyにはメタデータ名、valueには値を指定してください。  keyに指定できる文字種は次の通りです。  * 半角英数字 * `_` (アンダースコア) * `-` (ハイフン)  valueに指定できる値は次の通りです。  * 文字列 * 数値 * 真偽値 """