X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=dmaap-adaptor-java%2Fapi%2Fapi.json;h=88fed46b049247cd80d936295240ec6e7cc32553;hb=4719b5c2231929ab0ccc781af9686db7c0b1261e;hp=6cd3525b0eda705c9146595ebf7cbe7dcb7d95d9;hpb=a28a4ad261601976c345425692116e5d7250b810;p=nonrtric.git diff --git a/dmaap-adaptor-java/api/api.json b/dmaap-adaptor-java/api/api.json index 6cd3525b..88fed46b 100644 --- a/dmaap-adaptor-java/api/api.json +++ b/dmaap-adaptor-java/api/api.json @@ -107,7 +107,53 @@ }}, "openapi": "3.0.1", "paths": { - "/dmaap_dataproducer/info_job": { + "/actuator/threaddump": {"get": { + "summary": "Actuator web endpoint 'threaddump'", + "operationId": "threaddump_4", + "responses": {"200": { + "description": "OK", + "content": {"*/*": {"schema": {"type": "object"}}} + }}, + "tags": ["Actuator"] + }}, + "/actuator/info": {"get": { + "summary": "Actuator web endpoint 'info'", + "operationId": "info_2", + "responses": {"200": { + "description": "OK", + "content": {"*/*": {"schema": {"type": "object"}}} + }}, + "tags": ["Actuator"] + }}, + "/data-producer/v1/info-types/{infoTypeId}": {"put": { + "requestBody": { + "content": {"application/json": {"schema": {"$ref": "#/components/schemas/producer_info_type_info"}}}, + "required": true + }, + "operationId": "putInfoType", + "responses": {"200": { + "description": "OK", + "content": {"application/json": {"schema": {"type": "object"}}} + }}, + "parameters": [{ + "schema": {"type": "string"}, + "in": "path", + "name": "infoTypeId", + "required": true + }], + "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": { @@ -146,55 +192,9 @@ "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", - "responses": {"200": { - "description": "OK", - "content": {"*/*": {"schema": {"type": "object"}}} - }}, - "tags": ["Actuator"] - }}, - "/actuator/info": {"get": { - "summary": "Actuator web endpoint 'info'", - "operationId": "handle_9", - "responses": {"200": { - "description": "OK", - "content": {"*/*": {"schema": {"type": "object"}}} - }}, - "tags": ["Actuator"] - }}, - "/data-producer/v1/info-types/{infoTypeId}": {"put": { - "requestBody": { - "content": {"application/json": {"schema": {"$ref": "#/components/schemas/producer_info_type_info"}}}, - "required": true - }, - "operationId": "putInfoType", - "responses": {"200": { - "description": "OK", - "content": {"application/json": {"schema": {"type": "object"}}} - }}, - "parameters": [{ - "schema": {"type": "string"}, - "in": "path", - "name": "infoTypeId", - "required": true - }], - "tags": ["Information Coordinator Service Simulator (exists only in test)"] - }}, "/actuator/loggers": {"get": { "summary": "Actuator web endpoint 'loggers'", - "operationId": "handle_6", + "operationId": "loggers_2", "responses": {"200": { "description": "OK", "content": {"*/*": {"schema": {"type": "object"}}} @@ -203,7 +203,7 @@ }}, "/actuator/health/**": {"get": { "summary": "Actuator web endpoint 'health-path'", - "operationId": "handle_12", + "operationId": "health-path_2", "responses": {"200": { "description": "OK", "content": {"*/*": {"schema": {"type": "object"}}} @@ -244,9 +244,25 @@ "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", + "operationId": "metrics-requiredMetricName_2", "responses": {"200": { "description": "OK", "content": {"*/*": {"schema": {"type": "object"}}} @@ -276,7 +292,7 @@ }}, "/actuator/logfile": {"get": { "summary": "Actuator web endpoint 'logfile'", - "operationId": "handle_8", + "operationId": "logfile_2", "responses": {"200": { "description": "OK", "content": {"*/*": {"schema": {"type": "object"}}} @@ -286,7 +302,7 @@ "/actuator/loggers/{name}": { "post": { "summary": "Actuator web endpoint 'loggers-name'", - "operationId": "handle_0", + "operationId": "loggers-name_3", "responses": {"200": { "description": "OK", "content": {"*/*": {"schema": {"type": "object"}}} @@ -301,7 +317,7 @@ }, "get": { "summary": "Actuator web endpoint 'loggers-name'", - "operationId": "handle_7", + "operationId": "loggers-name_4", "responses": {"200": { "description": "OK", "content": {"*/*": {"schema": {"type": "object"}}} @@ -315,25 +331,9 @@ "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", + "operationId": "health_2", "responses": {"200": { "description": "OK", "content": {"*/*": {"schema": {"type": "object"}}} @@ -366,7 +366,7 @@ }}, "/actuator/metrics": {"get": { "summary": "Actuator web endpoint 'metrics'", - "operationId": "handle_4", + "operationId": "metrics_2", "responses": {"200": { "description": "OK", "content": {"*/*": {"schema": {"type": "object"}}} @@ -375,7 +375,7 @@ }}, "/actuator/heapdump": {"get": { "summary": "Actuator web endpoint 'heapdump'", - "operationId": "handle_10", + "operationId": "heapdump_2", "responses": {"200": { "description": "OK", "content": {"*/*": {"schema": {"type": "object"}}} @@ -388,16 +388,22 @@ "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": [{ - "name": "Actuator", - "description": "Monitor and interact", - "externalDocs": { - "description": "Spring Boot Actuator Web API Documentation", - "url": "https://docs.spring.io/spring-boot/docs/current/actuator-api/html/" + "tags": [ + {"name": "Information Coordinator Service Simulator (exists only in test)"}, + {"name": "Producer job control API"}, + {"name": "Test Consumer Simulator (exists only in test)"}, + {"name": "DMAAP Simulator (exists only in test)"}, + { + "name": "Actuator", + "description": "Monitor and interact", + "externalDocs": { + "description": "Spring Boot Actuator Web API Documentation", + "url": "https://docs.spring.io/spring-boot/docs/current/actuator-api/html/" + } } - }] + ] } \ No newline at end of file