diff --git a/annofabapi/dataclass/input.py b/annofabapi/dataclass/input.py index a4f0732e..dd5f9143 100644 --- a/annofabapi/dataclass/input.py +++ b/annofabapi/dataclass/input.py @@ -50,7 +50,7 @@ class InputData(DataClassJsonMixin): """入力データ名""" input_data_path: str - """入力データの実体が保存されたパスです。 s3スキーマまたはhttpsスキーマのみサポートしています。 """ + """入力データの実体が保存されたURLです。 URLスキームが s3 もしくは https であるもののみをサポートしています。 """ url: Optional[str] """システム内部用のプロパティ""" diff --git a/annofabapi/dataclass/supplementary.py b/annofabapi/dataclass/supplementary.py index b0f65651..b859c8ef 100644 --- a/annofabapi/dataclass/supplementary.py +++ b/annofabapi/dataclass/supplementary.py @@ -40,7 +40,7 @@ class SupplementaryData(DataClassJsonMixin): """補助情報の名前""" supplementary_data_path: str - """補助情報の実体が存在するパスです。 s3スキーマまたはhttpsスキーマのみサポートしています。 """ + """補助情報の実体が存在するURLです。 URLスキームが s3 もしくは https であるもののみをサポートしています。 """ url: str """システム内部用のプロパティ""" diff --git a/annofabapi/generated_api.py b/annofabapi/generated_api.py index 6a418438..75b55990 100644 --- a/annofabapi/generated_api.py +++ b/annofabapi/generated_api.py @@ -596,7 +596,7 @@ def put_input_data(self, project_id: str, input_data_id: str, request_body: Opti authorizations: ProjectOwner - 入力データを作成または更新します。 Annofabにファイルをアップロードして入力データを作成する場合は、事前に[createTempPath](#operation/createTempPath) APIを実行してください。 ### 画像のリサイズ Annofabにアップロードした画像は、自動的に「長辺4096px以内」になるよう縮小されます。 アノテーションの座標値は、縮小前の画像サイズに対応する値に復元されます。 ### ZIPファイルで入力データをまとめて作成する 複数のファイルをZIPで圧縮してAnnofabにアップロードすると、入力データをまとめて作成できます。 パスパラメータの`input_data_id`は無視されるため、任意の値を指定してください。 リクエストボディの`input_data_name`には、入力データ名のプレフィックスを指定してください。 ZIPファイルを入力データとして登録すると、バックグラウンドジョブが登録されます。ジョブは [getProjectJob](#operation/getProjectJob) APIで確認できます（ジョブ種別は`gen-inputs`）。 ZIPファイルでの入力データ登録には以下の制限があります。 * アップロードできるZIPファイルのサイズは、最大5GBです。 * ファイル名の文字コードはUTF-8エンコーディングのみ対応しています。 #### 画像ファイル・動画ファイルから入力データを作成する 画像ファイル・動画ファイルを圧縮したZIPファイルをアップロードすることで、入力データとして登録できます。 なお、ZIPファイルに次のようなファイルが含まれていた場合、該当ファイルは入力データとして登録されません。 * プロジェクトがサポートしていないファイル * 画像プロジェクトの場合：jpeg, png, gif以外のファイル * 動画プロジェクトの場合：m3u8, ts, mp4, webm, ogg以外のファイル * ファイル名が`.`（ドット）から始まるファイル * フォルダ名が`.`（ドット）から始まるフォルダ以下のファイル 以下に、画像ファイルを登録する際のサンプルを記載します。 ``` foo.zip/ ├── image1.jpg ├── image2.jpg ``` このフォルダ構成のZIPファイルをアップロードして、リクエストボディの`input_data_name`に`bar.zip`を指定した場合、入力データ名が`bar.zip/image1.jpg`,`bar.zip/image2.jpg`の2つの入力データが生成されます。 #### ストリーミング形式の動画を入力データとして登録する ストリーミング形式の動画をAnnofabにアップロードして、入力データとして登録できます。 ただし、ZIPで圧縮する必要があります。ZIPファイルには、m3u8ファイルとtsファイルの両方を含めてください。 m3u8ファイルに記述された相対パスでtsファイルは、参照可能である必要があります。 以下に、フォルダ構成のサンプルを記載します。 ``` hoge.zip/ ├── hoge.ts ├── fuga/ │   ├── foo.m3u8 (hoge.ts, fuga/foo1.ts, fuga/foo2.tsを参照) │   ├── foo1.ts │   ├── foo2.ts │   └── lib ├── piyo1/ │   ├── piyo2 │   │   ├── bar.ts │   ├── bar.m3u8 (hoge.ts, piyo1/piyo2/bar.tsを参照) ``` #### 3次元点群の入力データを作成する KITTI形式、およびAnnofab 点群形式（KITTIベース）でのデータ登録に対応しています。 ZIPファイルの形式など、詳細は[Annofabのユーザーマニュアル](https://annofab.readme.io/docs)に記載予定です。 ### 注意事項 * `input_data_path`のスキーマが`https`の場合、`input_data_name`もしくは`input_data_path`の末尾にファイルの拡張子を含むようにしてください。 Annofabは拡張子からファイル形式を識別します。`input_data_name`と`input_data_path`の両方に拡張子が含まれている場合は、`input_data_name`の拡張子がファイル形式の識別に使われます。 + 入力データを作成または更新します。 Annofabにファイルをアップロードして入力データを作成する場合は、事前に[createTempPath](#operation/createTempPath) APIを実行してください。 ### 画像のリサイズ Annofabにアップロードした画像は、自動的に「長辺4096px以内」になるよう縮小されます。 アノテーションの座標値は、縮小前の画像サイズに対応する値に復元されます。 ### ZIPファイルで入力データをまとめて作成する 複数のファイルをZIPで圧縮してAnnofabにアップロードすると、入力データをまとめて作成できます。 パスパラメータの`input_data_id`は無視されるため、任意の値を指定してください。 リクエストボディの`input_data_name`には、入力データ名のプレフィックスを指定してください。 ZIPファイルを入力データとして登録すると、バックグラウンドジョブが登録されます。ジョブは [getProjectJob](#operation/getProjectJob) APIで確認できます（ジョブ種別は`gen-inputs`）。 ZIPファイルでの入力データ登録には以下の制限があります。 * アップロードできるZIPファイルのサイズは、最大5GBです。 * ファイル名の文字コードはUTF-8エンコーディングのみ対応しています。 #### 画像ファイル・動画ファイルから入力データを作成する 画像ファイル・動画ファイルを圧縮したZIPファイルをアップロードすることで、入力データとして登録できます。 なお、ZIPファイルに次のようなファイルが含まれていた場合、該当ファイルは入力データとして登録されません。 * プロジェクトがサポートしていないファイル * 画像プロジェクトの場合：jpeg, png, gif以外のファイル * 動画プロジェクトの場合：m3u8, ts, mp4, webm, ogg以外のファイル * ファイル名が`.`（ドット）から始まるファイル * フォルダ名が`.`（ドット）から始まるフォルダ以下のファイル 以下に、画像ファイルを登録する際のサンプルを記載します。 ``` foo.zip/ ├── image1.jpg ├── image2.jpg ``` このフォルダ構成のZIPファイルをアップロードして、リクエストボディの`input_data_name`に`bar.zip`を指定した場合、入力データ名が`bar.zip/image1.jpg`,`bar.zip/image2.jpg`の2つの入力データが生成されます。 #### ストリーミング形式の動画を入力データとして登録する ストリーミング形式の動画をAnnofabにアップロードして、入力データとして登録できます。 ただし、ZIPで圧縮する必要があります。ZIPファイルには、m3u8ファイルとtsファイルの両方を含めてください。 m3u8ファイルに記述された相対パスでtsファイルは、参照可能である必要があります。 以下に、フォルダ構成のサンプルを記載します。 ``` hoge.zip/ ├── hoge.ts ├── fuga/ │   ├── foo.m3u8 (hoge.ts, fuga/foo1.ts, fuga/foo2.tsを参照) │   ├── foo1.ts │   ├── foo2.ts │   └── lib ├── piyo1/ │   ├── piyo2 │   │   ├── bar.ts │   ├── bar.m3u8 (hoge.ts, piyo1/piyo2/bar.tsを参照) ``` #### 3次元点群の入力データを作成する KITTI形式、およびAnnofab 点群形式（KITTIベース）でのデータ登録に対応しています。 ZIPファイルの形式など、詳細は[Annofabのユーザーマニュアル](https://annofab.readme.io/docs)に記載予定です。 ### 注意事項 * `input_data_path`のURLスキームが`https`の場合、`input_data_name`もしくは`input_data_path`の末尾にファイルの拡張子を含むようにしてください。 Annofabは拡張子からファイル形式を識別します。`input_data_name`と`input_data_path`の両方に拡張子が含まれている場合は、`input_data_name`の拡張子がファイル形式の識別に使われます。 Args: project_id (str): プロジェクトID (required) diff --git a/annofabapi/models.py b/annofabapi/models.py index dc38be72..a29c5a4b 100644 --- a/annofabapi/models.py +++ b/annofabapi/models.py @@ -2193,6 +2193,8 @@ class CommentType(Enum): * new_password: str +* is_reset_mfa: bool + MFA設定をリセットするか。trueの場合にリセットする。 """ @@ -2804,7 +2806,7 @@ class GraphType(Enum): * input_data_name: str 入力データ名 * input_data_path: str - 入力データの実体が保存されたパスです。 s3スキーマまたはhttpsスキーマのみサポートしています。 + 入力データの実体が保存されたURLです。 URLスキームが s3 もしくは https であるもののみをサポートしています。 * url: str システム内部用のプロパティ * etag: str @@ -2863,7 +2865,7 @@ class InputDataOrder(Enum): * input_data_name: str 入力データ名。ZIPファイルをアップロードする際は、入力データ名のプレフィックスを指定してください。 * input_data_path: str - 入力データの実体が存在するURLです。 Annofabにファイルをアップロードして入力データを作成する場合は、[createTempPath](#operation/createTempPath) APIで取得した`path`を指定してください。 入力データの実体が[プライベートストレージ](/docs/faq/#prst9c)に存在する場合は、S3スキーマまたはHTTPSスキーマのURLを指定してください。 S3プライベートストレージに存在するファイルを入力データとして登録する場合は、事前に[認可の設定](/docs/faq/#m0b240)が必要です。 + 入力データの実体が存在するURLです。 Annofabにファイルをアップロードして入力データを作成する場合は、[createTempPath](#operation/createTempPath) APIで取得した`path`を指定してください。 入力データの実体が[プライベートストレージ](/docs/faq/#prst9c)に存在する場合は、スキームが s3 または https であるURLを指定してください。 S3プライベートストレージに存在するファイルを入力データとして登録する場合は、事前に[認可の設定](/docs/faq/#m0b240)が必要です。 * last_updated_datetime: str 新規作成時は未指定、更新時は必須（更新前の日時） * sign_required: bool @@ -3517,6 +3519,8 @@ class Lang(Enum): Kyes of Dict +* user_id: str + ユーザーID。[値の制約についてはこちら。](#section/API-Convention/APIID) * mfa_code: str MFAコード。Time-based One-time Password (TOTP) のみ対応している * session: str @@ -3632,6 +3636,8 @@ class Lang(Enum): * enabled: bool MFAが有効か (trueの場合に有効) +* is_updatable: bool + MFA設定を更新可能か (falseの場合、MFA設定の更新不可)。「Sign in with Google」でログインしたユーザーがAPIを実行した場合falseとなる。 """ @@ -5339,7 +5345,7 @@ class ProjectStatus(Enum): * supplementary_data_name: str 補助情報の名前 * supplementary_data_path: str - 補助情報の実体が存在するパスです。 s3スキーマまたはhttpsスキーマのみサポートしています。 + 補助情報の実体が存在するURLです。 URLスキームが s3 もしくは https であるもののみをサポートしています。 * url: str システム内部用のプロパティ * etag: str @@ -5362,7 +5368,7 @@ class ProjectStatus(Enum): * supplementary_data_name: str 補助情報の名前 * supplementary_data_path: str - 補助情報の実体が存在するURLです。 補助情報の実体をAnnofabにアップロードする場合は、[createTempPath](#operation/createTempPath) APIで取得した`path`を指定してください。 補助情報の実体が[プライベートストレージ](/docs/faq/#prst9c)に存在する場合は、S3スキーマまたはHTTPSスキーマのURLを指定してください。 補助情報の実体が、S3プライベートストレージに存在するファイルを補助情報として登録する場合は、[事前に認可の設定](/docs/faq/#m0b240)が必要です。 + 補助情報の実体が存在するURLです。 補助情報の実体をAnnofabにアップロードする場合は、[createTempPath](#operation/createTempPath) APIで取得した`path`を指定してください。 補助情報の実体が[プライベートストレージ](/docs/faq/#prst9c)に存在する場合は、スキームが s3 または https であるURLを指定してください。 補助情報の実体が、S3プライベートストレージに存在するファイルを補助情報として登録する場合は、[事前に認可の設定](/docs/faq/#m0b240)が必要です。 * supplementary_data_type: SupplementaryDataType * supplementary_data_number: int diff --git a/generate/swagger/swagger-api-components.yaml b/generate/swagger/swagger-api-components.yaml index 46f6a5cd..ffe82c52 100644 --- a/generate/swagger/swagger-api-components.yaml +++ b/generate/swagger/swagger-api-components.yaml @@ -419,9 +419,12 @@ components: LoginRespondToAuthChallengeRequest: type: object required: + - user_id - mfa_code - session properties: + user_id: + $ref: "#/components/schemas/UserId" mfa_code: type: string description: MFAコード。Time-based One-time Password (TOTP) のみ対応している @@ -452,10 +455,15 @@ components: type: object required: - enabled + - is_updatable properties: enabled: type: boolean description: MFAが有効か (trueの場合に有効) + is_updatable: + type: boolean + description: | + MFA設定を更新可能か (falseの場合、MFA設定の更新不可)。「Sign in with Google」でログインしたユーザーがAPIを実行した場合falseとなる。 Token: type: object required: @@ -705,6 +713,10 @@ components: type: string new_password: type: string + is_reset_mfa: + type: boolean + default: false + description: MFA設定をリセットするか。trueの場合にリセットする。 ResetEmailRequest: type: object required: @@ -4868,8 +4880,8 @@ components: type: string example: "s3://ANNOFAB-BUCKET/PATH/TO/INPUT_DATA" description: | - 入力データの実体が保存されたパスです。 - s3スキーマまたはhttpsスキーマのみサポートしています。 + 入力データの実体が保存されたURLです。 + URLスキームが s3 もしくは https であるもののみをサポートしています。 url: type: string description: システム内部用のプロパティ @@ -4984,7 +4996,7 @@ components: 入力データの実体が存在するURLです。 Annofabにファイルをアップロードして入力データを作成する場合は、[createTempPath](#operation/createTempPath) APIで取得した`path`を指定してください。 - 入力データの実体が[プライベートストレージ](/docs/faq/#prst9c)に存在する場合は、S3スキーマまたはHTTPSスキーマのURLを指定してください。 + 入力データの実体が[プライベートストレージ](/docs/faq/#prst9c)に存在する場合は、スキームが s3 または https であるURLを指定してください。 S3プライベートストレージに存在するファイルを入力データとして登録する場合は、事前に[認可の設定](/docs/faq/#m0b240)が必要です。 last_updated_datetime: $ref: "#/components/schemas/LastUpdatedDatetime" @@ -5035,8 +5047,8 @@ components: type: string example: "s3://ANNOFAB-BUCKET/PATH/TO/INPUT_DATA" description: | - 補助情報の実体が存在するパスです。 - s3スキーマまたはhttpsスキーマのみサポートしています。 + 補助情報の実体が存在するURLです。 + URLスキームが s3 もしくは https であるもののみをサポートしています。 url: type: string format: uri @@ -5085,7 +5097,7 @@ components: 補助情報の実体が存在するURLです。 補助情報の実体をAnnofabにアップロードする場合は、[createTempPath](#operation/createTempPath) APIで取得した`path`を指定してください。 - 補助情報の実体が[プライベートストレージ](/docs/faq/#prst9c)に存在する場合は、S3スキーマまたはHTTPSスキーマのURLを指定してください。 + 補助情報の実体が[プライベートストレージ](/docs/faq/#prst9c)に存在する場合は、スキームが s3 または https であるURLを指定してください。 補助情報の実体が、S3プライベートストレージに存在するファイルを補助情報として登録する場合は、[事前に認可の設定](/docs/faq/#m0b240)が必要です。 supplementary_data_type: diff --git a/generate/swagger/swagger.v2.yaml b/generate/swagger/swagger.v2.yaml index 65e564b2..262550ad 100644 --- a/generate/swagger/swagger.v2.yaml +++ b/generate/swagger/swagger.v2.yaml @@ -115,7 +115,7 @@ info: 上記例 `account_id_count` は、タスクのフィールド `account_id` でタスクを分類したところ「`account_id` が `c5eee002` であるタスクが9件、`9f110e48` であるタスクが5件、`b25dfeb3` であるタスクが1件」だったという結果を表しています。 - version: 0.183.0 + version: 0.187.2 title: Annofab Web API x-logo: url: "https://annofab.com/resource/images/logo_landscape.png" diff --git a/generate/swagger/swagger.yaml b/generate/swagger/swagger.yaml index e21df5da..881af809 100644 --- a/generate/swagger/swagger.yaml +++ b/generate/swagger/swagger.yaml @@ -116,7 +116,7 @@ info: 上記例 `account_id_count` は、タスクのフィールド `account_id` でタスクを分類したところ「`account_id` が `c5eee002` であるタスクが9件、`9f110e48` であるタスクが5件、`b25dfeb3` であるタスクが1件」だったという結果を表しています。 また、AggregationResultの集約の件数は、合計で10000件以下に制限されており、それを超える件数がある場合は上位10000件が取得されます。もし、省略された部分を取得したい場合は、検索条件を縛って結果に上る集約の数を減らしてください。 - version: 0.183.0 + version: 0.187.2 title: Annofab Web API x-logo: url: "https://annofab.com/resource/images/logo_landscape.png" @@ -5502,7 +5502,7 @@ paths: ZIPファイルの形式など、詳細は[Annofabのユーザーマニュアル](https://annofab.readme.io/docs)に記載予定です。 ### 注意事項 - * `input_data_path`のスキーマが`https`の場合、`input_data_name`もしくは`input_data_path`の末尾にファイルの拡張子を含むようにしてください。 + * `input_data_path`のURLスキームが`https`の場合、`input_data_name`もしくは`input_data_path`の末尾にファイルの拡張子を含むようにしてください。 Annofabは拡張子からファイル形式を識別します。`input_data_name`と`input_data_path`の両方に拡張子が含まれている場合は、`input_data_name`の拡張子がファイル形式の識別に使われます。 security: - ProjectOwner: []