Skip to content

Feature/v0.15.0 #52

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 3, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion annofabapi/__version__.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = '0.14.1'
__version__ = '0.15.0'
22 changes: 11 additions & 11 deletions annofabapi/dataclass/annotation.py
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ class FullAnnotationDetail:

"""
annotation_id: Optional[str]
"""annotation_type が classification の場合は label_id と同じ値が格納されます。 """
"""アノテーションID。[値の制約についてはこちら。](#section/API-Convention/APIID)<br> annotation_type が classification の場合は label_id と同じ値が格納されます。 """

user_id: Optional[str]
""""""
Expand Down Expand Up @@ -117,10 +117,10 @@ class FullAnnotation:

"""
project_id: Optional[str]
""""""
"""プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) """

task_id: Optional[str]
""""""
"""タスクID。[値の制約についてはこちら。](#section/API-Convention/APIID) """

task_phase: Optional[TaskPhase]
""""""
Expand All @@ -132,7 +132,7 @@ class FullAnnotation:
""""""

input_data_id: Optional[str]
""""""
"""入力データID。[値の制約についてはこちら。](#section/API-Convention/APIID) """

input_data_name: Optional[str]
""""""
Expand Down Expand Up @@ -169,10 +169,10 @@ class SimpleAnnotation:
"""アノテーションフォーマットのバージョンです。 アノテーションフォーマットとは、プロジェクト個別のアノテーション仕様ではなく、AnnoFabのアノテーション構造のことです。 したがって、アノテーション仕様を更新しても、このバージョンは変化しません。 バージョンの読み方と更新ルールは、業界慣習の[Semantic Versioning](https://semver.org/)にもとづきます。 JSONに出力されるアノテーションフォーマットのバージョンは、アノテーションZIPが作成される時点のものが使われます。 すなわち、`1.0.0`の時点のタスクで作成したアノテーションであっても、フォーマットが `1.0.1` に上がった次のZIP作成時では `1.0.1` となります。 バージョンを固定してZIPを残しておきたい場合は、プロジェクトが完了した時点でZIPをダウンロードして保管しておくか、またはプロジェクトを「停止中」にします。 """

project_id: Optional[str]
""""""
"""プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) """

task_id: Optional[str]
""""""
"""タスクID。[値の制約についてはこちら。](#section/API-Convention/APIID) """

task_phase: Optional[TaskPhase]
""""""
Expand All @@ -184,7 +184,7 @@ class SimpleAnnotation:
""""""

input_data_id: Optional[str]
""""""
"""入力データID。[値の制約についてはこちら。](#section/API-Convention/APIID) """

input_data_name: Optional[str]
""""""
Expand All @@ -198,7 +198,7 @@ class SingleAnnotationDetail:

"""
annotation_id: Optional[str]
"""annotation_type が classification の場合は label_id と同じ値が格納されます。 """
"""アノテーションID。[値の制約についてはこちら。](#section/API-Convention/APIID)<br> annotation_type が classification の場合は label_id と同じ値が格納されます。 """

account_id: Optional[str]
""""""
Expand Down Expand Up @@ -233,13 +233,13 @@ class SingleAnnotation:

"""
project_id: Optional[str]
""""""
"""プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) """

task_id: Optional[str]
""""""
"""タスクID。[値の制約についてはこちら。](#section/API-Convention/APIID) """

input_data_id: Optional[str]
""""""
"""入力データID。[値の制約についてはこちら。](#section/API-Convention/APIID) """

detail: Optional[SingleAnnotationDetail]
""""""
Expand Down
4 changes: 2 additions & 2 deletions annofabapi/dataclass/annotation_specs.py
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ class AnnotationSpecsHistory:

"""
project_id: Optional[str]
""""""
"""プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) """

updated_datetime: Optional[str]
""""""
Expand Down Expand Up @@ -255,7 +255,7 @@ class AnnotationSpecs:

"""
project_id: Optional[str]
""""""
"""プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) """

labels: Optional[List[Label]]
""""""
Expand Down
4 changes: 2 additions & 2 deletions annofabapi/dataclass/input.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,10 @@ class InputData:

"""
input_data_id: str
""""""
"""入力データID。[値の制約についてはこちら。](#section/API-Convention/APIID) """

project_id: str
""""""
"""プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) """

input_data_name: str
"""表示用の名前です。"""
Expand Down
10 changes: 5 additions & 5 deletions annofabapi/dataclass/inspection.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,16 +26,16 @@ class Inspection:
検査コメント
"""
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) """

inspection_id: str
""""""
"""検査ID。[値の制約についてはこちら。](#section/API-Convention/APIID) """

phase: TaskPhase
""""""
Expand All @@ -53,7 +53,7 @@ class Inspection:
""""""

parent_inspection_id: Optional[str]
""""""
"""検査ID。[値の制約についてはこちら。](#section/API-Convention/APIID) """

phrases: Optional[List[str]]
"""選択された定型指摘ID. 未選択時は空"""
Expand Down
2 changes: 1 addition & 1 deletion annofabapi/dataclass/job.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ class JobInfo:

"""
project_id: Optional[str]
""""""
"""プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) """

job_type: Optional[str]
""""""
Expand Down
2 changes: 1 addition & 1 deletion annofabapi/dataclass/project.py
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ class Project:

"""
project_id: str
""""""
"""プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) """

organization_id: str
""""""
Expand Down
2 changes: 1 addition & 1 deletion annofabapi/dataclass/project_member.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ class ProjectMember:

"""
project_id: str
""""""
"""プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) """

account_id: str
""""""
Expand Down
6 changes: 3 additions & 3 deletions annofabapi/dataclass/statistics.py
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ class InspectionStatistics:

"""
project_id: Optional[str]
""""""
"""プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) """

date: Optional[str]
"""集計日"""
Expand All @@ -127,7 +127,7 @@ class TaskPhaseStatistics:

"""
project_id: Optional[str]
""""""
"""プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) """

date: Optional[str]
""""""
Expand Down Expand Up @@ -200,7 +200,7 @@ class WorktimeStatistics:

"""
project_id: Optional[str]
""""""
"""プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) """

date: Optional[str]
""""""
Expand Down
4 changes: 2 additions & 2 deletions annofabapi/dataclass/supplementary.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ class SupplementaryData:

"""
project_id: str
""""""
"""プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) """

input_data_id: str
""""""
"""入力データID。[値の制約についてはこちら。](#section/API-Convention/APIID) """

supplementary_data_id: str
""""""
Expand Down
8 changes: 4 additions & 4 deletions annofabapi/dataclass/task.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ class TaskHistory:
タスクのあるフェーズで、誰がいつどれくらいの作業時間を費やしたかを表すタスク履歴です。
"""
project_id: str
""""""
"""プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) """

task_id: str
""""""
"""タスクID。[値の制約についてはこちら。](#section/API-Convention/APIID) """

task_history_id: str
""""""
Expand Down Expand Up @@ -70,10 +70,10 @@ class Task:

"""
project_id: str
""""""
"""プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) """

task_id: str
""""""
"""タスクID。[値の制約についてはこちら。](#section/API-Convention/APIID) """

phase: TaskPhase
""""""
Expand Down
4 changes: 2 additions & 2 deletions annofabapi/dataclass/webhook.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,13 @@ class Webhook:

"""
project_id: Optional[str]
""""""
"""プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) """

event_type: Optional[str]
""""""

webhook_id: Optional[str]
""""""
"""WebhookID。[値の制約についてはこちら。](#section/API-Convention/APIID) """

webhook_status: Optional[str]
""""""
Expand Down
8 changes: 4 additions & 4 deletions annofabapi/generated_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -779,7 +779,7 @@ def put_input_data(self, project_id: str, input_data_id: str,

Args:
project_id (str): プロジェクトID (required)
input_data_id (str): 入力データID (required)
input_data_id (str): 入力データID。[値の制約についてはこちら。](#section/API-Convention/APIID) (required)
request_body (Any): Request Body
input_data_request (InputDataRequest): (required)

Expand Down Expand Up @@ -1815,7 +1815,7 @@ def put_project(self, project_id: str, request_body: Optional[Any] = None) -> Tu
プロジェクトを新規作成または更新します。 ### 新規作成する場合 ユーザーは、作成するプロジェクトをひもづける組織の [OrganizationAdministrator](#section/Authentication/OrganizationAdministrator) である必要があります。 ### 更新する場合 ユーザーは、更新するプロジェクトの [ProjectOwner](#section/Authentication/ProjectOwner) である必要があります。 また所属組織を変更する場合は、新しくひもづける組織の [OrganizationAdministrator](#section/Authentication/OrganizationAdministrator) である必要があります。 なお、プロジェクト状態を「停止中」にした場合、アノテーションZIPやタスク進捗状況などの集計情報は自動更新されなくなります。

Args:
project_id (str): プロジェクトID (required)
project_id (str): プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) (required)
request_body (Any): Request Body
put_project_request (PutProjectRequest): (required)

Expand Down Expand Up @@ -2490,7 +2490,7 @@ def put_task(self, project_id: str, task_id: str,

Args:
project_id (str): プロジェクトID (required)
task_id (str): タスクID (required)
task_id (str): タスクID。[値の制約についてはこちら。](#section/API-Convention/APIID) (required)
request_body (Any): Request Body
task_request (TaskRequest): (required)

Expand Down Expand Up @@ -2599,7 +2599,7 @@ def put_webhook(self, project_id: str, webhook_id: str,

Args:
project_id (str): プロジェクトID (required)
webhook_id (str): WebhookID (required)
webhook_id (str): WebhookID。[値の制約についてはこちら。](#section/API-Convention/APIID) (required)
request_body (Any): Request Body
webhook (Webhook): (required)

Expand Down
Loading