Skip to content

Commit e0620c1

Browse files
yuji38kwmtyuji38kwmt
authored
Merge pull request #52 from kurusugawa-computer/feature/v0.15.0
Feature/v0.15.0
2 parents 672774f + 9aadeaf commit e0620c1

18 files changed

+254
-149
lines changed

‎annofabapi/__version__.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
__version__ = '0.14.1'
1+
__version__ = '0.15.0'

‎annofabapi/dataclass/annotation.py

+11-11
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ class FullAnnotationDetail:
8888
8989
"""
9090
annotation_id: Optional[str]
91-
"""annotation_type が classification の場合は label_id と同じ値が格納されます。 """
91+
"""アノテーションID。[値の制約についてはこちら。](#section/API-Convention/APIID)<br> annotation_type が classification の場合は label_id と同じ値が格納されます。 """
9292

9393
user_id: Optional[str]
9494
""""""
@@ -117,10 +117,10 @@ class FullAnnotation:
117117
118118
"""
119119
project_id: Optional[str]
120-
""""""
120+
"""プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
121121

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

125125
task_phase: Optional[TaskPhase]
126126
""""""
@@ -132,7 +132,7 @@ class FullAnnotation:
132132
""""""
133133

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

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

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

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

177177
task_phase: Optional[TaskPhase]
178178
""""""
@@ -184,7 +184,7 @@ class SimpleAnnotation:
184184
""""""
185185

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

189189
input_data_name: Optional[str]
190190
""""""
@@ -198,7 +198,7 @@ class SingleAnnotationDetail:
198198
199199
"""
200200
annotation_id: Optional[str]
201-
"""annotation_type が classification の場合は label_id と同じ値が格納されます。 """
201+
"""アノテーションID。[値の制約についてはこちら。](#section/API-Convention/APIID)<br> annotation_type が classification の場合は label_id と同じ値が格納されます。 """
202202

203203
account_id: Optional[str]
204204
""""""
@@ -233,13 +233,13 @@ class SingleAnnotation:
233233
234234
"""
235235
project_id: Optional[str]
236-
""""""
236+
"""プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
237237

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

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

244244
detail: Optional[SingleAnnotationDetail]
245245
""""""

‎annofabapi/dataclass/annotation_specs.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ class AnnotationSpecsHistory:
117117
118118
"""
119119
project_id: Optional[str]
120-
""""""
120+
"""プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
121121

122122
updated_datetime: Optional[str]
123123
""""""
@@ -255,7 +255,7 @@ class AnnotationSpecs:
255255
256256
"""
257257
project_id: Optional[str]
258-
""""""
258+
"""プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
259259

260260
labels: Optional[List[Label]]
261261
""""""

‎annofabapi/dataclass/input.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,10 @@ class InputData:
3333
3434
"""
3535
input_data_id: str
36-
""""""
36+
"""入力データID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
3737

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

4141
input_data_name: str
4242
"""表示用の名前です。"""

‎annofabapi/dataclass/inspection.py

+5-5
Original file line numberDiff line numberDiff line change
@@ -26,16 +26,16 @@ class Inspection:
2626
検査コメント
2727
"""
2828
project_id: str
29-
""""""
29+
"""プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
3030

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

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

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

4040
phase: TaskPhase
4141
""""""
@@ -53,7 +53,7 @@ class Inspection:
5353
""""""
5454

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

5858
phrases: Optional[List[str]]
5959
"""選択された定型指摘ID. 未選択時は空"""

‎annofabapi/dataclass/job.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ class JobInfo:
2222
2323
"""
2424
project_id: Optional[str]
25-
""""""
25+
"""プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
2626

2727
job_type: Optional[str]
2828
""""""

‎annofabapi/dataclass/project.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ class Project:
6464
6565
"""
6666
project_id: str
67-
""""""
67+
"""プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
6868

6969
organization_id: str
7070
""""""

‎annofabapi/dataclass/project_member.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ class ProjectMember:
2424
2525
"""
2626
project_id: str
27-
""""""
27+
"""プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
2828

2929
account_id: str
3030
""""""

‎annofabapi/dataclass/statistics.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ class InspectionStatistics:
102102
103103
"""
104104
project_id: Optional[str]
105-
""""""
105+
"""プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
106106

107107
date: Optional[str]
108108
"""集計日"""
@@ -127,7 +127,7 @@ class TaskPhaseStatistics:
127127
128128
"""
129129
project_id: Optional[str]
130-
""""""
130+
"""プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
131131

132132
date: Optional[str]
133133
""""""
@@ -200,7 +200,7 @@ class WorktimeStatistics:
200200
201201
"""
202202
project_id: Optional[str]
203-
""""""
203+
"""プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
204204

205205
date: Optional[str]
206206
""""""

‎annofabapi/dataclass/supplementary.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@ class SupplementaryData:
2222
2323
"""
2424
project_id: str
25-
""""""
25+
"""プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
2626

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

3030
supplementary_data_id: str
3131
""""""

‎annofabapi/dataclass/task.py

+4-4
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,10 @@ class TaskHistory:
2424
タスクのあるフェーズで、誰がいつどれくらいの作業時間を費やしたかを表すタスク履歴です。
2525
"""
2626
project_id: str
27-
""""""
27+
"""プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
2828

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

3232
task_history_id: str
3333
""""""
@@ -70,10 +70,10 @@ class Task:
7070
7171
"""
7272
project_id: str
73-
""""""
73+
"""プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
7474

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

7878
phase: TaskPhase
7979
""""""

‎annofabapi/dataclass/webhook.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,13 @@ class Webhook:
3333
3434
"""
3535
project_id: Optional[str]
36-
""""""
36+
"""プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) """
3737

3838
event_type: Optional[str]
3939
""""""
4040

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

4444
webhook_status: Optional[str]
4545
""""""

‎annofabapi/generated_api.py

+4-4
Original file line numberDiff line numberDiff line change
@@ -779,7 +779,7 @@ def put_input_data(self, project_id: str, input_data_id: str,
779779
780780
Args:
781781
project_id (str): プロジェクトID (required)
782-
input_data_id (str): 入力データID (required)
782+
input_data_id (str): 入力データID。[値の制約についてはこちら。](#section/API-Convention/APIID) (required)
783783
request_body (Any): Request Body
784784
input_data_request (InputDataRequest): (required)
785785
@@ -1815,7 +1815,7 @@ def put_project(self, project_id: str, request_body: Optional[Any] = None) -> Tu
18151815
プロジェクトを新規作成または更新します。 ### 新規作成する場合 ユーザーは、作成するプロジェクトをひもづける組織の [OrganizationAdministrator](#section/Authentication/OrganizationAdministrator) である必要があります。 ### 更新する場合 ユーザーは、更新するプロジェクトの [ProjectOwner](#section/Authentication/ProjectOwner) である必要があります。 また所属組織を変更する場合は、新しくひもづける組織の [OrganizationAdministrator](#section/Authentication/OrganizationAdministrator) である必要があります。 なお、プロジェクト状態を「停止中」にした場合、アノテーションZIPやタスク進捗状況などの集計情報は自動更新されなくなります。
18161816
18171817
Args:
1818-
project_id (str): プロジェクトID (required)
1818+
project_id (str): プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) (required)
18191819
request_body (Any): Request Body
18201820
put_project_request (PutProjectRequest): (required)
18211821
@@ -2490,7 +2490,7 @@ def put_task(self, project_id: str, task_id: str,
24902490
24912491
Args:
24922492
project_id (str): プロジェクトID (required)
2493-
task_id (str): タスクID (required)
2493+
task_id (str): タスクID。[値の制約についてはこちら。](#section/API-Convention/APIID) (required)
24942494
request_body (Any): Request Body
24952495
task_request (TaskRequest): (required)
24962496
@@ -2599,7 +2599,7 @@ def put_webhook(self, project_id: str, webhook_id: str,
25992599
26002600
Args:
26012601
project_id (str): プロジェクトID (required)
2602-
webhook_id (str): WebhookID (required)
2602+
webhook_id (str): WebhookID。[値の制約についてはこちら。](#section/API-Convention/APIID) (required)
26032603
request_body (Any): Request Body
26042604
webhook (Webhook): (required)
26052605

0 commit comments

Comments
 (0)