Skip to content

AnnoFab 0.81.0 対応 #156

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 7 commits into from
Apr 20, 2020
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.30.1'
__version__ = '0.30.3'
7 changes: 5 additions & 2 deletions annofabapi/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -195,8 +195,11 @@ def _request_wrapper(self, http_method: str, url_path: str, query_params: Option
application/jsonならDict型, text/*ならばstr型, それ以外ならばbite型。

"""
if url_path.startswith("/labor-control") or url_path.startswith("/internal/"):
url = f"{self.endpoint_url}/api{url_path}"
else:
url = f'{self.url_prefix}{url_path}'

url = f'{self.url_prefix}{url_path}'
kwargs = self._create_kwargs(query_params, header_params, request_body)

# HTTP Requestを投げる
Expand Down Expand Up @@ -227,7 +230,7 @@ def _get_signed_cookie(self, project_id) -> Tuple[Dict[str, Any], requests.Respo
Tuple[Content, Response)

"""
url_path = f'/private/projects/{project_id}/sign-headers'
url_path = f'/internal/projects/{project_id}/sign-headers'
http_method = 'GET'
keyword_params: Dict[str, Any] = {}
return self._request_wrapper(http_method, url_path, **keyword_params)
Expand Down
5 changes: 2 additions & 3 deletions annofabapi/dataclass/my.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@

from dataclasses_json import dataclass_json

from annofabapi.dataclass.organization import OrganizationSummary
from annofabapi.models import AccountAuthority, OrganizationMemberRole, OrganizationMemberStatus, PricePlan


Expand All @@ -25,7 +24,7 @@ class MyOrganization:

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

name: Optional[str]
""""""
Expand All @@ -36,7 +35,7 @@ class MyOrganization:
price_plan: Optional[PricePlan]
""""""

summary: Optional[OrganizationSummary]
summary: Optional[Dict[str, Any]]
""""""

created_datetime: Optional[str]
Expand Down
16 changes: 3 additions & 13 deletions annofabapi/dataclass/organization.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ class OrganizationActivity:

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

created_datetime: str
""""""
Expand All @@ -33,24 +33,14 @@ class OrganizationActivity:
""""""


@dataclass_json
@dataclass
class OrganizationSummary:
"""

"""
last_tasks_updated_datetime: Optional[str]
""""""


@dataclass_json
@dataclass
class Organization:
"""

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

organization_name: str
""""""
Expand All @@ -61,7 +51,7 @@ class Organization:
price_plan: PricePlan
""""""

summary: OrganizationSummary
summary: Dict[str, Any]
""""""

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

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

account_id: 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 @@ -74,7 +74,7 @@ class Project:
"""プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) """

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

title: str
"""プロジェクトのタイトル"""
Expand Down
134 changes: 120 additions & 14 deletions annofabapi/generated_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -325,7 +325,7 @@ def get_annotation_archive(self, project_id: str, query_params: Optional[Dict[st
v2 (str): このクエリパラメータのキーだけを指定(`?v2`)、または値 `true` も指定(`?v2=true`)すると、アノテーションJSONのファイル名は `{入力データID}.json` になります。 この v2 形式は、入力データ名がファイル名の長さ上限を上回ってもよいように再設計されたものです。 以前の v1 形式(アノテーションJSONのファイル名は `{入力データ名}.json` )はいずれ廃止され、クエリパラメータ `v2` があってもなくても v2 形式に置き換わる予定です。

Returns:
Tuple[InlineResponse2009, requests.Response]
Tuple[InlineResponse20010, requests.Response]


"""
Expand Down Expand Up @@ -356,7 +356,7 @@ def get_annotation_list(self, project_id: str, query_params: Optional[Dict[str,
sort (str): ソート順の指定。 使用可能キーはtask_id, input_data_id, detail.annotation_id, detail.account_id, detail.label_id, detail.data_holding_type, detail.created_datetime, detail.updated_datetimeのいずれかです。降順指定時は先頭に-(ハイフン)を付与します。 複数指定時は,(カンマ)区切りで列挙します。複数キーを列挙した場合は、先頭から優先順位を割り振られます。

Returns:
Tuple[InlineResponse2008, requests.Response]
Tuple[InlineResponse2009, requests.Response]


"""
Expand All @@ -380,7 +380,7 @@ def get_archive_full_with_pro_id(self, project_id: str, **kwargs) -> Tuple[Any,
project_id (str): プロジェクトID (required)

Returns:
Tuple[InlineResponse2009, requests.Response]
Tuple[InlineResponse20010, requests.Response]


"""
Expand Down Expand Up @@ -674,7 +674,7 @@ def get_input_data_list(self, project_id: str, query_params: Optional[Dict[str,
limit (int): 1ページあたりの取得するデータ件数

Returns:
Tuple[InlineResponse20010, requests.Response]
Tuple[InlineResponse20011, requests.Response]


"""
Expand Down Expand Up @@ -711,8 +711,8 @@ def get_signed_url_of_input_data(self, project_id: str, input_data_id: str,
keyword_params: Dict[str, Any] = {}
return self._request_wrapper(http_method, url_path, **keyword_params)

def put_input_data(self, project_id: str, input_data_id: str, request_body: Optional[Any] = None,
**kwargs) -> Tuple[Any, requests.Response]:
def put_input_data(self, project_id: str, input_data_id: str, query_params: Optional[Dict[str, Any]] = None,
request_body: Optional[Any] = None, **kwargs) -> Tuple[Any, requests.Response]:
"""入力データ更新


Expand All @@ -724,6 +724,8 @@ def put_input_data(self, project_id: str, input_data_id: str, request_body: Opti
Args:
project_id (str): プロジェクトID (required)
input_data_id (str): 入力データID。[値の制約についてはこちら。](#section/API-Convention/APIID) (required)
query_params (Dict[str, Any]): Query Parameters
v (str): zipファイルを受領時のAPIの戻り型のバージョンを指定します。 値と戻り型の対応は以下です。 - \"1\":登録処理を開始した旨の固定メッセージ - \"2\":JobInfo
request_body (Any): Request Body
input_data_request (InputDataRequest): (required)

Expand All @@ -735,6 +737,7 @@ def put_input_data(self, project_id: str, input_data_id: str, request_body: Opti
url_path = f'/projects/{project_id}/inputs/{input_data_id}'
http_method = 'PUT'
keyword_params: Dict[str, Any] = {
'query_params': query_params,
'request_body': request_body,
}
return self._request_wrapper(http_method, url_path, **keyword_params)
Expand Down Expand Up @@ -1003,7 +1006,7 @@ def get_project_job(self, project_id: str, query_params: Optional[Dict[str, Any]
exclusive_start_created_datetime (str): 取得するデータの直前の作成日時

Returns:
Tuple[InlineResponse2006, requests.Response]
Tuple[InlineResponse2007, requests.Response]


"""
Expand Down Expand Up @@ -1152,7 +1155,7 @@ def get_my_projects(self, query_params: Optional[Dict[str, Any]] = None, **kwarg
sort_by (str): `date` を指定することでプロジェクトの最新のタスク更新時間の順にソートして出力する。 未指定時はプロジェクト名でソートする。

Returns:
Tuple[InlineResponse2003, requests.Response]
Tuple[InlineResponse2004, requests.Response]


"""
Expand Down Expand Up @@ -1518,6 +1521,109 @@ def update_organization_member_role(self, organization_name: str, user_id: str,
}
return self._request_wrapper(http_method, url_path, **keyword_params)

#########################################
# Public Method : AfOrganizationPluginApi
# NOTE: This method is auto generated by OpenAPI Generator
#########################################

def delete_organization_plugin(self, organization_name: str, plugin_id: str,
**kwargs) -> Tuple[Any, requests.Response]:
"""プラグイン削除


authorizations: OrganizationAdministrator, OrganizationOwner


**この API は AnnoFab に許可された組織だけで使用できます。またアルファ版につき、予告なく変更されることがあります。** 指定した組織のプラグインを削除します。

Args:
organization_name (str): 組織名 (required)
plugin_id (str): プラグインID (required)

Returns:
Tuple[OrganizationPlugin, requests.Response]


"""
url_path = f'/organizations/{organization_name}/plugins/{plugin_id}'
http_method = 'DELETE'
keyword_params: Dict[str, Any] = {}
return self._request_wrapper(http_method, url_path, **keyword_params)

def get_organization_plugin(self, organization_name: str, plugin_id: str,
**kwargs) -> Tuple[Any, requests.Response]:
"""プラグイン取得


authorizations: AllOrganizationMember


**この API は AnnoFab に許可された組織だけで使用できます。またアルファ版につき、予告なく変更されることがあります。** 指定した組織のプラグインを取得します。

Args:
organization_name (str): 組織名 (required)
plugin_id (str): プラグインID (required)

Returns:
Tuple[OrganizationPlugin, requests.Response]


"""
url_path = f'/organizations/{organization_name}/plugins/{plugin_id}'
http_method = 'GET'
keyword_params: Dict[str, Any] = {}
return self._request_wrapper(http_method, url_path, **keyword_params)

def get_organization_plugins(self, organization_name: str, **kwargs) -> Tuple[Any, requests.Response]:
"""プラグイン一括取得


authorizations: AllOrganizationMember


**この API は AnnoFab に許可された組織だけで使用できます。またアルファ版につき、予告なく変更されることがあります。** 指定した組織のプラグインを一括で取得します。

Args:
organization_name (str): 組織名 (required)

Returns:
Tuple[InlineResponse2003, requests.Response]


"""
url_path = f'/organizations/{organization_name}/plugins'
http_method = 'GET'
keyword_params: Dict[str, Any] = {}
return self._request_wrapper(http_method, url_path, **keyword_params)

def put_organization_plugin(self, organization_name: str, plugin_id: str, request_body: Optional[Any] = None,
**kwargs) -> Tuple[Any, requests.Response]:
"""プラグイン更新


authorizations: OrganizationAdministrator, OrganizationOwner


**この API は AnnoFab に許可された組織だけで使用できます。またアルファ版につき、予告なく変更されることがあります。** 指定した組織のプラグインを更新します。

Args:
organization_name (str): 組織名 (required)
plugin_id (str): プラグインID (required)
request_body (Any): Request Body
put_organization_plugin_request (PutOrganizationPluginRequest): (required)

Returns:
Tuple[OrganizationPlugin, requests.Response]


"""
url_path = f'/organizations/{organization_name}/plugins/{plugin_id}'
http_method = 'PUT'
keyword_params: Dict[str, Any] = {
'request_body': request_body,
}
return self._request_wrapper(http_method, url_path, **keyword_params)

#########################################
# Public Method : AfProjectApi
# NOTE: This method is auto generated by OpenAPI Generator
Expand Down Expand Up @@ -1605,7 +1711,7 @@ def get_project_inputs_url(self, project_id: str, **kwargs) -> Tuple[Any, reques
project_id (str): プロジェクトID (required)

Returns:
Tuple[InlineResponse2004, requests.Response]
Tuple[InlineResponse2005, requests.Response]


"""
Expand All @@ -1627,7 +1733,7 @@ def get_project_inspections_url(self, project_id: str, **kwargs) -> Tuple[Any, r
project_id (str): プロジェクトID (required)

Returns:
Tuple[InlineResponse2004, requests.Response]
Tuple[InlineResponse2005, requests.Response]


"""
Expand All @@ -1649,7 +1755,7 @@ def get_project_task_history_events_url(self, project_id: str, **kwargs) -> Tupl
project_id (str): プロジェクトID (required)

Returns:
Tuple[InlineResponse2004, requests.Response]
Tuple[InlineResponse2005, requests.Response]


"""
Expand All @@ -1671,7 +1777,7 @@ def get_project_tasks_url(self, project_id: str, **kwargs) -> Tuple[Any, request
project_id (str): プロジェクトID (required)

Returns:
Tuple[InlineResponse2004, requests.Response]
Tuple[InlineResponse2005, requests.Response]


"""
Expand Down Expand Up @@ -1829,7 +1935,7 @@ def get_project_members(self, project_id: str, query_params: Optional[Dict[str,
include_inactive_member (str): 脱退したプロジェクトメンバーも取得する時に、キーのみ指定します(値は無視されます)。

Returns:
Tuple[InlineResponse2005, requests.Response]
Tuple[InlineResponse2006, requests.Response]


"""
Expand Down Expand Up @@ -2313,7 +2419,7 @@ def get_tasks(self, project_id: str, query_params: Optional[Dict[str, Any]] = No
sort (str): ソート順の指定。 使用可能キーはtask_id、updated_datetime、number_of_rejections、phase、phase_stage、status、account_idのいずれかです。降順指定時は先頭に-(ハイフン)を付与します。 複数指定時は,(カンマ)区切りで列挙します。複数キーを列挙した場合は、先頭から優先順位を割り振られます。

Returns:
Tuple[InlineResponse2007, requests.Response]
Tuple[InlineResponse2008, requests.Response]


"""
Expand Down
21 changes: 21 additions & 0 deletions annofabapi/generated_api2.py
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,27 @@ def get_annotation_specs_v2(self, project_id: str, query_params: Optional[Dict[s
# NOTE: This method is auto generated by OpenAPI Generator
#########################################

def get_organization_cache_v2(self, organization_id: str, **kwargs) -> Tuple[Any, requests.Response]:
"""キャッシュレコード


authorizations: SignedCookieKeyPairId, SignedCookiePolicy, SignedCookieSignature



Args:
organization_id (str): 組織ID (required)

Returns:
Tuple[OrganizationCacheRecord, requests.Response]


"""
url_path = f'/organizations/{organization_id}/cache'
http_method = 'GET'
keyword_params: Dict[str, Any] = {}
return self._request_wrapper(http_method, url_path, **keyword_params)

def get_project_task_count_v2(self, organization_id: str, project_id: str,
**kwargs) -> Tuple[Any, requests.Response]:
"""プロジェクトのタスク件数取得
Expand Down
Loading