Skip to content

Commit 86ba153

Browse files
authored
Annofab v111.0 (#295)
* update pyproject.toml * annofab v0.111.0 * version up
1 parent 2867974 commit 86ba153

File tree

9 files changed

+906
-396
lines changed

9 files changed

+906
-396
lines changed

annofabapi/__version__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
__version__ = "0.43.0"
1+
__version__ = "0.44.0"

annofabapi/dataclass/annotation_specs.py

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ class AdditionalDataDefinitionV1Choices(DataClassJsonMixin):
183183
name: InternationalizationMessage
184184
""""""
185185

186-
keybind: List[Keybind]
186+
keybind: Optional[List[Keybind]]
187187
""""""
188188

189189

@@ -194,34 +194,34 @@ class AdditionalDataDefinitionV1(DataClassJsonMixin):
194194
additional_data_definition_id: str
195195
""""""
196196

197-
read_only: bool
197+
read_only: Optional[bool]
198198
""""""
199199

200-
name: InternationalizationMessage
200+
name: Optional[InternationalizationMessage]
201201
""""""
202202

203-
default: AdditionalDataDefaultType
203+
default: Optional[AdditionalDataDefaultType]
204204
""""""
205205

206-
keybind: List[Keybind]
206+
keybind: Optional[List[Keybind]]
207207
""""""
208208

209209
type: AdditionalDataDefinitionType
210210
""""""
211211

212-
choices: List[AdditionalDataDefinitionV1Choices]
212+
choices: Optional[List[AdditionalDataDefinitionV1Choices]]
213213
""""""
214214

215215
regex: Optional[str]
216216
""""""
217217

218-
label_ids: List[str]
218+
label_ids: Optional[List[str]]
219219
"""リンク属性において、リンク先として指定可能なラベルID(空の場合制限なし)"""
220220

221221
required: Optional[bool]
222222
"""リンク属性において、入力を必須とするかどうか"""
223223

224-
metadata: Dict[str, str]
224+
metadata: Optional[Dict[str, str]]
225225
"""ユーザーが自由に登録できるkey-value型のメタデータです。 """
226226

227227

@@ -232,25 +232,25 @@ class AdditionalDataDefinitionV2(DataClassJsonMixin):
232232
additional_data_definition_id: str
233233
""""""
234234

235-
read_only: bool
235+
read_only: Optional[bool]
236236
""""""
237237

238238
name: InternationalizationMessage
239239
""""""
240240

241-
default: AdditionalDataDefaultType
241+
default: Optional[AdditionalDataDefaultType]
242242
""""""
243243

244-
keybind: List[Keybind]
244+
keybind: Optional[List[Keybind]]
245245
""""""
246246

247247
type: AdditionalDataDefinitionType
248248
""""""
249249

250-
choices: List[AdditionalDataDefinitionV1Choices]
250+
choices: Optional[List[AdditionalDataDefinitionV1Choices]]
251251
""""""
252252

253-
metadata: Dict[str, str]
253+
metadata: Optional[Dict[str, str]]
254254
"""ユーザーが自由に登録できるkey-value型のメタデータです。 """
255255

256256

@@ -308,10 +308,10 @@ class LabelV1(DataClassJsonMixin):
308308
annotation_editor_feature: AnnotationEditorFeature
309309
""""""
310310

311-
allow_out_of_image_bounds: bool
311+
allow_out_of_image_bounds: Optional[bool]
312312
""""""
313313

314-
metadata: Dict[str, str]
314+
metadata: Optional[Dict[str, str]]
315315
"""ユーザーが自由に登録できるkey-value型のメタデータです。 """
316316

317317

@@ -346,10 +346,10 @@ class LabelV2(DataClassJsonMixin):
346346
annotation_editor_feature: AnnotationEditorFeature
347347
""""""
348348

349-
allow_out_of_image_bounds: bool
349+
allow_out_of_image_bounds: Optional[bool]
350350
""""""
351351

352-
metadata: Dict[str, str]
352+
metadata: Optional[Dict[str, str]]
353353
"""ユーザーが自由に登録できるkey-value型のメタデータです。 """
354354

355355

annofabapi/generated_api.py

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1430,6 +1430,33 @@ def get_projects_of_organization(
14301430
# NOTE: This method is auto generated by OpenAPI Generator
14311431
#########################################
14321432

1433+
def delete_organization_input_data(
1434+
self, organization_name: str, input_data_set_id: str, input_data_id: str, **kwargs
1435+
) -> Tuple[Any, requests.Response]:
1436+
"""入力データセットの入力データ削除
1437+
https://annofab.com/docs/api/#operation/deleteOrganizationInputData
1438+
1439+
1440+
authorizations: OrganizationAdministrator, ProjectOwner
1441+
1442+
1443+
指定した組織の[入力データセット](#tag/af-organization-input)内で指定した入力データ情報を削除します。
1444+
1445+
Args:
1446+
organization_name (str): 組織名 (required)
1447+
input_data_set_id (str): 入力データセットID (required)
1448+
input_data_id (str): 入力データID (required)
1449+
1450+
Returns:
1451+
Tuple[InputData, requests.Response]
1452+
1453+
1454+
"""
1455+
url_path = f"/organizations/{organization_name}/input_data_set/{input_data_set_id}/inputs/{input_data_id}"
1456+
http_method = "DELETE"
1457+
keyword_params: Dict[str, Any] = {}
1458+
return self._request_wrapper(http_method, url_path, **keyword_params)
1459+
14331460
def get_input_data_set(
14341461
self, organization_name: str, input_data_set_id: str, **kwargs
14351462
) -> Tuple[Any, requests.Response]:
@@ -1506,6 +1533,73 @@ def get_organization_input_data(
15061533
keyword_params: Dict[str, Any] = {}
15071534
return self._request_wrapper(http_method, url_path, **keyword_params)
15081535

1536+
def get_organization_input_data_list(
1537+
self, organization_name: str, input_data_set_id: str, query_params: Optional[Dict[str, Any]] = None, **kwargs
1538+
) -> Tuple[Any, requests.Response]:
1539+
"""入力データセット内の入力データ一括取得
1540+
https://annofab.com/docs/api/#operation/getOrganizationInputDataList
1541+
1542+
1543+
authorizations: AllOrganizationMember
1544+
1545+
1546+
指定された入力データセットの入力データを検索します。 組織オーナーまたは組織管理者でない場合は自身が所属するプロジェクトの入力データセット内の入力データのみが取得できます。 パフォーマンスのため、結果はページング形式で返ります。全件取得したい場合は、レスポンスを見て、ページ移動してください。
1547+
1548+
Args:
1549+
organization_name (str): 組織名 (required)
1550+
input_data_set_id (str): 入力データセットID (required)
1551+
query_params (Dict[str, Any]): Query Parameters
1552+
input_data_id (str): 入力データIDでの部分一致検索で使用。1文字以上あれば使用します。
1553+
input_data_name (str): 入力データ名での部分一致検索で使用。1文字以上あれば使用します。
1554+
input_data_path (str): 入力データパスでの部分一致検索で使用。1文字以上あれば使用します。
1555+
task_id (str): 入力データが紐づくタスクIDの部分一致検索で使用。1文字以上あれば使用します。条件に合致した先頭100件のタスクに使われている入力データを検索します。
1556+
_from (str): 更新日時での範囲検索で使用(ISO 8601 拡張形式)
1557+
to (str): 更新日時での範囲検索で使用(ISO 8601 拡張形式)
1558+
page (int): 検索結果のうち、取得したいページの番号(1始まり)
1559+
limit (int): 1ページあたりの取得するデータ件数
1560+
1561+
Returns:
1562+
Tuple[InputDataList, requests.Response]
1563+
1564+
1565+
"""
1566+
url_path = f"/organizations/{organization_name}/input_data_set/{input_data_set_id}/inputs"
1567+
http_method = "GET"
1568+
keyword_params: Dict[str, Any] = {
1569+
"query_params": query_params,
1570+
}
1571+
return self._request_wrapper(http_method, url_path, **keyword_params)
1572+
1573+
def put_input_data_set(
1574+
self, organization_name: str, input_data_set_id: str, request_body: Optional[Any] = None, **kwargs
1575+
) -> Tuple[Any, requests.Response]:
1576+
"""入力データセット新規作成/更新
1577+
https://annofab.com/docs/api/#operation/putInputDataSet
1578+
1579+
1580+
authorizations: OrganizationAdministrator, OrganizationOwner
1581+
1582+
1583+
指定した組織の[入力データセット](#tag/af-organization-input)の情報を新規登録/更新します。
1584+
1585+
Args:
1586+
organization_name (str): 組織名 (required)
1587+
input_data_set_id (str): 入力データセットID (required)
1588+
request_body (Any): Request Body
1589+
put_input_data_set_request (PutInputDataSetRequest):
1590+
1591+
Returns:
1592+
Tuple[InputDataSet, requests.Response]
1593+
1594+
1595+
"""
1596+
url_path = f"/organizations/{organization_name}/input_data_set/{input_data_set_id}"
1597+
http_method = "PUT"
1598+
keyword_params: Dict[str, Any] = {
1599+
"request_body": request_body,
1600+
}
1601+
return self._request_wrapper(http_method, url_path, **keyword_params)
1602+
15091603
#########################################
15101604
# Public Method : AfOrganizationMemberApi
15111605
# NOTE: This method is auto generated by OpenAPI Generator

annofabapi/models.py

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2763,6 +2763,8 @@ class OrganizationMemberStatus(Enum):
27632763
27642764
* url: str
27652765
カスタムアノテーション仕様画面の URL です。 プラグイン種別がカスタムアノテーション仕様の場合のみ有効です。 この URL には、プロジェクトを特定するための以下のパラメータを必ず埋め込んでください。 * `{projectId}`
2766+
* auth_redirect_url: str
2767+
認証後のリダイレクト先
27662768
* compatible_input_data_types: List[InputDataType]
27672769
プラグインが対応している入力データです。 プラグイン種別がカスタムアノテーションエディタ、またはカスタムアノテーション仕様の場合のみ有効です。
27682770
* type: str
@@ -2778,6 +2780,8 @@ class OrganizationMemberStatus(Enum):
27782780
27792781
* url: str
27802782
カスタムアノテーションエディタでタスクを開くための URL です。 プラグインを使用するプロジェクトのタスク一覧などで使用されます。 プラグイン種別がカスタムアノテーションエディタの場合のみ有効です。 この URL には、タスクを特定するための以下のパラメータを必ず埋め込んでください。 * `{projectId}` * `{taskId}` 以下のパラメーターは任意で指定します。 * `{inputDataId}`: アノテーション一覧などから、特定の入力データにフォーカスした状態でタスクを開くときなどに指定します。 * `{annotationId}`: アノテーション一覧などから、特定のアノテーションにフォーカスした状態でタスクを開くときなどに指定します。
2783+
* auth_redirect_url: str
2784+
認証後のリダイレクト先。このURLに `?code=xxx` をつけてリダイレクトされます。 url プロパティとは異なり、 `{projectId}` や `{taskId}` といったパラメータの置換は行われません。 詳しくは [requestPluginToken API](#operation/requestPluginToken) を参照してください。
27812785
* compatible_input_data_types: List[InputDataType]
27822786
プラグインが対応している入力データです。 プラグイン種別がカスタムアノテーションエディタ、またはカスタムアノテーション仕様の場合のみ有効です。
27832787
* type: str
@@ -2793,6 +2797,8 @@ class OrganizationMemberStatus(Enum):
27932797
27942798
* url: str
27952799
カスタムアノテーション仕様画面の URL です。 プラグイン種別がカスタムアノテーション仕様の場合のみ有効です。 この URL には、プロジェクトを特定するための以下のパラメータを必ず埋め込んでください。 * `{projectId}`
2800+
* auth_redirect_url: str
2801+
認証後のリダイレクト先
27962802
* compatible_input_data_types: List[InputDataType]
27972803
プラグインが対応している入力データです。 プラグイン種別がカスタムアノテーションエディタ、またはカスタムアノテーション仕様の場合のみ有効です。
27982804
* type: str
@@ -2813,6 +2819,64 @@ class OrganizationMemberStatus(Enum):
28132819
28142820
"""
28152821

2822+
PluginTokenRequest = Dict[str, Any]
2823+
"""
2824+
2825+
2826+
Kyes of Dict
2827+
2828+
* type: str
2829+
`RefreshToken` を指定します
2830+
* authorization_code: str
2831+
リダイレクト時にクエリパラメータ `code` として受け取った文字列
2832+
* code_verifier: str
2833+
認可リクエスト時に渡した `code_challenge` に対応するverifier文字列
2834+
* refresh_token: str
2835+
前回のトークン発行で得られた `refresh_token`
2836+
2837+
"""
2838+
2839+
PluginTokenRequestAuthorizationCode = Dict[str, Any]
2840+
"""
2841+
2842+
2843+
Kyes of Dict
2844+
2845+
* type: str
2846+
`AuthorizationCode` を指定します
2847+
* authorization_code: str
2848+
リダイレクト時にクエリパラメータ `code` として受け取った文字列
2849+
* code_verifier: str
2850+
認可リクエスト時に渡した `code_challenge` に対応するverifier文字列
2851+
2852+
"""
2853+
2854+
PluginTokenRequestRefreshToken = Dict[str, Any]
2855+
"""
2856+
2857+
2858+
Kyes of Dict
2859+
2860+
* type: str
2861+
`RefreshToken` を指定します
2862+
* refresh_token: str
2863+
前回のトークン発行で得られた `refresh_token`
2864+
2865+
"""
2866+
2867+
PluginTokenResponse = Dict[str, Any]
2868+
"""
2869+
2870+
2871+
Kyes of Dict
2872+
2873+
* access_token: str
2874+
APIアクセスに用いるトークン。 リクエストヘッダにおいて `Authorization: Bearer {access_token}` の形で指定します。
2875+
* refresh_token: str
2876+
トークンの更新に用いるトークン。
2877+
2878+
"""
2879+
28162880
Point = Dict[str, Any]
28172881
"""
28182882
座標
@@ -3239,6 +3303,23 @@ class ProjectStatus(Enum):
32393303
* tasks: List[ProjectTaskStatistics]
32403304
32413305
3306+
"""
3307+
3308+
PutInputDataSetRequest = Dict[str, Any]
3309+
"""
3310+
入力データセット新規作成/更新
3311+
3312+
Kyes of Dict
3313+
3314+
* input_data_set_name: str
3315+
表示用の名前です。
3316+
* input_data_type: InputDataType
3317+
3318+
* private_storage_arn: str
3319+
AWS IAMロール。ビジネスプランでのS3プライベートストレージの認可で使います。 [S3プライベートストレージの認可の設定についてはこちら](/docs/faq/#m0b240)をご覧ください。
3320+
* last_updated_datetime: str
3321+
入力データセットの最終更新日時
3322+
32423323
"""
32433324

32443325
PutMarkersRequest = Dict[str, Any]

0 commit comments

Comments
 (0)