From 17a1eee1b105c4aadbfee0c9cbd89b4fd540da04 Mon Sep 17 00:00:00 2001
From: Valentin Rigal <rigal@teklia.com>
Date: Tue, 4 Jun 2019 07:29:08 +0000
Subject: [PATCH] Update schema for transcriptions and entity endpoints

---
 arkindex/schema.yml | 144 +++++++++++++++++++++++++++++++++++++-------
 1 file changed, 122 insertions(+), 22 deletions(-)

diff --git a/arkindex/schema.yml b/arkindex/schema.yml
index 34e03da..645a451 100644
--- a/arkindex/schema.yml
+++ b/arkindex/schema.yml
@@ -13,7 +13,7 @@ info:
     name: Teklia
     url: https://www.teklia.com/
   title: Arkindex API
-  version: 0.9.4
+  version: 0.9.5.dev0
 openapi: 3.0.2
 paths:
   /api/v1/act/{id}/:
@@ -153,6 +153,7 @@ paths:
                               enum:
                               - classifier
                               - recognizer
+                              - ner
                           required:
                           - type
                           - slug
@@ -531,6 +532,7 @@ paths:
                               enum:
                               - classifier
                               - recognizer
+                              - ner
                           required:
                           - type
                           - slug
@@ -991,7 +993,7 @@ paths:
       description: List all transcriptions for an element, filtered by type
       operationId: ListTranscriptions
       parameters:
-      - description: ''
+      - description: Element id
         in: path
         name: id
         required: true
@@ -1003,6 +1005,18 @@ paths:
         required: false
         schema:
           type: integer
+      - description: Transcription type filter
+        in: query
+        name: type
+        required: false
+        schema:
+          enum:
+          - page
+          - paragraph
+          - line
+          - word
+          - character
+          type: string
       responses:
         '200':
           content:
@@ -1028,6 +1042,7 @@ paths:
                         enum:
                         - classifier
                         - recognizer
+                        - ner
                     required:
                     - type
                     - slug
@@ -1280,6 +1295,7 @@ paths:
                               enum:
                               - classifier
                               - recognizer
+                              - ner
                           required:
                           - type
                           - slug
@@ -1414,9 +1430,7 @@ paths:
               properties:
                 corpus:
                   type: string
-                id:
-                  type: string
-                metadata:
+                metas:
                   type: string
                 name:
                   type: string
@@ -1431,7 +1445,6 @@ paths:
               - name
               - type
               - corpus
-              - metadata
         x-name: body
       responses:
         '200':
@@ -1516,8 +1529,9 @@ paths:
                   corpus:
                     type: string
                   id:
+                    readOnly: true
                     type: string
-                  metadata:
+                  metas:
                     type: string
                   name:
                     type: string
@@ -1606,7 +1620,6 @@ paths:
                 - name
                 - type
                 - corpus
-                - metadata
       tags:
       - elements
   /api/v1/entity/link/:
@@ -1652,6 +1665,41 @@ paths:
                 - role
       tags:
       - elements
+  /api/v1/entity/search/:
+    get:
+      operationId: SearchEntities
+      parameters:
+      - description: A page number within the paginated result set.
+        in: query
+        name: page
+        required: false
+        schema:
+          type: integer
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                properties:
+                  id:
+                    type: string
+                  metas:
+                    nullable: true
+                    type: string
+                  name:
+                    type: string
+                  type:
+                    enum:
+                    - person
+                    - location
+                    - subject
+                    - organization
+                    - misc
+                required:
+                - name
+                - type
+      tags:
+      - elements
   /api/v1/entity/{id}/:
     get:
       description: Get all information about entity
@@ -2846,13 +2894,39 @@ paths:
           application/json:
             schema:
               properties:
-                classifier:
-                  nullable: true
-                  type: string
                 files:
                   items:
                     type: string
                   type: array
+                ml_tools:
+                  items:
+                    properties:
+                      parents:
+                        items:
+                          properties:
+                            slug:
+                              type: string
+                            type:
+                              enum:
+                              - classifier
+                              - recognizer
+                              - ner
+                          required:
+                          - type
+                          - slug
+                        type: array
+                      slug:
+                        type: string
+                      type:
+                        enum:
+                        - classifier
+                        - recognizer
+                        - ner
+                    required:
+                    - type
+                    - slug
+                  nullable: true
+                  type: array
                 mode:
                   enum:
                   - images
@@ -2862,9 +2936,6 @@ paths:
                   enum:
                   - convert
                   - poppler
-                recognizer:
-                  nullable: true
-                  type: string
                 volume_id:
                   nullable: true
                   type: string
@@ -2880,13 +2951,39 @@ paths:
             application/json:
               schema:
                 properties:
-                  classifier:
-                    nullable: true
-                    type: string
                   files:
                     items:
                       type: string
                     type: array
+                  ml_tools:
+                    items:
+                      properties:
+                        parents:
+                          items:
+                            properties:
+                              slug:
+                                type: string
+                              type:
+                                enum:
+                                - classifier
+                                - recognizer
+                                - ner
+                            required:
+                            - type
+                            - slug
+                          type: array
+                        slug:
+                          type: string
+                        type:
+                          enum:
+                          - classifier
+                          - recognizer
+                          - ner
+                      required:
+                      - type
+                      - slug
+                    nullable: true
+                    type: array
                   mode:
                     enum:
                     - images
@@ -2896,9 +2993,6 @@ paths:
                     enum:
                     - convert
                     - poppler
-                  recognizer:
-                    nullable: true
-                    type: string
                   volume_id:
                     nullable: true
                     type: string
@@ -2948,12 +3042,13 @@ paths:
                     enum:
                     - classifier
                     - recognizer
+                    - ner
                   version:
                     type: string
                 required:
-                - name
-                - slug
                 - type
+                - slug
+                - name
                 - version
       security: []
       tags:
@@ -3884,6 +3979,7 @@ paths:
                               enum:
                               - classifier
                               - recognizer
+                              - ner
                           required:
                           - type
                           - slug
@@ -3979,6 +4075,7 @@ paths:
                               enum:
                               - classifier
                               - recognizer
+                              - ner
                           required:
                           - type
                           - slug
@@ -4117,6 +4214,7 @@ paths:
                               enum:
                               - classifier
                               - recognizer
+                              - ner
                           required:
                           - type
                           - slug
@@ -4209,6 +4307,7 @@ paths:
                                   enum:
                                   - classifier
                                   - recognizer
+                                  - ner
                               required:
                               - type
                               - slug
@@ -4304,6 +4403,7 @@ paths:
                                   enum:
                                   - classifier
                                   - recognizer
+                                  - ner
                               required:
                               - type
                               - slug
-- 
GitLab