Skip to content

Commit

Permalink
AnnoFab v0.135.0対応 (#415)
Browse files Browse the repository at this point in the history
* update swagger

* update python

* version up
  • Loading branch information
yuji38kwmt committed Feb 16, 2022
1 parent 0ec7975 commit 48d5ae2
Show file tree
Hide file tree
Showing 8 changed files with 18 additions and 5 deletions.
2 changes: 1 addition & 1 deletion annofabapi/__version__.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "0.53.0"
__version__ = "0.54.0"
3 changes: 3 additions & 0 deletions annofabapi/dataclass/project.py
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,9 @@ class ProjectConfiguration(DataClassJsonMixin):
editor_version: Optional[str]
"""標準アノテーションエディタのバージョン。 * `stable` * 安定版。通常はこちらを利用してください。 * `preview` * 最新版。新機能やUI変更の先行リリース版。 プロジェクト更新時に未指定の場合は `stable` が指定されたものとみなします。 """

use_beginner_navigation: Optional[bool]
"""true の場合、プロジェクトの画面でナビゲーションUIを表示します(ログインユーザーがプロジェクトオーナーの場合のみ)。 未指定の場合、 false が指定されたものとして扱います。 """


@dataclass
class Project(DataClassJsonMixin):
Expand Down
2 changes: 1 addition & 1 deletion annofabapi/generated_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -831,7 +831,7 @@ def put_input_data(
authorizations: ProjectOwner
入力データ(画像プロジェクトなら画像、動画プロジェクトなら動画や時系列データ)を登録します。 ファイルの登録には、[アップロード用一時データ保存先作成API](#operation/createTempPath) を組み合わせて使用します。 ## ZIPでまとめてアップロード 画像プロジェクトの場合、複数の画像ファイルをZIPでまとめてアップロードできます。ZIPは最大5GB、UTF-8エンコーディングのみ対応しています。<br> アノテーション作業生産性を高めるため、画像は「長辺4096px以内」かつ「4MB以内」になるよう縮小されます。<br> 作成されるアノテーションは、元の解像度でつけた場合相当に自動で復元されます。 動画プロジェクトの場合、複数の動画ファイルをZIPでまとめてアップロードできます。ZIPは最大5GB、UTF-8エンコーディングのみ対応しています。<br> また、複数のストリーミング形式の動画をアップロードすることもできます。<br> この場合はZIP形式必須で、同一のZIPファイル内にm3u8ファイルとtsファイルを両方含めてください。<br> なお、このm3u8ファイルに記述された相対パスでtsファイルが参照可能である必要があります。 ZIPファイルを登録するとバックグラウンドジョブが登録されます。ジョブは [getProjectJob](#operation/getProjectJob) APIで確認できます(ジョブ種別は`gen-inputs`)。 ### ディレクトリ例 ``` hoge.zip/ hoge.ts fuga/ foo.m3u8(hoge.ts, fuga/foo1.ts, fuga/foo2.tsを参照) foo1.ts foo2.ts piyo1/ piyo2/ bar.ts bar.m3u8(hoge.ts, piyo1/piyo2/bar.tsを参照) ``` ## 注意事項 * `input_data_path` のスキーマが `https` の場合、 `input_data_name` もしくは `input_data_path` の末尾にファイルの拡張子を含むようにしてください * `input_data_name` の値が優先されます * `input_data_path` のスキーマが `s3` かつ入力データがtsファイルの場合、 `input_data_name` もしくは `input_data_path` の末尾にファイルの拡張子を含むようにしてください * `input_data_name` の値が優先されます * ZIPでまとめてアップロード時、ZIPファイル内の次の名前のファイルは入力データとして登録されません * `Thumbs.db` * `__MACOSX` * `.DS_Store` * 上記以外の、ファイル名先頭が `.`(ドット)で始まるファイル * ZIPでまとめてアップロード時、ZIPファイル内の `.`(ドット)から始まるフォルダ以下のファイルは入力データとして登録されません
入力データ(画像プロジェクトなら画像、動画プロジェクトなら動画や時系列データ)を登録します。 ファイルの登録には、[アップロード用一時データ保存先作成API](#operation/createTempPath) を組み合わせて使用します。 ## ZIPでまとめてアップロード 画像プロジェクトの場合、複数の画像ファイルをZIPでまとめてアップロードできます。ZIPは最大5GB、UTF-8エンコーディングのみ対応しています。<br> アノテーション作業生産性を高めるため、画像は「長辺4096px以内」かつ「4MB以内」になるよう縮小されます。<br> 作成されるアノテーションは、元の解像度でつけた場合相当に自動で復元されます。 動画プロジェクトの場合、複数の動画ファイルをZIPでまとめてアップロードできます。ZIPは最大5GB、UTF-8エンコーディングのみ対応しています。<br> また、複数のストリーミング形式の動画をアップロードすることもできます。<br> この場合はZIP形式必須で、同一のZIPファイル内にm3u8ファイルとtsファイルを両方含めてください。<br> なお、このm3u8ファイルに記述された相対パスでtsファイルが参照可能である必要があります。 ZIPファイルを登録するとバックグラウンドジョブが登録されます。ジョブは [getProjectJob](#operation/getProjectJob) APIで確認できます(ジョブ種別は`gen-inputs`)。 ### ディレクトリ例 ``` hoge.zip/ hoge.ts fuga/ foo.m3u8(hoge.ts, fuga/foo1.ts, fuga/foo2.tsを参照) foo1.ts foo2.ts piyo1/ piyo2/ bar.ts bar.m3u8(hoge.ts, piyo1/piyo2/bar.tsを参照) ``` ## 注意事項 * `input_data_path` のスキーマが `https` の場合、 `input_data_name` もしくは `input_data_path` の末尾にファイルの拡張子を含むようにしてください * `input_data_name` の値が優先されます * `input_data_path` のスキーマが `s3` かつ入力データがtsファイルの場合、 `input_data_name` もしくは `input_data_path` の末尾にファイルの拡張子を含むようにしてください * `input_data_name` の値が優先されます * ZIPでまとめてアップロード時、ZIPファイル内の次の名前のファイルは入力データとして登録されません * `Thumbs.db` * `__MACOSX` * `.DS_Store` * `desktop.ini` * 上記以外の、ファイル名先頭が `.`(ドット)で始まるファイル * ZIPでまとめてアップロード時、ZIPファイル内の `.`(ドット)から始まるフォルダ以下のファイルは入力データとして登録されません
Args:
project_id (str): プロジェクトID (required)
Expand Down
2 changes: 2 additions & 0 deletions annofabapi/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -3226,6 +3226,8 @@ class PricePlan(Enum):
プラグインID。[値の制約についてはこちら。](#section/API-Convention/APIID)
* editor_version: str
標準アノテーションエディタのバージョン。 * `stable` * 安定版。通常はこちらを利用してください。 * `preview` * 最新版。新機能やUI変更の先行リリース版。 プロジェクト更新時に未指定の場合は `stable` が指定されたものとみなします。
* use_beginner_navigation: bool
true の場合、プロジェクトの画面でナビゲーションUIを表示します(ログインユーザーがプロジェクトオーナーの場合のみ)。 未指定の場合、 false が指定されたものとして扱います。
"""

Expand Down
7 changes: 7 additions & 0 deletions generate/swagger/swagger-api-components.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1270,6 +1270,13 @@ components:
* 最新版。新機能やUI変更の先行リリース版。
プロジェクト更新時に未指定の場合は `stable` が指定されたものとみなします。
use_beginner_navigation:
type: boolean
default: false
description: |
true の場合、プロジェクトの画面でナビゲーションUIを表示します(ログインユーザーがプロジェクトオーナーの場合のみ)。
未指定の場合、 false が指定されたものとして扱います。
ProjectSummary:
type: object
properties:
Expand Down
2 changes: 1 addition & 1 deletion generate/swagger/swagger.v2.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ info:
上記例 `account_id_count` は、タスクのフィールド `account_id` でタスクを分類したところ「`account_id` が `c5eee002` であるタスクが9件、`9f110e48` であるタスクが5件、`b25dfeb3` であるタスクが1件」だったという結果を表しています。
version: 0.132.0
version: 0.135.0
title: AnnoFab Web API
x-logo:
url: "https://annofab.com/resource/images/logo_landscape.png"
Expand Down
3 changes: 2 additions & 1 deletion generate/swagger/swagger.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ info:
上記例 `account_id_count` は、タスクのフィールド `account_id` でタスクを分類したところ「`account_id` が `c5eee002` であるタスクが9件、`9f110e48` であるタスクが5件、`b25dfeb3` であるタスクが1件」だったという結果を表しています。
また、AggregationResultの集約の件数は、合計で10000件以下に制限されており、それを超える件数がある場合は上位10000件が取得されます。もし、省略された部分を取得したい場合は、検索条件を縛って結果に上る集約の数を減らしてください。
version: 0.132.0
version: 0.135.0
title: AnnoFab Web API
x-logo:
url: "https://annofab.com/resource/images/logo_landscape.png"
Expand Down Expand Up @@ -5359,6 +5359,7 @@ paths:
* `Thumbs.db`
* `__MACOSX`
* `.DS_Store`
* `desktop.ini`
* 上記以外の、ファイル名先頭が `.`(ドット)で始まるファイル
* ZIPでまとめてアップロード時、ZIPファイル内の `.`(ドット)から始まるフォルダ以下のファイルは入力データとして登録されません
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "annofabapi"
version = "0.53.0"
version = "0.54.0"
description = "Python Clinet Library of AnnoFab WebAPI (https://annofab.com/docs/api/)"
authors = ["yuji38kwmt"]
license = "MIT"
Expand Down

0 comments on commit 48d5ae2

Please sign in to comment.