X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=enrichment-coordinator-service%2Fdocs%2Fapi.json;h=a8df3c7c1c79116f44c422697c7d1902f73cf9cd;hb=647744d8ab625d28ea0ecda3e6741e23ba9b0bc7;hp=71f64db5a9131498a4a0a78fcfd104e8e33c2da8;hpb=b7311fbcbd77f615266a039613516adb9cea24f1;p=nonrtric.git diff --git a/enrichment-coordinator-service/docs/api.json b/enrichment-coordinator-service/docs/api.json index 71f64db5..a8df3c7c 100644 --- 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", @@ -43,6 +49,37 @@ }], "tags": ["A1-EI (enrichment information)"] }}, + "/consumer_simulator/eijobs/{eiJobId}/status": {"post": { + "summary": "Callback for EI job status", + "deprecated": false, + "produces": ["application/json"], + "operationId": "jobStatusCallbackUsingPOST", + "responses": { + "200": {"description": "OK"}, + "201": {"description": "Created"}, + "401": {"description": "Unauthorized"}, + "403": {"description": "Forbidden"}, + "404": {"description": "Not Found"} + }, + "parameters": [ + { + "in": "path", + "name": "eiJobId", + "description": "eiJobId", + "type": "string", + "required": true + }, + { + "schema": {"$ref": "#/definitions/EiJobStatusObject"}, + "in": "body", + "name": "status", + "description": "status", + "required": true + } + ], + "tags": ["Consumer Callbacks"], + "consumes": ["application/json"] + }}, "/ei-producer/v1/eitypes": {"get": { "summary": "EI type identifiers", "deprecated": false, @@ -81,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, @@ -129,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, @@ -359,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, @@ -455,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:42127", + "host": "localhost:41549", "definitions": { "producer_ei_job_request": { "description": "The body of the EI producer callbacks for EI job creation and deletion", @@ -576,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" ], @@ -587,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" } } }, @@ -697,6 +721,10 @@ "name": "A1-EI (enrichment information)", "description": "Consumer Controller" }, + { + "name": "Consumer Callbacks", + "description": "Consumer Simulator Controller" + }, { "name": "Enrichment Data Producer API", "description": "Producer Controller"