Merge branch 'update-schema-for-transcriptions-endpoint' into 'master'

Update schema for transcriptions endpoint

See merge request !340

arkindex/documents/serializers/elements.py

@@ -394,7 +394,7 @@ class EntityCreateSerializer(EntityLightSerializer):
     Serialize an entity with a possible parents and children
     """
     corpus = serializers.PrimaryKeyRelatedField(queryset=Corpus.objects.none())
-    metas = serializers.HStoreField(child=serializers.CharField())
+    metas = serializers.HStoreField(child=serializers.CharField(), required=False)
     children = EntityLinkSerializer(many=True, read_only=True)
     parents = EntityLinkSerializer(many=True, read_only=True)
 

openapi/patch.yml

@@ -157,6 +157,26 @@ paths:
       security: []
       tags:
         - elements
+      parameters:
+        - description: Element id
+          in: path
+          name: id
+          required: true
+          schema:
+           type: string
+        - description: A page number within the paginated result set.
+          in: query
+          name: page
+          required: false
+          schema:
+            type: integer
+        - description: Transcription type filter
+          in: query
+          name: type
+          required: false
+          schema:
+            type: string
+            enum: ["page", "paragraph", "line", "word", "character"]
   /api/v1/elements/:
     get:
       operationId: ListElements
@@ -209,13 +229,18 @@ paths:
       security: []
       tags:
         - elements
+  /api/v1/entity/search/:
+    get:
+      operationId: SearchEntities
+      tags:
+        - elements
   /api/v1/entity/{id}/elements/:
     get:
       operationId: ListEntityElements
       description: Get all elements that have a link with the entity
       security: []
       tags:
-        - elements   
+        - elements
   /api/v1/image/:
     post:
       operationId: CreateImage