Improvments of the producer API callbacks

[nonrtric.git] / enrichment-coordinator-service / docs / api.json

diff --git a/enrichment-coordinator-service/docs/api.json b/enrichment-coordinator-service/docs/api.json
index d5cbad5..a8df3c7 100644 (file)
--- a/enrichment-coordinator-service/docs/api.json
+++ b/enrichment-coordinator-service/docs/api.json
@@ -1,21 +1,27 @@
 {
     "basePath": "/",
     "paths": {
-        "/producer_simulator/supervision": {"get": {
-            "summary": "Producer supervision",
+        "/producer_simulator/ei_job": {"post": {
+            "summary": "Callback for EI job creation",
             "deprecated": false,
             "produces": ["application/json"],
-            "operationId": "producerSupervisionUsingGET",
+            "operationId": "jobCreatedCallbackUsingPOST",
             "responses": {
-                "200": {
-                    "schema": {"type": "string"},
-                    "description": "OK"
-                },
+                "200": {"description": "OK"},
+                "201": {"description": "Created"},
                 "401": {"description": "Unauthorized"},
                 "403": {"description": "Forbidden"},
                 "404": {"description": "Not Found"}
             },
-            "tags": ["Producer Callbacks"]
+            "parameters": [{
+                "schema": {"$ref": "#/definitions/producer_ei_job_request"},
+                "in": "body",
+                "name": "request",
+                "description": "request",
+                "required": true
+            }],
+            "tags": ["Producer Callbacks"],
+            "consumes": ["application/json"]
         }},
         "/A1-EI/v1/eitypes/{eiTypeId}": {"get": {
             "summary": "Individual EI type",
@@ -112,28 +118,6 @@
             },
             "tags": ["A1-EI (enrichment information)"]
         }},
-        "/producer_simulator/job_deleted": {"post": {
-            "summary": "Callback for EI job deletion",
-            "deprecated": false,
-            "produces": ["application/json"],
-            "operationId": "jobDeletedCallbackUsingPOST",
-            "responses": {
-                "200": {"description": "OK"},
-                "201": {"description": "Created"},
-                "401": {"description": "Unauthorized"},
-                "403": {"description": "Forbidden"},
-                "404": {"description": "Not Found"}
-            },
-            "parameters": [{
-                "schema": {"$ref": "#/definitions/producer_ei_job_request"},
-                "in": "body",
-                "name": "request",
-                "description": "request",
-                "required": true
-            }],
-            "tags": ["Producer Callbacks"],
-            "consumes": ["application/json"]
-        }},
         "/ei-producer/v1/eiproducers/{eiProducerId}/status": {"get": {
             "summary": "EI producer status",
             "deprecated": false,
@@ -160,6 +144,26 @@
             }],
             "tags": ["Enrichment Data Producer API"]
         }},
+        "/producer_simulator/ei_job/{eiJobId}": {"delete": {
+            "summary": "Callback for EI job deletion",
+            "deprecated": false,
+            "produces": ["application/json"],
+            "operationId": "jobDeletedCallbackUsingDELETE",
+            "responses": {
+                "200": {"description": "OK"},
+                "401": {"description": "Unauthorized"},
+                "204": {"description": "No Content"},
+                "403": {"description": "Forbidden"}
+            },
+            "parameters": [{
+                "in": "path",
+                "name": "eiJobId",
+                "description": "eiJobId",
+                "type": "string",
+                "required": true
+            }],
+            "tags": ["Producer Callbacks"]
+        }},
         "/ei-producer/v1/eiproducers": {"get": {
             "summary": "EI producer identifiers",
             "deprecated": false,
@@ -390,6 +394,22 @@
                 "consumes": ["application/json"]
             }
         },
+        "/producer_simulator/health_check": {"get": {
+            "summary": "Producer supervision",
+            "deprecated": false,
+            "produces": ["application/json"],
+            "operationId": "producerSupervisionUsingGET",
+            "responses": {
+                "200": {
+                    "schema": {"type": "string"},
+                    "description": "OK"
+                },
+                "401": {"description": "Unauthorized"},
+                "403": {"description": "Forbidden"},
+                "404": {"description": "Not Found"}
+            },
+            "tags": ["Producer Callbacks"]
+        }},
         "/ei-producer/v1/eiproducers/{eiProducerId}/eijobs": {"get": {
             "summary": "EI job definitions",
             "deprecated": false,
@@ -486,31 +506,9 @@
                 "required": true
             }],
             "tags": ["A1-EI (enrichment information)"]
-        }},
-        "/producer_simulator/job_created": {"post": {
-            "summary": "Callback for EI job creation",
-            "deprecated": false,
-            "produces": ["application/json"],
-            "operationId": "jobCreatedCallbackUsingPOST",
-            "responses": {
-                "200": {"description": "OK"},
-                "201": {"description": "Created"},
-                "401": {"description": "Unauthorized"},
-                "403": {"description": "Forbidden"},
-                "404": {"description": "Not Found"}
-            },
-            "parameters": [{
-                "schema": {"$ref": "#/definitions/producer_ei_job_request"},
-                "in": "body",
-                "name": "request",
-                "description": "request",
-                "required": true
-            }],
-            "tags": ["Producer Callbacks"],
-            "consumes": ["application/json"]
         }}
     },
-    "host": "localhost:38499",
+    "host": "localhost:41549",
     "definitions": {
         "producer_ei_job_request": {
             "description": "The body of the EI producer callbacks for EI job creation and deletion",
@@ -607,8 +605,7 @@
             "type": "object",
             "title": "producer_registration_info",
             "required": [
-                "ei_job_creation_callback_url",
-                "ei_job_deletion_callback_url",
+                "ei_job_callback_url",
                 "ei_producer_supervision_callback_url",
                 "supported_ei_types"
             ],
@@ -618,17 +615,13 @@
                     "type": "array",
                     "items": {"$ref": "#/definitions/producer_ei_type_registration_info"}
                 },
-                "ei_job_creation_callback_url": {
-                    "description": "callback for job creation",
-                    "type": "string"
-                },
-                "ei_job_deletion_callback_url": {
-                    "description": "callback for job deletion",
-                    "type": "string"
-                },
                 "ei_producer_supervision_callback_url": {
                     "description": "callback for producer supervision",
                     "type": "string"
+                },
+                "ei_job_callback_url": {
+                    "description": "callback for EI job",
+                    "type": "string"
                 }
             }
         },