Minor documentation improvements

[nonrtric.git] / enrichment-coordinator-service / api / ecs-api.yaml

diff --git a/enrichment-coordinator-service/api/ecs-api.yaml b/enrichment-coordinator-service/api/ecs-api.yaml
index 3dd53b6..d1aa187 100644 (file)
--- a/enrichment-coordinator-service/api/ecs-api.yaml
+++ b/enrichment-coordinator-service/api/ecs-api.yaml
@@ -182,7 +182,7 @@ paths:
           type: string
       responses:
         200:
-          description: EI jobs
+          description: EI producer status
           content:
             application/json:
               schema:
@@ -313,14 +313,17 @@ paths:
         required: true
       responses:
         200:
-          description: OK
+          description: Type updated
+          content: {}
+        201:
+          description: Type created
+          content: {}
+        400:
+          description: Bad request
           content:
             application/json:
               schema:
-                type: object
-        201:
-          description: Created
-          content: {}
+                $ref: '#/components/schemas/ProblemDetails'
         401:
           description: Unauthorized
           content: {}
@@ -511,7 +514,7 @@ paths:
           type: string
       responses:
         200:
-          description: EI jobs
+          description: EI producer
           content:
             application/json:
               schema:
@@ -636,7 +639,7 @@ paths:
           type: string
       responses:
         200:
-          description: EI jobs
+          description: EI producer
           content:
             application/json:
               schema:
@@ -745,6 +748,9 @@ components:
         ei_job_identity:
           type: string
           description: Idenitity of the EI job
+        last_updated:
+          type: string
+          description: The time when the job was last updated or created (ISO-8601)
         ei_job_data:
           type: object
           properties: {}
@@ -779,11 +785,10 @@ components:
         status:
           type: string
           description: status text
-    Mono«ResponseEntity«object»»:
-      title: Mono«ResponseEntity«object»»
-      type: object
     producer_ei_type_info:
       title: producer_ei_type_info
+      required:
+      - ei_job_data_schema
       type: object
       properties:
         ei_job_data_schema:
@@ -844,10 +849,6 @@ components:
           example: 404
       description: A problem detail to carry details in a HTTP response according
         to RFC 7807
-    Void:
-      title: Void
-      type: object
-      description: Void/empty
     EiJobStatusObject:
       title: EiJobStatusObject
       required: