X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=dmaap-adaptor-java%2Fapi%2Fapi.json;h=04c4ab00df641eeb3d52dbbaba59afa4edbb84e6;hb=5feecd881172a3b22041d35443c1f946e7d5f63e;hp=39056e919fc32f7865bdd1dce9821b1b4b8e4b5c;hpb=9bdb9a9a925ffc15c7c55998975662c0529abefb;p=nonrtric.git diff --git a/dmaap-adaptor-java/api/api.json b/dmaap-adaptor-java/api/api.json index 39056e91..04c4ab00 100644 --- a/dmaap-adaptor-java/api/api.json +++ b/dmaap-adaptor-java/api/api.json @@ -107,51 +107,6 @@ }}, "openapi": "3.0.1", "paths": { - "/dmaap_dataproducer/info_job": { - "post": { - "summary": "Callback for Information Job creation/modification", - "requestBody": { - "content": {"application/json": {"schema": {"type": "string"}}}, - "required": true - }, - "description": "The call is invoked to activate or to modify a data subscription. The endpoint is provided by the Information Producer.", - "operationId": "jobCreatedCallback", - "responses": { - "200": { - "description": "OK", - "content": {"application/json": {"schema": {"$ref": "#/components/schemas/void"}}} - }, - "404": { - "description": "Information type is not found", - "content": {"application/json": {"schema": {"$ref": "#/components/schemas/error_information"}}} - } - }, - "tags": ["Producer job control API"] - }, - "get": { - "summary": "Get all jobs", - "description": "Returns all info jobs, can be used for trouble shooting", - "operationId": "getJobs", - "responses": {"200": { - "description": "Information jobs", - "content": {"application/json": {"schema": { - "type": "array", - "items": {"$ref": "#/components/schemas/producer_info_job_request"} - }}} - }}, - "tags": ["Producer job control API"] - } - }, - "/dmaap_dataproducer/health_check": {"get": { - "summary": "Producer supervision", - "description": "The endpoint is provided by the Information Producer and is used for supervision of the producer.", - "operationId": "producerSupervision", - "responses": {"200": { - "description": "The producer is OK", - "content": {"application/json": {"schema": {"type": "string"}}} - }}, - "tags": ["Producer job control API"] - }}, "/actuator/threaddump": {"get": { "summary": "Actuator web endpoint 'threaddump'", "operationId": "handle_2_1_3", @@ -188,6 +143,55 @@ }], "tags": ["Information Coordinator Service Simulator (exists only in test)"] }}, + "/generic_dataproducer/health_check": {"get": { + "summary": "Producer supervision", + "description": "The endpoint is provided by the Information Producer and is used for supervision of the producer.", + "operationId": "producerSupervision", + "responses": {"200": { + "description": "The producer is OK", + "content": {"application/json": {"schema": {"type": "string"}}} + }}, + "tags": ["Producer job control API"] + }}, + "/generic_dataproducer/info_job": { + "post": { + "summary": "Callback for Information Job creation/modification", + "requestBody": { + "content": {"application/json": {"schema": {"type": "string"}}}, + "required": true + }, + "description": "The call is invoked to activate or to modify a data subscription. The endpoint is provided by the Information Producer.", + "operationId": "jobCreatedCallback", + "responses": { + "200": { + "description": "OK", + "content": {"application/json": {"schema": {"$ref": "#/components/schemas/void"}}} + }, + "400": { + "description": "Other error in the request", + "content": {"application/json": {"schema": {"$ref": "#/components/schemas/error_information"}}} + }, + "404": { + "description": "Information type is not found", + "content": {"application/json": {"schema": {"$ref": "#/components/schemas/error_information"}}} + } + }, + "tags": ["Producer job control API"] + }, + "get": { + "summary": "Get all jobs", + "description": "Returns all info jobs, can be used for trouble shooting", + "operationId": "getJobs", + "responses": {"200": { + "description": "Information jobs", + "content": {"application/json": {"schema": { + "type": "array", + "items": {"$ref": "#/components/schemas/producer_info_job_request"} + }}} + }}, + "tags": ["Producer job control API"] + } + }, "/actuator/loggers": {"get": { "summary": "Actuator web endpoint 'loggers'", "operationId": "handle_6", @@ -240,6 +244,22 @@ "tags": ["Information Coordinator Service Simulator (exists only in test)"] } }, + "/generic_dataproducer/info_job/{infoJobId}": {"delete": { + "summary": "Callback for Information Job deletion", + "description": "The call is invoked to terminate a data subscription. The endpoint is provided by the Information Producer.", + "operationId": "jobDeletedCallback", + "responses": {"200": { + "description": "OK", + "content": {"application/json": {"schema": {"$ref": "#/components/schemas/void"}}} + }}, + "parameters": [{ + "schema": {"type": "string"}, + "in": "path", + "name": "infoJobId", + "required": true + }], + "tags": ["Producer job control API"] + }}, "/actuator/metrics/{requiredMetricName}": {"get": { "summary": "Actuator web endpoint 'metrics-requiredMetricName'", "operationId": "handle_5", @@ -311,22 +331,6 @@ "tags": ["Actuator"] } }, - "/dmaap_dataproducer/info_job/{infoJobId}": {"delete": { - "summary": "Callback for Information Job deletion", - "description": "The call is invoked to terminate a data subscription. The endpoint is provided by the Information Producer.", - "operationId": "jobDeletedCallback", - "responses": {"200": { - "description": "OK", - "content": {"application/json": {"schema": {"$ref": "#/components/schemas/void"}}} - }}, - "parameters": [{ - "schema": {"type": "string"}, - "in": "path", - "name": "infoJobId", - "required": true - }], - "tags": ["Producer job control API"] - }}, "/actuator/health": {"get": { "summary": "Actuator web endpoint 'health'", "operationId": "handle_11", @@ -384,8 +388,8 @@ "name": "Copyright (C) 2021 Nordix Foundation. Licensed under the Apache License.", "url": "http://www.apache.org/licenses/LICENSE-2.0" }, - "description": "Reads data from DMAAP and sends it further to information consumers", - "title": "Generic Dmaap Information Producer", + "description": "Reads data from DMaaP and Kafka and posts it further to information consumers", + "title": "Generic Dmaap and Kafka Information Producer", "version": "1.0" }, "tags": [{