diff --git a/annofabapi/__version__.py b/annofabapi/__version__.py index 5bbe4824..81edede8 100644 --- a/annofabapi/__version__.py +++ b/annofabapi/__version__.py @@ -1 +1 @@ -__version__ = '0.21.4' +__version__ = '0.22.0' diff --git a/annofabapi/dataclass/my.py b/annofabapi/dataclass/my.py index 954c8d5f..cdb9fdd1 100644 --- a/annofabapi/dataclass/my.py +++ b/annofabapi/dataclass/my.py @@ -71,6 +71,9 @@ class MyAccount: lang: str """""" + biography: Optional[str] + """人物紹介、略歴。 この属性は、AnnoFab外の所属先や肩書などを表すために用います。 AnnoFab上の「複数の組織」で活動する場合、本籍を示すのに便利です。 """ + keylayout: str """""" diff --git a/annofabapi/dataclass/organization_member.py b/annofabapi/dataclass/organization_member.py index db8670c0..b4bdb682 100644 --- a/annofabapi/dataclass/organization_member.py +++ b/annofabapi/dataclass/organization_member.py @@ -41,6 +41,9 @@ class OrganizationMember: status: OrganizationMemberStatus """""" + biography: Optional[str] + """人物紹介、略歴。 この属性は、AnnoFab外の所属先や肩書などを表すために用います。 AnnoFab上の「複数の組織」で活動する場合、本籍を示すのに便利です。 """ + created_datetime: Optional[str] """""" diff --git a/annofabapi/dataclass/project_member.py b/annofabapi/dataclass/project_member.py index 740a9c1b..4bd27045 100644 --- a/annofabapi/dataclass/project_member.py +++ b/annofabapi/dataclass/project_member.py @@ -41,6 +41,9 @@ class ProjectMember: member_role: ProjectMemberRole """""" + biography: Optional[str] + """人物紹介、略歴。 この属性は、AnnoFab外の所属先や肩書などを表すために用います。 AnnoFab上の「複数の組織」で活動する場合、本籍を示すのに便利です。 """ + updated_datetime: Optional[str] """""" diff --git a/annofabapi/generated_api.py b/annofabapi/generated_api.py index 19bfc564..66f2f0c9 100644 --- a/annofabapi/generated_api.py +++ b/annofabapi/generated_api.py @@ -1014,7 +1014,7 @@ def get_project_job(self, project_id: str, query_params: Optional[Dict[str, Any] authorizations: AllProjectMember - バックグラウンドジョブの情報を取得する。 取得されるジョブの情報は作成日付の新しい順にソートされる。 + バックグラウンドジョブの情報を取得する。 取得されるジョブの情報は作成日付の新しい順にソートされる。 バックグラウンドジョブ情報は完了(失敗含む)から14日経過後に削除される。 Args: project_id (str): プロジェクトID (required) @@ -2228,14 +2228,14 @@ def get_tasks(self, project_id: str, query_params: Optional[Dict[str, Any]] = No limit (int): 1ページあたりの取得するデータ件数 task_id (str): タスクIDでの部分一致検索で使用。1文字以上あれば使用します。利便性のため、大文字小文字は区別しません input_data_ids (str): 指定された入力データIDを使用しているタスクを絞り込みます。カンマ区切りで複数の入力データIDを指定可能です。1文字以上あれば使用します。利便性のため、大文字小文字は区別しません - phase (str): 絞り込み条件となるフェーズ名。未指定時は全フェーズ - phase_stage (str): 絞り込み条件となるステージ。未指定時は全ステージ - status (str): 絞り込み条件となる状態名。未指定時は全ステータス。 + phase (TaskPhase): 絞り込み条件となるフェーズ名。未指定時は全フェーズ + phase_stage (int): 絞り込み条件となるステージ。未指定時は全ステージ + status (TaskStatus): 絞り込み条件となる状態名。未指定時は全ステータス。 account_id (str): 絞り込み条件となる作業中のアカウントID。未指定時は全アカウント no_user (str): 未割り当てのタスクを絞り込む時に、キーのみ指定します（値は無視されます）。 previous_account_id (str): そのタスクをこれまでに担当したことのあるユーザー（現在の担当者含む）のアカウントID。未指定時は全ユーザ previous_phase (TaskPhase): そのタスクがこれまでに遷移したことのあるフェーズ名（現在のフェーズ含む）。未指定時は全フェーズ - previous_phase_stage (str): そのタスクがこれまでに遷移したことのあるステージ（現在のステージ含む）。未指定時は全ステージ + previous_phase_stage (int): そのタスクがこれまでに遷移したことのあるステージ（現在のステージ含む）。未指定時は全ステージ rejected_only (str): 差し戻されたタスクだけを絞り込む時に、キーのみ指定します（値は無視されます）。 auto_accepted_only (str): 「抜取検査の対象外となり、自動受入されたタスク」だけを絞り込む時に、キーのみ指定します（値は無視されます）。 sort (str): ソート順の指定。 使用可能キーはtask_id、updated_datetime、number_of_rejections、phase、phase_stage、status、account_idのいずれかです。降順指定時は先頭に-(ハイフン)を付与します。 複数指定時は,(カンマ)区切りで列挙します。複数キーを列挙した場合は、先頭から優先順位を割り振られます。 diff --git a/annofabapi/models.py b/annofabapi/models.py index d7744c4d..21a8e007 100644 --- a/annofabapi/models.py +++ b/annofabapi/models.py @@ -187,6 +187,8 @@ * lang: str +* biography: str + 人物紹介、略歴。 この属性は、AnnoFab外の所属先や肩書などを表すために用います。 AnnoFab上の「複数の組織」で活動する場合、本籍を示すのに便利です。 * keylayout: str * authority: AccountAuthority @@ -562,6 +564,8 @@ class AnnotationDataHoldingType(Enum): 定型指摘 * comment: str +* auto_marking: bool + trueが指定された場合、各統計グラフにマーカーを自動追加します。 マーカーのタイトルには `comment` に指定された文字列が設定されます。 `comment` が指定されていなかった場合は \"アノテーション仕様の変更\" という文字列が設定されます。 """ @@ -2262,6 +2266,8 @@ class JobType(Enum): * lang: str +* biography: str + 人物紹介、略歴。 この属性は、AnnoFab外の所属先や肩書などを表すために用います。 AnnoFab上の「複数の組織」で活動する場合、本籍を示すのに便利です。 * keylayout: str * authority: AccountAuthority @@ -2371,6 +2377,8 @@ class JobType(Enum): * status: OrganizationMemberStatus +* biography: str + 人物紹介、略歴。 この属性は、AnnoFab外の所属先や肩書などを表すために用います。 AnnoFab上の「複数の組織」で活動する場合、本籍を示すのに便利です。 * created_datetime: str * updated_datetime: str @@ -2618,6 +2626,8 @@ class PricePlan(Enum): * member_role: ProjectMemberRole +* biography: str + 人物紹介、略歴。 この属性は、AnnoFab外の所属先や肩書などを表すために用います。 AnnoFab上の「複数の組織」で活動する場合、本籍を示すのに便利です。 * updated_datetime: str * created_datetime: str @@ -2744,6 +2754,8 @@ class ProjectStatus(Enum): * keylayout: str +* biography: str + 人物紹介、略歴。 この属性は、AnnoFab外の所属先や肩書などを表すために用います。 AnnoFab上の「複数の組織」で活動する場合、本籍を示すのに便利です。 * token: Token * last_updated_datetime: str diff --git a/generate/swagger/swagger-api-components.yaml b/generate/swagger/swagger-api-components.yaml index 9ff54301..5b8d904e 100644 --- a/generate/swagger/swagger-api-components.yaml +++ b/generate/swagger/swagger-api-components.yaml @@ -637,6 +637,8 @@ format: email lang: type: string + biography: + $ref: "#/components/schemas/UserBiography" keylayout: type: string authority: @@ -680,6 +682,8 @@ type: string keylayout: type: string + biography: + $ref: "#/components/schemas/UserBiography" token: $ref: "#/components/schemas/Token" last_updated_datetime: @@ -769,6 +773,8 @@ $ref: "#/components/schemas/OrganizationMemberRole" status: $ref: "#/components/schemas/OrganizationMemberStatus" + biography: + $ref: "#/components/schemas/UserBiography" created_datetime: type: string format: date-time @@ -936,6 +942,16 @@ Duration: type: string example: "PT34H17M36.789S" + UserBiography: + type: string + description: | + 人物紹介、略歴。 + + この属性は、AnnoFab外の所属先や肩書などを表すために用います。 + AnnoFab上の「複数の組織」で活動する場合、本籍を示すのに便利です。 + minLength: 0 + maxLength: 100 + example: "Annotation Manager, ABC Company" AnnotationFormatVersion: type: string example: "1.0.0" @@ -1289,7 +1305,9 @@ $ref: "#/components/schemas/ProjectMemberStatus" member_role: $ref: "#/components/schemas/ProjectMemberRole" - updated_datetime: + biography: + $ref: "#/components/schemas/UserBiography" + pdated_datetime: type: string format: date-time created_datetime: @@ -1585,6 +1603,13 @@ 定型指摘 comment: type: string + autoMarking: + type: boolean + default: false + description: | + trueが指定された場合、各統計グラフにマーカーを自動追加します。 + マーカーのタイトルには `comment` に指定された文字列が設定されます。 + `comment` が指定されていなかった場合は "アノテーション仕様の変更" という文字列が設定されます。 AnnotationSpecsHistory: type: object properties: @@ -1801,9 +1826,7 @@ phase: $ref: "#/components/schemas/TaskPhase" phase_stage: - type: integer - default: 1 - minimum: 1 + $ref: "#/components/schemas/TaskPhaseStage" status: $ref: "#/components/schemas/TaskStatus" input_data_id_list: @@ -1859,6 +1882,9 @@ * `annotation` - 教師付け。 * `inspection` - 中間検査。ワークフローが3フェーズのときのみ。 * `acceptance` - 受入。 + TaskPhaseStage: + type: integer + minimum: 1 TaskStatus: type: string enum: diff --git a/generate/swagger/swagger.v2.yaml b/generate/swagger/swagger.v2.yaml index dadcdaa3..000fb857 100644 --- a/generate/swagger/swagger.v2.yaml +++ b/generate/swagger/swagger.v2.yaml @@ -76,7 +76,7 @@ info: WebhookID | プロジェクト内で一意 入力データセットID | 組織内で一意 - version: 0.66.7 + version: 0.67.0 title: AnnoFab Web API x-logo: url: "https://annofab.com/images/logo_landscape.png" @@ -1219,6 +1219,8 @@ components: format: email lang: type: string + biography: + $ref: "#/components/schemas/UserBiography" keylayout: type: string authority: @@ -1262,6 +1264,8 @@ components: type: string keylayout: type: string + biography: + $ref: "#/components/schemas/UserBiography" token: $ref: "#/components/schemas/Token" last_updated_datetime: @@ -1351,6 +1355,8 @@ components: $ref: "#/components/schemas/OrganizationMemberRole" status: $ref: "#/components/schemas/OrganizationMemberStatus" + biography: + $ref: "#/components/schemas/UserBiography" created_datetime: type: string format: date-time @@ -1518,6 +1524,16 @@ components: Duration: type: string example: "PT34H17M36.789S" + UserBiography: + type: string + description: | + 人物紹介、略歴。 + + この属性は、AnnoFab外の所属先や肩書などを表すために用います。 + AnnoFab上の「複数の組織」で活動する場合、本籍を示すのに便利です。 + minLength: 0 + maxLength: 100 + example: "Annotation Manager, ABC Company" AnnotationFormatVersion: type: string example: "1.0.0" @@ -1871,7 +1887,9 @@ components: $ref: "#/components/schemas/ProjectMemberStatus" member_role: $ref: "#/components/schemas/ProjectMemberRole" - updated_datetime: + biography: + $ref: "#/components/schemas/UserBiography" + pdated_datetime: type: string format: date-time created_datetime: @@ -2167,6 +2185,13 @@ components: 定型指摘 comment: type: string + autoMarking: + type: boolean + default: false + description: | + trueが指定された場合、各統計グラフにマーカーを自動追加します。 + マーカーのタイトルには `comment` に指定された文字列が設定されます。 + `comment` が指定されていなかった場合は "アノテーション仕様の変更" という文字列が設定されます。 AnnotationSpecsHistory: type: object properties: @@ -2383,9 +2408,7 @@ components: phase: $ref: "#/components/schemas/TaskPhase" phase_stage: - type: integer - default: 1 - minimum: 1 + $ref: "#/components/schemas/TaskPhaseStage" status: $ref: "#/components/schemas/TaskStatus" input_data_id_list: @@ -2441,6 +2464,9 @@ components: * `annotation` - 教師付け。 * `inspection` - 中間検査。ワークフローが3フェーズのときのみ。 * `acceptance` - 受入。 + TaskPhaseStage: + type: integer + minimum: 1 TaskStatus: type: string enum: diff --git a/generate/swagger/swagger.yaml b/generate/swagger/swagger.yaml index d82d33cc..f4274947 100644 --- a/generate/swagger/swagger.yaml +++ b/generate/swagger/swagger.yaml @@ -76,7 +76,7 @@ info: WebhookID | プロジェクト内で一意 入力データセットID | 組織内で一意 - version: 0.66.7 + version: 0.67.0 title: AnnoFab Web API x-logo: url: "https://annofab.com/images/logo_landscape.png" @@ -2144,6 +2144,7 @@ paths: description: | バックグラウンドジョブの情報を取得する。 取得されるジョブの情報は作成日付の新しい順にソートされる。 + バックグラウンドジョブ情報は完了(失敗含む)から14日経過後に削除される。 security: - AllProjectMember: [] operationId: getProjectJob @@ -2629,19 +2630,19 @@ paths: description: 絞り込み条件となるフェーズ名。未指定時は全フェーズ required: false schema: - type: string + $ref: "#/components/schemas/TaskPhase" - name: phase_stage in: query description: 絞り込み条件となるステージ。未指定時は全ステージ required: false schema: - type: string + $ref: "#/components/schemas/TaskPhaseStage" - name: status in: query description: 絞り込み条件となる状態名。未指定時は全ステータス。 required: false schema: - type: string + $ref: "#/components/schemas/TaskStatus" - name: account_id in: query description: 絞り込み条件となる作業中のアカウントID。未指定時は全アカウント @@ -2672,7 +2673,7 @@ paths: description: そのタスクがこれまでに遷移したことのあるステージ（現在のステージ含む）。未指定時は全ステージ required: false schema: - type: string + $ref: "#/components/schemas/TaskPhaseStage" - name: rejected_only in: query description: 差し戻されたタスクだけを絞り込む時に、キーのみ指定します（値は無視されます）。 @@ -5203,6 +5204,8 @@ components: format: email lang: type: string + biography: + $ref: "#/components/schemas/UserBiography" keylayout: type: string authority: @@ -5246,6 +5249,8 @@ components: type: string keylayout: type: string + biography: + $ref: "#/components/schemas/UserBiography" token: $ref: "#/components/schemas/Token" last_updated_datetime: @@ -5335,6 +5340,8 @@ components: $ref: "#/components/schemas/OrganizationMemberRole" status: $ref: "#/components/schemas/OrganizationMemberStatus" + biography: + $ref: "#/components/schemas/UserBiography" created_datetime: type: string format: date-time @@ -5502,6 +5509,16 @@ components: Duration: type: string example: "PT34H17M36.789S" + UserBiography: + type: string + description: | + 人物紹介、略歴。 + + この属性は、AnnoFab外の所属先や肩書などを表すために用います。 + AnnoFab上の「複数の組織」で活動する場合、本籍を示すのに便利です。 + minLength: 0 + maxLength: 100 + example: "Annotation Manager, ABC Company" AnnotationFormatVersion: type: string example: "1.0.0" @@ -5855,7 +5872,9 @@ components: $ref: "#/components/schemas/ProjectMemberStatus" member_role: $ref: "#/components/schemas/ProjectMemberRole" - updated_datetime: + biography: + $ref: "#/components/schemas/UserBiography" + pdated_datetime: type: string format: date-time created_datetime: @@ -6151,6 +6170,13 @@ components: 定型指摘 comment: type: string + autoMarking: + type: boolean + default: false + description: | + trueが指定された場合、各統計グラフにマーカーを自動追加します。 + マーカーのタイトルには `comment` に指定された文字列が設定されます。 + `comment` が指定されていなかった場合は "アノテーション仕様の変更" という文字列が設定されます。 AnnotationSpecsHistory: type: object properties: @@ -6367,9 +6393,7 @@ components: phase: $ref: "#/components/schemas/TaskPhase" phase_stage: - type: integer - default: 1 - minimum: 1 + $ref: "#/components/schemas/TaskPhaseStage" status: $ref: "#/components/schemas/TaskStatus" input_data_id_list: @@ -6425,6 +6449,9 @@ components: * `annotation` - 教師付け。 * `inspection` - 中間検査。ワークフローが3フェーズのときのみ。 * `acceptance` - 受入。 + TaskPhaseStage: + type: integer + minimum: 1 TaskStatus: type: string enum: diff --git a/tests/data/dataclass/my-account.json b/tests/data/dataclass/my-account.json index 2e19674d..c722808e 100644 --- a/tests/data/dataclass/my-account.json +++ b/tests/data/dataclass/my-account.json @@ -5,6 +5,7 @@ "email": "test_user@example.com", "reset_requested_email": null, "lang": "ja-JP", + "biography": "my-org", "keylayout": "ja-JP", "authority": "user", "errors": [], diff --git a/tests/data/dataclass/organization-member.json b/tests/data/dataclass/organization-member.json index 8472e325..b29c9150 100644 --- a/tests/data/dataclass/organization-member.json +++ b/tests/data/dataclass/organization-member.json @@ -5,6 +5,7 @@ "username": "Alice", "role": "owner", "status": "active", + "biography": "my-org", "updated_datetime": "2019-08-17T21:19:43.787+09:00", "created_datetime": "2018-06-07T15:48:15.133+09:00" } diff --git a/tests/data/dataclass/project-member.json b/tests/data/dataclass/project-member.json index 931c3aca..efcaf733 100644 --- a/tests/data/dataclass/project-member.json +++ b/tests/data/dataclass/project-member.json @@ -5,6 +5,7 @@ "username": "Alice", "member_status": "active", "member_role": "owner", + "biography": "my-org", "updated_datetime": "2019-05-03T16:43:34.796+09:00", "created_datetime": "2019-04-23T12:03:21.795+09:00", "sampling_inspection_rate": null,