Annofab v0.155.0対応 (#506)

* swagger

* webapiの追加

* comment dataclassを追加

* download_project_task_history_events_url関数の警告を無視する

* commentのテストコードを追加

* dataclassの警告表示

* Inspection dataclassのテストコードを削除

* instructionも不要にする

* ジョブ関係のテストコードを修正

* テストコードの移植

* テストコードんの修正

* poetry update

* dataclass関係のテストコードの削除

* version up

Author: yuji38kwmt

annofabapi/__version__.py

@@ -1 +1 @@
-__version__ = "0.62.1"
+__version__ = "0.63.0"

annofabapi/dataclass/comment.py

@@ -0,0 +1,69 @@
+# flake8: noqa: W291
+# pylint: disable=too-many-lines,trailing-whitespace
+
+"""
+annofabapiのmodelをDataClassで定義したクラス
+
+Note:
+    このファイルはopenapi-generatorで自動生成される。詳細は generate/README.mdを参照.
+    oneOf, allOfなどは正しく表現できない可能性がある。
+"""
+
+import warnings  # pylint: disable=unused-import
+from dataclasses import dataclass
+from typing import Any, Dict, List, NewType, Optional, Tuple, Union  # pylint: disable=unused-import
+
+from dataclasses_json import DataClassJsonMixin
+
+from annofabapi.models import CommentType, TaskPhase
+
+CommentNode = Dict[str, Any]
+
+
+@dataclass
+class Comment(DataClassJsonMixin):
+    """
+    コメント
+    """
+
+    project_id: str
+    """プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
+
+    task_id: str
+    """タスクID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
+
+    input_data_id: str
+    """入力データID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
+
+    comment_id: str
+    """コメントのID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
+
+    phase: TaskPhase
+    """"""
+
+    phase_stage: int
+    """コメントを作成したときのフェーズのステージ。"""
+
+    account_id: str
+    """アカウントID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
+
+    comment_type: CommentType
+    """"""
+
+    phrases: Optional[List[str]]
+    """`comment_type` の値によって扱いが異なります。  * `onhold` の場合   * 使用しません（空配列） * `inspection` の場合   * 参照している定型指摘のIDリスト """
+
+    comment: str
+    """コメント本文。 """
+
+    comment_node: CommentNode
+    """"""
+
+    datetime_for_sorting: str
+    """コメントのソート順を決める日時。  Annofab標準エディタでは、コメントはここで指定した日時にしたがってスレッドごとに昇順で表示されます。 """
+
+    created_datetime: str
+    """コメントの作成日時。"""
+
+    updated_datetime: str
+    """コメントの更新日時。"""

annofabapi/dataclass/instruction.py

@@ -15,6 +15,8 @@
 
 from dataclasses_json import DataClassJsonMixin
 
+warnings.warn("'annofabapi.dataclass.instruction'モジュールは2022-12-01以降に廃止する予定です。", FutureWarning, stacklevel=2)
+
 
 @dataclass
 class Instruction(DataClassJsonMixin):

annofabapi/dataclass/my.py

@@ -17,6 +17,8 @@
 
 from annofabapi.models import KeyLayout, Lang, OrganizationMemberRole, OrganizationMemberStatus, PricePlan
 
+warnings.warn("'annofabapi.dataclass.my'モジュールは2022-12-01以降に廃止する予定です。", FutureWarning, stacklevel=2)
+
 
 @dataclass
 class MyOrganization(DataClassJsonMixin):
@@ -78,8 +80,8 @@ class MyAccount(DataClassJsonMixin):
     authority: str
     """システム内部用のプロパティ"""
 
-    is_external_account: bool
-    """[外部アカウントだけで作成したアカウント](/docs/faq/#v1u344)の場合はtrue。  外部アカウント連携していないAnnofabアカウントや、後から[外部アカウントとの紐付け](/docs/faq/#yyyub0)をしたAnnofabアカウントの場合はfalse。 """
+    account_type: str
+    """アカウントの種別 * `annofab` - 通常の手順で登録されたアカウント。後から[外部アカウントとの紐付け](/docs/faq/#yyyub0)をしたアカウントの場合もこちらになります。 * `external` - [外部アカウントだけで作成したアカウント](/docs/faq/#v1u344) * `project_guest` - [issueProjectGuestUserToken](#operation/issueProjectGuestUserToken)によって作成されたされたアカウント """
 
     updated_datetime: str
     """更新日時"""

annofabapi/dataclass/organization.py

@@ -15,9 +15,11 @@
 
 from dataclasses_json import DataClassJsonMixin
 
+from annofabapi._utils import deprecated_class
 from annofabapi.models import PricePlan
 
 
+@deprecated_class(deprecated_date="2022-12-01")
 @dataclass
 class OrganizationActivity(DataClassJsonMixin):
     """ """

annofabapi/dataclass/statistics.py

@@ -17,6 +17,8 @@
 
 from annofabapi.models import GraphType, TaskPhase, TaskStatus
 
+warnings.warn("'annofabapi.dataclass.statistics'モジュールは2022-12-01以降に廃止する予定です。", FutureWarning, stacklevel=2)
+
 
 @dataclass
 class ProjectTaskStatistics(DataClassJsonMixin):

annofabapi/dataclass/webhook.py

@@ -17,6 +17,8 @@
 
 from annofabapi.models import WebhookEventType, WebhookHttpMethod, WebhookStatus
 
+warnings.warn("'annofabapi.dataclass.webhook'モジュールは2022-12-01以降に廃止する予定です。", FutureWarning, stacklevel=2)
+
 
 @dataclass
 class WebhookHeader(DataClassJsonMixin):