aboutsummaryrefslogtreecommitdiffstats
path: root/docs/clamp/controlloop/design-impl/participants/swagger
diff options
context:
space:
mode:
Diffstat (limited to 'docs/clamp/controlloop/design-impl/participants/swagger')
-rw-r--r--docs/clamp/controlloop/design-impl/participants/swagger/k8s-participant-swagger.json399
-rw-r--r--docs/clamp/controlloop/design-impl/participants/swagger/participant-sim.json478
2 files changed, 0 insertions, 877 deletions
diff --git a/docs/clamp/controlloop/design-impl/participants/swagger/k8s-participant-swagger.json b/docs/clamp/controlloop/design-impl/participants/swagger/k8s-participant-swagger.json
deleted file mode 100644
index b2fca37a..00000000
--- a/docs/clamp/controlloop/design-impl/participants/swagger/k8s-participant-swagger.json
+++ /dev/null
@@ -1,399 +0,0 @@
-{
- "swagger":"2.0",
- "info":{
- "description":"Api Documentation",
- "version":"1.0",
- "title":"Api Documentation",
- "termsOfService":"urn:tos",
- "contact":{},
- "license":{
- "name":"Apache 2.0",
- "url":"http://www.apache.org/licenses/LICENSE-2.0"
- }
- },
- "host":"localhost:8083",
- "tags":[
- {
- "name":"k8s-participant",
- "description":"Chart Controller"
- }
- ],
- "paths":{
- "/onap/k8sparticipant/helm/chart/{name}/{version}":{
- "delete":{
- "tags":[
- "k8s-participant"
- ],
- "summary":"Delete the chart",
- "operationId":"deleteChartUsingDELETE",
- "produces":[
- "*/*"
- ],
- "parameters":[
- {
- "name":"name",
- "in":"path",
- "description":"name",
- "required":true,
- "type":"string"
- },
- {
- "name":"version",
- "in":"path",
- "description":"version",
- "required":true,
- "type":"string"
- }
- ],
- "responses":{
- "200":{
- "description":"OK",
- "schema":{
- "type":"object"
- }
- },
- "204":{
- "description":"Chart Deleted"
- },
- "401":{
- "description":"Unauthorized"
- },
- "403":{
- "description":"Forbidden"
- }
- }
- }
- },
- "/onap/k8sparticipant/helm/charts":{
- "get":{
- "tags":[
- "k8s-participant"
- ],
- "summary":"Return all Charts",
- "operationId":"getAllChartsUsingGET",
- "produces":[
- "application/json"
- ],
- "responses":{
- "200":{
- "description":"chart List",
- "schema":{
- "$ref":"#/definitions/ChartList",
- "originalRef":"ChartList"
- }
- },
- "401":{
- "description":"Unauthorized"
- },
- "403":{
- "description":"Forbidden"
- },
- "404":{
- "description":"Not Found"
- }
- }
- }
- },
- "/onap/k8sparticipant/helm/install":{
- "post":{
- "tags":[
- "k8s-participant"
- ],
- "summary":"Install the chart",
- "operationId":"installChartUsingPOST",
- "consumes":[
- "application/json"
- ],
- "produces":[
- "application/json"
- ],
- "parameters":[
- {
- "in":"body",
- "name":"info",
- "description":"info",
- "required":true,
- "schema":{
- "$ref":"#/definitions/InstallationInfo",
- "originalRef":"InstallationInfo"
- }
- }
- ],
- "responses":{
- "200":{
- "description":"OK",
- "schema":{
- "type":"object"
- }
- },
- "201":{
- "description":"chart Installed",
- "schema":{
- "type":"object"
- }
- },
- "401":{
- "description":"Unauthorized"
- },
- "403":{
- "description":"Forbidden"
- },
- "404":{
- "description":"Not Found"
- }
- }
- }
- },
- "/onap/k8sparticipant/helm/onboard/chart":{
- "post":{
- "tags":[
- "k8s-participant"
- ],
- "summary":"Onboard the Chart",
- "operationId":"onboardChartUsingPOST",
- "consumes":[
- "multipart/form-data"
- ],
- "produces":[
- "application/json"
- ],
- "parameters":[
- {
- "name":"chart",
- "in":"formData",
- "required":false,
- "type":"file"
- },
- {
- "name":"info",
- "in":"formData",
- "required":false,
- "type":"string"
- },
- {
- "in":"body",
- "name":"values",
- "description":"values",
- "required":false,
- "schema":{
- "type":"string",
- "format":"binary"
- }
- }
- ],
- "responses":{
- "200":{
- "description":"OK",
- "schema":{
- "type":"string"
- }
- },
- "201":{
- "description":"Chart Onboarded",
- "schema":{
- "type":"string"
- }
- },
- "401":{
- "description":"Unauthorized"
- },
- "403":{
- "description":"Forbidden"
- },
- "404":{
- "description":"Not Found"
- }
- }
- }
- },
- "/onap/k8sparticipant/helm/repo":{
- "post":{
- "tags":[
- "k8s-participant"
- ],
- "summary":"Configure helm repository",
- "operationId":"configureRepoUsingPOST",
- "consumes":[
- "application/json"
- ],
- "produces":[
- "application/json"
- ],
- "parameters":[
- {
- "in":"body",
- "name":"repo",
- "description":"repo",
- "required":true,
- "schema":{
- "type":"string"
- }
- }
- ],
- "responses":{
- "200":{
- "description":"OK",
- "schema":{
- "type":"object"
- }
- },
- "201":{
- "description":"Repository added",
- "schema":{
- "type":"object"
- }
- },
- "401":{
- "description":"Unauthorized"
- },
- "403":{
- "description":"Forbidden"
- },
- "404":{
- "description":"Not Found"
- }
- }
- }
- },
- "/onap/k8sparticipant/helm/uninstall/{name}/{version}":{
- "delete":{
- "tags":[
- "k8s-participant"
- ],
- "summary":"Uninstall the Chart",
- "operationId":"uninstallChartUsingDELETE",
- "produces":[
- "application/json"
- ],
- "parameters":[
- {
- "name":"name",
- "in":"path",
- "description":"name",
- "required":true,
- "type":"string"
- },
- {
- "name":"version",
- "in":"path",
- "description":"version",
- "required":true,
- "type":"string"
- }
- ],
- "responses":{
- "200":{
- "description":"OK",
- "schema":{
- "type":"object"
- }
- },
- "201":{
- "description":"chart Uninstalled",
- "schema":{
- "type":"object"
- }
- },
- "204":{
- "description":"No Content"
- },
- "401":{
- "description":"Unauthorized"
- },
- "403":{
- "description":"Forbidden"
- }
- }
- }
- }
- },
- "definitions":{
- "ChartInfo":{
- "type":"object",
- "properties":{
- "chartId":{
- "$ref":"#/definitions/ToscaConceptIdentifier",
- "originalRef":"ToscaConceptIdentifier"
- },
- "namespace":{
- "type":"string"
- },
- "overrideParams":{
- "type":"object",
- "additionalProperties":{
- "type":"string"
- }
- },
- "releaseName":{
- "type":"string"
- },
- "repository":{
- "$ref":"#/definitions/HelmRepository",
- "originalRef":"HelmRepository"
- }
- },
- "title":"ChartInfo"
- },
- "ChartList":{
- "type":"object",
- "properties":{
- "charts":{
- "type":"array",
- "items":{
- "$ref":"#/definitions/ChartInfo",
- "originalRef":"ChartInfo"
- }
- }
- },
- "title":"ChartList"
- },
- "HelmRepository":{
- "type":"object",
- "properties":{
- "address":{
- "type":"string"
- },
- "password":{
- "type":"string"
- },
- "port":{
- "type":"string"
- },
- "protocol":{
- "type":"string"
- },
- "repoName":{
- "type":"string"
- },
- "userName":{
- "type":"string"
- }
- },
- "title":"HelmRepository"
- },
- "InstallationInfo":{
- "type":"object",
- "properties":{
- "name":{
- "type":"string"
- },
- "version":{
- "type":"string"
- }
- },
- "title":"InstallationInfo"
- },
- "ToscaConceptIdentifier":{
- "type":"object",
- "properties":{
- "name":{
- "type":"string"
- },
- "version":{
- "type":"string"
- }
- },
- "title":"ToscaConceptIdentifier"
- }
- }
-}
diff --git a/docs/clamp/controlloop/design-impl/participants/swagger/participant-sim.json b/docs/clamp/controlloop/design-impl/participants/swagger/participant-sim.json
deleted file mode 100644
index 79fc3011..00000000
--- a/docs/clamp/controlloop/design-impl/participants/swagger/participant-sim.json
+++ /dev/null
@@ -1,478 +0,0 @@
-{
- "swagger": "2.0",
- "info": {
- "description": "Api Documentation",
- "version": "1.0",
- "title": "Api Documentation",
- "termsOfService": "urn:tos",
- "contact": {},
- "license": {
- "name": "Apache 2.0",
- "url": "http://www.apache.org/licenses/LICENSE-2.0"
- }
- },
- "paths": {
- "/onap/participantsim/v2/elements": {
- "put": {
- "tags": [
- "Clamp Control Loop Participant Simulator API"
- ],
- "summary": "Updates simulated control loop elements",
- "description": "Updates simulated control loop elements, returning the updated control loop definition IDs",
- "operationId": "updateUsingPUT",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json",
- "application/yaml"
- ],
- "parameters": [
- {
- "in": "body",
- "name": "body",
- "description": "Body of a control loop element",
- "required": true,
- "schema": {
- "$ref": "#/definitions/ControlLoopElementReq",
- "originalRef": "ControlLoopElementReq"
- }
- },
- {
- "name": "X-ONAP-RequestID",
- "in": "header",
- "description": "RequestID for http transaction",
- "required": false,
- "type": "string",
- "format": "uuid"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/TypedSimpleResponse«ControlLoopElement»",
- "originalRef": "TypedSimpleResponse«ControlLoopElement»"
- }
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Authentication Error",
- "headers": {
- "X-LatestVersion": {
- "type": "string"
- },
- "X-PatchVersion": {
- "type": "string"
- },
- "X-MinorVersion": {
- "type": "string"
- },
- "X-ONAP-RequestID": {
- "type": "string",
- "format": "uuid"
- }
- }
- },
- "403": {
- "description": "Authorization Error",
- "headers": {
- "X-LatestVersion": {
- "type": "string"
- },
- "X-PatchVersion": {
- "type": "string"
- },
- "X-MinorVersion": {
- "type": "string"
- },
- "X-ONAP-RequestID": {
- "type": "string",
- "format": "uuid"
- }
- }
- },
- "404": {
- "description": "Not Found"
- },
- "500": {
- "description": "Internal Server Error",
- "headers": {
- "X-LatestVersion": {
- "type": "string"
- },
- "X-PatchVersion": {
- "type": "string"
- },
- "X-MinorVersion": {
- "type": "string"
- },
- "X-ONAP-RequestID": {
- "type": "string",
- "format": "uuid"
- }
- }
- }
- },
- "security": [
- {
- "basicAuth": []
- }
- ],
- "x-interface info": {
- "api-version": "1.0.0",
- "last-mod-release": "Dublin"
- }
- }
- },
- "/onap/participantsim/v2/elements/{name}/{version}": {
- "get": {
- "tags": [
- "Clamp Control Loop Participant Simulator API"
- ],
- "summary": "Query details of the requested simulated control loop elements",
- "description": "Queries details of the requested simulated control loop elements, returning all control loop element details",
- "operationId": "elementsUsingGET",
- "produces": [
- "application/json",
- "application/yaml"
- ],
- "parameters": [
- {
- "name": "name",
- "in": "path",
- "description": "Control loop element name",
- "required": true,
- "type": "string"
- },
- {
- "name": "version",
- "in": "path",
- "description": "Control loop element version",
- "required": true,
- "type": "string"
- },
- {
- "name": "X-ONAP-RequestID",
- "in": "header",
- "description": "RequestID for http transaction",
- "required": false,
- "type": "string",
- "format": "uuid"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "type": "object",
- "additionalProperties": {
- "$ref": "#/definitions/ControlLoopElementRes",
- "originalRef": "ControlLoopElementRes"
- }
- }
- },
- "401": {
- "description": "Authentication Error",
- "headers": {
- "X-LatestVersion": {
- "type": "string"
- },
- "X-PatchVersion": {
- "type": "string"
- },
- "X-MinorVersion": {
- "type": "string"
- },
- "X-ONAP-RequestID": {
- "type": "string",
- "format": "uuid"
- }
- }
- },
- "403": {
- "description": "Authorization Error",
- "headers": {
- "X-LatestVersion": {
- "type": "string"
- },
- "X-PatchVersion": {
- "type": "string"
- },
- "X-MinorVersion": {
- "type": "string"
- },
- "X-ONAP-RequestID": {
- "type": "string",
- "format": "uuid"
- }
- }
- },
- "404": {
- "description": "Not Found"
- },
- "500": {
- "description": "Internal Server Error",
- "headers": {
- "X-LatestVersion": {
- "type": "string"
- },
- "X-PatchVersion": {
- "type": "string"
- },
- "X-MinorVersion": {
- "type": "string"
- },
- "X-ONAP-RequestID": {
- "type": "string",
- "format": "uuid"
- }
- }
- }
- },
- "security": [
- {
- "basicAuth": []
- }
- ],
- "x-interface info": {
- "api-version": "1.0.0",
- "last-mod-release": "Dublin"
- }
- }
- },
- "/onap/participantsim/v2/participants": {
- "put": {
- "tags": [
- "Clamp Control Loop Participant Simulator API"
- ],
- "summary": "Updates simulated participants",
- "description": "Updates simulated participants, returning the updated control loop definition IDs",
- "operationId": "updateUsingPUT_1",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json",
- "application/yaml"
- ],
- "parameters": [
- {
- "in": "body",
- "name": "body",
- "description": "Body of a participant",
- "required": true,
- "schema": {
- "$ref": "#/definitions/ParticipantReq",
- "originalRef": "ParticipantReq"
- }
- },
- {
- "name": "X-ONAP-RequestID",
- "in": "header",
- "description": "RequestID for http transaction",
- "required": false,
- "type": "string",
- "format": "uuid"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/TypedSimpleResponse«Participant»",
- "originalRef": "TypedSimpleResponse«Participant»"
- }
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Authentication Error",
- "headers": {
- "X-LatestVersion": {
- "type": "string"
- },
- "X-PatchVersion": {
- "type": "string"
- },
- "X-MinorVersion": {
- "type": "string"
- },
- "X-ONAP-RequestID": {
- "type": "string",
- "format": "uuid"
- }
- }
- },
- "403": {
- "description": "Authorization Error",
- "headers": {
- "X-LatestVersion": {
- "type": "string"
- },
- "X-PatchVersion": {
- "type": "string"
- },
- "X-MinorVersion": {
- "type": "string"
- },
- "X-ONAP-RequestID": {
- "type": "string",
- "format": "uuid"
- }
- }
- },
- "404": {
- "description": "Not Found"
- },
- "500": {
- "description": "Internal Server Error",
- "headers": {
- "X-LatestVersion": {
- "type": "string"
- },
- "X-PatchVersion": {
- "type": "string"
- },
- "X-MinorVersion": {
- "type": "string"
- },
- "X-ONAP-RequestID": {
- "type": "string",
- "format": "uuid"
- }
- }
- }
- },
- "security": [
- {
- "basicAuth": []
- }
- ],
- "x-interface info": {
- "api-version": "1.0.0",
- "last-mod-release": "Dublin"
- }
- }
- },
- "/onap/participantsim/v2/participants/{name}/{version}": {
- "get": {
- "tags": [
- "Clamp Control Loop Participant Simulator API"
- ],
- "summary": "Query details of the requested simulated participants",
- "description": "Queries details of the requested simulated participants, returning all participant details",
- "operationId": "participantsUsingGET",
- "produces": [
- "application/json",
- "application/yaml"
- ],
- "parameters": [
- {
- "name": "name",
- "in": "path",
- "description": "Participant name",
- "required": true,
- "type": "string"
- },
- {
- "name": "version",
- "in": "path",
- "description": "Participant version",
- "required": true,
- "type": "string"
- },
- {
- "name": "X-ONAP-RequestID",
- "in": "header",
- "description": "RequestID for http transaction",
- "required": false,
- "type": "string",
- "format": "uuid"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/ParticipantRes",
- "originalRef": "ParticipantRes"
- }
- }
- },
- "401": {
- "description": "Authentication Error",
- "headers": {
- "X-LatestVersion": {
- "type": "string"
- },
- "X-PatchVersion": {
- "type": "string"
- },
- "X-MinorVersion": {
- "type": "string"
- },
- "X-ONAP-RequestID": {
- "type": "string",
- "format": "uuid"
- }
- }
- },
- "403": {
- "description": "Authorization Error",
- "headers": {
- "X-LatestVersion": {
- "type": "string"
- },
- "X-PatchVersion": {
- "type": "string"
- },
- "X-MinorVersion": {
- "type": "string"
- },
- "X-ONAP-RequestID": {
- "type": "string",
- "format": "uuid"
- }
- }
- },
- "404": {
- "description": "Not Found"
- },
- "500": {
- "description": "Internal Server Error",
- "headers": {
- "X-LatestVersion": {
- "type": "string"
- },
- "X-PatchVersion": {
- "type": "string"
- },
- "X-MinorVersion": {
- "type": "string"
- },
- "X-ONAP-RequestID": {
- "type": "string",
- "format": "uuid"
- }
- }
- }
- },
- "security": [
- {
- "basicAuth": []
- }
- ],
- "x-interface info": {
- "api-version": "1.0.0",
- "last-mod-release": "Dublin"
- }
- }
- }
- }
-} \ No newline at end of file