Merge pull request #79 from kurusugawa-computer/feature/annofav-v0.65.0

Feature/annofav v0.65.0

Author: yuji38kwmt

.travis.yml

@@ -3,6 +3,7 @@ language: python
 python:
   - "3.6"
   - "3.7"
+  - "3.8"
 install:
   - pip install . flake8 mypy pylint pytest
 script:

README.md

@@ -154,13 +154,13 @@ for parser in iter_parser:
 
 # Simpleアノテーションzip内の1個のJSONファイルを読み込み
 with zipfile.ZipFile('simple-annotation.zip', 'r') as zip_file:
-    parser = SimpleAnnotationZipParser(zip_file, "task_id/input_data_name.json")
+    parser = SimpleAnnotationZipParser(zip_file, "task01/12345678-abcd-1234-abcd-1234abcd5678.json")
     simple_annotation = parser.parse()
     print(simple_annotation)
 
 # Simpleアノテーションzip内を展開したディレクトリ内の1個のJSONファイルを読み込み
-parser = SimpleAnnotationDirParser(Path("task_id/input_data_name.json"))
-simple_annotation = p.parse()
+parser = SimpleAnnotationDirParser(Path("task01/12345678-abcd-1234-abcd-1234abcd5678.json"))
+simple_annotation = parser.parse()
 print(simple_annotation)
 
 ```

annofabapi/__version__.py

@@ -1 +1 @@
-__version__ = '0.20.0'
+__version__ = '0.20.1'

annofabapi/generated_api.py

@@ -611,7 +611,7 @@ def create_temp_path(self, project_id: str, header_params: Optional[Dict[str, An
         authorizations: AllProjectMember
 
 
-        「複数の入力データを圧縮したZIPファイル」や「4MBを超える画像」などをAnnoFabに一時的に保存するための、URLと登録用データパスを発行します。  このAPIと他のAPIを以下に示すように使うことで、ZIPファイルなどをAFにアップロードできます。   1. 本APIを実行して、URLを取得する。   * `curl -X POST -H 'Content-Type: CONTENT_TYPE_HERE' 'https://annofab.com/api/v1/projects/（プロジェクトID）/create-temp-path` 2. 1で取得したURLに、一時保存したいファイルをPUTする。   * `curl -X PUT -H \"Content-Type: CONTENT_TYPE_HERE' --data-binary @/hoge.zip 'https://（発行されたURL）'` 3. 1で取得した登録用データパスを [入力データ登録API](#operation/putInputData)のリクエストボディ `input_data_path` に指定する。   * `curl -X PUT -H 'Content-Type: text/json\" -d '{\"input_data_name\":\"...\", \"input_data_path\":\"(登録用データパス)\" }' '/projects/{project_id}/inputs/{input_data_id}'`  ここで、1と2で `CONTENT_TYPE_HERE` は必ず一致しなければいけません。 ZIPファイルの場合は `application/zip` 、画像ファイルの場合は `image/png` など、適切な Content-Type を指定します。  登録するファイルはどのような内容であれ、アップロードから24時間経過すると削除されます。 したがって、ZIP圧縮した入力データを登録する場合は、URL発行から24時間以内に完了してください。 
+        「複数の入力データを圧縮したZIPファイル」や「4MBを超える画像」などをAnnoFabに一時的に保存するための、URLと登録用データパスを発行します。  このAPIと他のAPIを以下に示すように使うことで、ZIPファイルなどをAFにアップロードできます。   1. 本APIを実行して、URLを取得する。   * `curl -X POST -H 'Content-Type: CONTENT_TYPE_HERE' 'https://annofab.com/api/v1/projects/{project_id}/create-temp-path'` 2. 1で取得したURLに、一時保存したいファイルをPUTする。   * `curl -X PUT -H 'Content-Type: CONTENT_TYPE_HERE' --data-binary @/hoge.zip 'https://(発行されたURL)'` 3. 1で取得した登録用データパスを [入力データ登録API](#operation/putInputData)のリクエストボディ `input_data_path` に指定する。   * `curl -X PUT -H 'Content-Type: text/json' -d '{\"input_data_name\":\"(表示名)\", \"input_data_path\":\"(登録用データパス)\" }' 'https://annofab.com/api/v1/projects/{project_id}/inputs/{input_data_id}'`  ここで、1と2で `CONTENT_TYPE_HERE` は必ず一致しなければいけません。 ZIPファイルの場合は `application/zip` 、画像ファイルの場合は `image/png` など、適切な Content-Type を指定します。  登録するファイルはどのような内容であれ、アップロードから24時間経過すると削除されます。 したがって、ZIP圧縮した入力データを登録する場合は、URL発行から24時間以内に完了してください。 
 
         Args:
             project_id (str):  プロジェクトID (required)
@@ -2094,58 +2094,6 @@ def delete_task(self, project_id: str, task_id: str, **kwargs) -> Tuple[Any, req
         keyword_params: Dict[str, Any] = {}
         return self._request_wrapper(http_method, url_path, **keyword_params)
 
-    def get_histories_with_pro_id_tas_id_tas_his_id(self, project_id: str, task_id: str, task_history_id: str,
-                                                    **kwargs) -> Tuple[Any, requests.Response]:
-        """タスク履歴取得
-
-        .. deprecated:: X
-
-        authorizations: AllProjectMember
-
-
-
-        Args:
-            project_id (str):  プロジェクトID (required)
-            task_id (str):  タスクID (required)
-            task_history_id (str):  タスク履歴ID (required)
-
-        Returns:
-            Tuple[List[TaskHistory], requests.Response]
-
-
-        """
-        warnings.warn("deprecated", DeprecationWarning)
-        url_path = f'/projects/{project_id}/tasks/{task_id}/histories/{task_history_id}'
-        http_method = 'GET'
-        keyword_params: Dict[str, Any] = {}
-        return self._request_wrapper(http_method, url_path, **keyword_params)
-
-    def get_history_events_with_pro_id_tas_id(self, project_id: str, task_id: str,
-                                              **kwargs) -> Tuple[Any, requests.Response]:
-        """タスク履歴イベント取得
-
-        .. deprecated:: X
-
-        authorizations: AllProjectMember
-
-
-        作業時間を計算したタスク履歴ではなく、その元となったタスク履歴イベントを一括で取得します。 
-
-        Args:
-            project_id (str):  プロジェクトID (required)
-            task_id (str):  タスクID (required)
-
-        Returns:
-            Tuple[List[TaskHistoryEvent], requests.Response]
-
-
-        """
-        warnings.warn("deprecated", DeprecationWarning)
-        url_path = f'/projects/{project_id}/tasks/{task_id}/history-events'
-        http_method = 'GET'
-        keyword_params: Dict[str, Any] = {}
-        return self._request_wrapper(http_method, url_path, **keyword_params)
-
     def get_task(self, project_id: str, task_id: str, **kwargs) -> Tuple[Any, requests.Response]:
         """タスク取得
 
@@ -2257,29 +2205,6 @@ def get_tasks(self, project_id: str, query_params: Optional[Dict[str, Any]] = No
         }
         return self._request_wrapper(http_method, url_path, **keyword_params)
 
-    def get_tasks_inputs_with_pro_id(self, project_id: str, **kwargs) -> Tuple[Any, requests.Response]:
-        """【非推奨】タスク-入力データ一括取得
-
-        .. deprecated:: X
-
-        authorizations: AllProjectMember
-
-
-
-        Args:
-            project_id (str):  プロジェクトID (required)
-
-        Returns:
-            Tuple[TasksInputs, requests.Response]
-
-
-        """
-        warnings.warn("deprecated", DeprecationWarning)
-        url_path = f'/projects/{project_id}/tasks-inputs'
-        http_method = 'GET'
-        keyword_params: Dict[str, Any] = {}
-        return self._request_wrapper(http_method, url_path, **keyword_params)
-
     def initiate_tasks_generation(self, project_id: str, request_body: Optional[Any] = None,
                                   **kwargs) -> Tuple[Any, requests.Response]:
         """タスク一括作成

annofabapi/models.py

@@ -2711,7 +2711,7 @@ class ProjectStatus(Enum):
     
 * overview: str
     
-* status: str
+* status: ProjectStatus
     
 * input_data_type: InputDataType
     
@@ -3187,36 +3187,6 @@ class TaskStatus(Enum):
 * inputs: List[InputDataSummary]
     
 
-"""
-
-TasksInputs = Dict[str, Any]
-"""
-
-
-Kyes of Dict
-
-* project_id: str
-    プロジェクトID。[値の制約についてはこちら。](#section/API-Convention/APIID) 
-* tasks: List[TasksInputsTask]
-    
-
-"""
-
-TasksInputsTask = Dict[str, Any]
-"""
-
-
-Kyes of Dict
-
-* task_id: str
-    タスクID。[値の制約についてはこちら。](#section/API-Convention/APIID) 
-* phase: TaskPhase
-    
-* status: TaskStatus
-    
-* input_data_id_list: List[str]
-    
-
 """
 
 Token = Dict[str, Any]

generate/swagger/swagger-api-components.yaml

@@ -1169,7 +1169,7 @@
         overview:
           type: string
         status:
-          type: string
+          $ref: "#/components/schemas/ProjectStatus"
         input_data_type:
           $ref: "#/components/schemas/InputDataType"
         organization_name:
@@ -1802,28 +1802,6 @@
           type: array
           items:
             $ref: "#/components/schemas/InputDataId"
-    TasksInputs:
-      type: object
-      properties:
-        project_id:
-          $ref: "#/components/schemas/ProjectId"
-        tasks:
-          type: array
-          items:
-            $ref: "#/components/schemas/TasksInputsTask"
-    TasksInputsTask:
-      type: object
-      properties:
-        task_id:
-          $ref: "#/components/schemas/TaskId"
-        phase:
-          $ref: "#/components/schemas/TaskPhase"
-        status:
-          $ref: "#/components/schemas/TaskStatus"
-        input_data_id_list:
-          type: array
-          items:
-            $ref: "#/components/schemas/InputDataId"
     TaskGenerateRequest:
       type: object
       properties:

generate/swagger/swagger.v2.yaml

@@ -75,7 +75,7 @@ info:
     検査ID | プロジェクト内で一意
     WebhookID | プロジェクト内で一意
 
-  version: 0.64.1
+  version: 0.65.0
   title: AnnoFab Web API
   x-logo:
     url: "https://annofab.com/images/logo_landscape.png"
@@ -1737,7 +1737,7 @@ components:
         overview:
           type: string
         status:
-          type: string
+          $ref: "#/components/schemas/ProjectStatus"
         input_data_type:
           $ref: "#/components/schemas/InputDataType"
         organization_name:
@@ -2370,28 +2370,6 @@ components:
           type: array
           items:
             $ref: "#/components/schemas/InputDataId"
-    TasksInputs:
-      type: object
-      properties:
-        project_id:
-          $ref: "#/components/schemas/ProjectId"
-        tasks:
-          type: array
-          items:
-            $ref: "#/components/schemas/TasksInputsTask"
-    TasksInputsTask:
-      type: object
-      properties:
-        task_id:
-          $ref: "#/components/schemas/TaskId"
-        phase:
-          $ref: "#/components/schemas/TaskPhase"
-        status:
-          $ref: "#/components/schemas/TaskStatus"
-        input_data_id_list:
-          type: array
-          items:
-            $ref: "#/components/schemas/InputDataId"
     TaskGenerateRequest:
       type: object
       properties: