diff options
Diffstat (limited to 'docs/sections/apis')
| -rw-r--r-- | docs/sections/apis/configbinding.json | 118 | ||||
| -rw-r--r-- | docs/sections/apis/configbinding.rst | 179 | ||||
| -rw-r--r-- | docs/sections/apis/configbinding.yaml | 99 | ||||
| -rw-r--r-- | docs/sections/apis/dcaedashboard.json | 1107 | ||||
| -rw-r--r-- | docs/sections/apis/dcaedashboard.rst | 26 | ||||
| -rw-r--r-- | docs/sections/apis/deployment-handler-API.json | 561 | ||||
| -rw-r--r-- | docs/sections/apis/deployment-handler-API.yaml | 541 | ||||
| -rw-r--r-- | docs/sections/apis/deployment-handler.rst | 944 | ||||
| -rw-r--r-- | docs/sections/apis/inventory.rst | 1538 | ||||
| -rw-r--r-- | docs/sections/apis/swagger-bbs-event-processor.yaml | 164 |
10 files changed, 0 insertions, 5277 deletions
diff --git a/docs/sections/apis/configbinding.json b/docs/sections/apis/configbinding.json deleted file mode 100644 index 7075b1e9..00000000 --- a/docs/sections/apis/configbinding.json +++ /dev/null @@ -1,118 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2.5.3", - "title": "Config Binding Service" - }, - "paths": { - "/service_component/{service_component_name}": { - "parameters": [ - { - "name": "service_component_name", - "in": "path", - "description": "Service Component Name. service_component_name must be a key in consul.", - "required": true, - "type": "string" - } - ], - "get": { - "description": "Binds the configuration for service_component_name and returns the bound configuration as a JSON", - "operationId": "config_binding_service.controller.bind_config_for_scn", - "responses": { - "200": { - "description": "OK; the bound config is returned as an object", - "schema": { - "type": "object" - } - }, - "404": { - "description": "there is no configuration in Consul for this component" - } - } - } - }, - "/service_component_all/{service_component_name}": { - "parameters": [ - { - "name": "service_component_name", - "in": "path", - "description": "Service Component Name. service_component_name must be a key in consul.", - "required": true, - "type": "string" - } - ], - "get": { - "description": "Binds the configuration for service_component_name and returns the bound configuration, policies, and any other keys that are in Consul", - "operationId": "config_binding_service.controller.bind_all", - "responses": { - "200": { - "description": "OK; returns {config : ..., policies : ....., k : ...} for all other k in Consul", - "schema": { - "type": "object" - } - }, - "404": { - "description": "there is no configuration in Consul for this component" - } - } - } - }, - "/{key}/{service_component_name}": { - "parameters": [ - { - "name": "key", - "in": "path", - "description": "this endpoint tries to pull service_component_name:key; key is the key after the colon", - "required": true, - "type": "string" - }, - { - "name": "service_component_name", - "in": "path", - "description": "Service Component Name.", - "required": true, - "type": "string" - } - ], - "get": { - "description": "this is an endpoint that fetches a generic service_component_name:key out of Consul. The idea is that we don't want to tie components to Consul directly in case we swap out the backend some day, so the CBS abstracts Consul from clients. The structuring and weird collision of this new API with the above is unfortunate but due to legacy concerns.", - "operationId": "config_binding_service.controller.get_key", - "responses": { - "200": { - "description": "OK; returns service_component_name:key", - "schema": { - "type": "object" - } - }, - "400": { - "description": "bad request. Currently this is only returned on :policies, which is a complex object, and should be gotten through service_component_all", - "schema": { - "type": "string" - } - }, - "404": { - "description": "key does not exist", - "schema": { - "type": "string" - } - } - } - } - }, - "/healthcheck": { - "get": { - "description": "This is the health check endpoint. If this returns a 200, the server is alive and consul can be reached. If not a 200, either dead, or no connection to consul", - "operationId": "config_binding_service.controller.healthcheck", - "parameters": [], - "responses": { - "200": { - "description": "Successful response" - }, - "503": { - "description": "the config binding service cannot reach Consul" - } - } - } - } - } -} diff --git a/docs/sections/apis/configbinding.rst b/docs/sections/apis/configbinding.rst deleted file mode 100644 index 5eb026ba..00000000 --- a/docs/sections/apis/configbinding.rst +++ /dev/null @@ -1,179 +0,0 @@ -Config Binding Service -====================== - -.. toctree:: - :maxdepth: 3 - -.. csv-table:: - :header: "API name", "Swagger JSON", "Swagger YAML" - :widths: 10,5,5 - - "Config Binding Service", ":download:`link <configbinding.json>`", ":download:`link <configbinding.yaml>`" - -GET ``/service_component_all/{service_component_name}`` -------------------------------------------------------- - -Description -+++++++++++ - -.. raw:: html - - Binds the configuration for service_component_name and returns the bound configuration, policies, and any other keys that are in Consul - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - service_component_name | path | Yes | string | | | Service Component Name. service_component_name must be a key in consul. - -Request -+++++++ - -Responses -+++++++++ - -**200** -^^^^^^^ - -OK; returns {config : ..., policies : ....., k : ...} for all other k in Consul - -.. _i_4d863967ef9a9d9efdadd1b250c76bd6: - -**Response Schema:** - -**Example:** - -.. code-block:: javascript - - {} - -**404** -^^^^^^^ - -there is no configuration in Consul for this component - -GET ``/service_component/{service_component_name}`` ---------------------------------------------------- - -Description -+++++++++++ - -.. raw:: html - - Binds the configuration for service_component_name and returns the bound configuration as a JSON - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - service_component_name | path | Yes | string | | | Service Component Name. service_component_name must be a key in consul. - -Request -+++++++ - -Responses -+++++++++ - -**200** -^^^^^^^ - -OK; the bound config is returned as an object - -**Response Schema:** - -**Example:** - -.. code-block:: javascript - - {} - -**404** -^^^^^^^ - -there is no configuration in Consul for this component - -GET ``/{key}/{service_component_name}`` ---------------------------------------- - -Description -+++++++++++ - -.. raw:: html - - this is an endpoint that fetches a generic service_component_name:key out of Consul. The idea is that we don't want to tie components to Consul directly in case we swap out the backend some day, so the CBS abstracts Consul from clients. The structuring and weird collision of this new API with the above is unfortunate but due to legacy concerns. - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - key | path | Yes | string | | | this endpoint tries to pull service_component_name:key; key is the key after the colon - service_component_name | path | Yes | string | | | Service Component Name. - -Request -+++++++ - -Responses -+++++++++ - -**200** -^^^^^^^ - -OK; returns service_component_name:key - -**Response Schema:** - -**Example:** - -.. code-block:: javascript - - {} - -**400** -^^^^^^^ - -bad request. Currently this is only returned on :policies, which is a complex -object, and should be gotten through service_component_all - -**404** -^^^^^^^ - -key does not exist - -GET ``/healthcheck`` --------------------- - -Description -+++++++++++ - -.. raw:: html - - This is the health check endpoint. If this returns a 200, the server is alive and consul can be reached. If not a 200, either dead, or no connection to consul - -Request -+++++++ - -Responses -+++++++++ - -**200** -^^^^^^^ - -Successful response - -**503** -^^^^^^^ - -the config binding service cannot reach Consul - diff --git a/docs/sections/apis/configbinding.yaml b/docs/sections/apis/configbinding.yaml deleted file mode 100644 index f2ce1205..00000000 --- a/docs/sections/apis/configbinding.yaml +++ /dev/null @@ -1,99 +0,0 @@ -# ============LICENSE_START======================================================= -# Copyright (c) 2017-2020 AT&T Intellectual Property. All rights reserved. -# ================================================================================ -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# ============LICENSE_END========================================================= - - - ---- -swagger: "2.0" -info: - version: "2.5.3" - title: "Config Binding Service" -paths: - /service_component/{service_component_name}: - parameters: - - name: "service_component_name" - in: "path" - description: "Service Component Name. service_component_name must be a key in consul." - required: true - type: "string" - get: - description: "Binds the configuration for service_component_name and returns the bound configuration as a JSON" - operationId: "config_binding_service.controller.bind_config_for_scn" - responses: - 200: - description: OK; the bound config is returned as an object - schema: - type: object - 404: - description: there is no configuration in Consul for this component - - /service_component_all/{service_component_name}: - parameters: - - name: "service_component_name" - in: "path" - description: "Service Component Name. service_component_name must be a key in consul." - required: true - type: "string" - get: - description: "Binds the configuration for service_component_name and returns the bound configuration, policies, and any other keys that are in Consul" - operationId: "config_binding_service.controller.bind_all" - responses: - 200: - description: "OK; returns {config : ..., policies : ....., k : ...} for all other k in Consul" - schema: - type: object - 404: - description: there is no configuration in Consul for this component - - /{key}/{service_component_name}: - parameters: - - name: "key" - in: "path" - description: "this endpoint tries to pull service_component_name:key; key is the key after the colon" - required: true - type: "string" - - name: "service_component_name" - in: "path" - description: "Service Component Name." - required: true - type: "string" - get: - description: "this is an endpoint that fetches a generic service_component_name:key out of Consul. The idea is that we don't want to tie components to Consul directly in case we swap out the backend some day, so the CBS abstracts Consul from clients. The structuring and weird collision of this new API with the above is unfortunate but due to legacy concerns." - operationId: "config_binding_service.controller.get_key" - responses: - 200: - description: "OK; returns service_component_name:key" - schema: - type: object - 404: - description: "key does not exist" - schema: - type: string - 400: - description: "bad request. Currently this is only returned on :policies, which is a complex object, and should be gotten through service_component_all" - schema: - type: string - - /healthcheck: - get: - description: "This is the health check endpoint. If this returns a 200, the server is alive and consul can be reached. If not a 200, either dead, or no connection to consul" - operationId: "config_binding_service.controller.healthcheck" - parameters: [] - responses: - 200: - description: Successful response - 503: - description: the config binding service cannot reach Consul diff --git a/docs/sections/apis/dcaedashboard.json b/docs/sections/apis/dcaedashboard.json deleted file mode 100644 index 8d4f463a..00000000 --- a/docs/sections/apis/dcaedashboard.json +++ /dev/null @@ -1,1107 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "description": "API to manage deployment of microservices using blueprints. HTTP Basic authorization schema is required to authenticate users for all the resource endpoints. The client sends HTTP requests with an Authorization header containing base64-encoded username:password string.", - "version": "1.4.0", - "title": "DCAE Dashboard API", - "contact": { - "email": "rp5662@att.com" - } - }, - "host": "dcae-dashboard:8080", - "basePath": "/ccsdk-app/nb-api/v2", - "tags": [ - { - "name": "Blueprints", - "description": "Query blueprint information" - }, - { - "name": "Deployments", - "description": "Manage deployments" - }, - { - "name": "Tenants", - "description": "Query Cloudify Tenants" - } - ], - "schemes": [ - "https", - "http" - ], - "paths": { - "/tenants": { - "get": { - "tags": [ - "Tenants" - ], - "summary": "Lists all Cloudify Tenants", - "description": "Query all Tenant names from Cloudify", - "operationId": "List Tenants", - "produces": [ - "application/json" - ], - "parameters": [], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/Tenant" - } - } - }, - "400": { - "description": "Invalid status value" - }, - "401": { - "$ref": "#/responses/UnauthorizedError" - } - } - } - }, - "/deployments": { - "get": { - "tags": [ - "Deployments" - ], - "summary": "List all Deployments", - "description": "Query all deployments or Service objects from Inventory", - "operationId": "List Deployments", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "page", - "in": "query", - "description": "pagination control - page number", - "required": true, - "type": "integer" - }, - { - "name": "size", - "in": "query", - "description": "pagination control - page size", - "required": true, - "type": "integer" - }, - { - "name": "filters", - "in": "query", - "description": "search filters, {\"_include\":\"id\", \"tenant\":\"onap-tenant-1\",\"serviceId\":\"dcae\"}", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/Deployment" - } - }, - "headers": { - "Link": { - "type": "string", - "description": "pagination header" - } - } - }, - "400": { - "description": "Invalid status value" - }, - "401": { - "$ref": "#/responses/UnauthorizedError" - } - } - }, - "post": { - "tags": [ - "Deployments" - ], - "summary": "Initiate a deployment (install) operation for an application or service", - "description": "Controller sends the blueprint and required inputs to Deployment Handler microservice to initiate the deployment process", - "operationId": "Create Deployment", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "body", - "description": "Inputs to initiate a deployment: blueprint ID from inventory, Cloudify tenant name, blueprint inputs", - "required": true, - "schema": { - "$ref": "#/definitions/DeploymentInput" - } - } - ], - "responses": { - "201": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/DeploymentResource" - } - }, - "401": { - "$ref": "#/responses/UnauthorizedError" - }, - "405": { - "description": "Invalid input" - } - } - } - }, - "/deployments/{deploymentId}": { - "delete": { - "tags": [ - "Deployments" - ], - "summary": "Initiate an uninstall operation for an application or service", - "description": "Controller sends the deployment reference to Deployment Handler microservice to initiate the uninstall process", - "operationId": "Delete Deployment", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "deploymentId", - "in": "path", - "description": "ID of deployment to query", - "required": true, - "type": "string" - }, - { - "name": "tenant", - "in": "query", - "description": "Cloudify Tenant name", - "required": true, - "type": "string" - } - ], - "responses": { - "204": { - "description": "successful operation", - "schema": { - "type": "string" - } - }, - "400": { - "description": "Invalid status value" - }, - "401": { - "$ref": "#/responses/UnauthorizedError" - } - } - }, - "put": { - "tags": [ - "Deployments" - ], - "summary": "Upgrade or Rollback an existing deployment using Cloudify Helm plugin", - "description": "Upgrade or Rollback an existing deployment using Cloudify Helm plugin", - "operationId": "Upgrade/Rollback Deployment", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "deploymentId", - "in": "path", - "description": "ID of deployment in context", - "required": true, - "type": "string" - }, - { - "in": "body", - "name": "body", - "description": "Cloudify Execution Request object that has parameters to start either an upgrade or a rollback execution workflow", - "required": true, - "schema": { - "$ref": "#/definitions/CloudifyDeploymentUpgradeRequest" - } - } - ], - "responses": { - "400": { - "description": "Invalid ID supplied" - }, - "401": { - "$ref": "#/responses/UnauthorizedError" - }, - "404": { - "description": "Deployment not found" - }, - "405": { - "description": "Validation exception" - } - } - }, - "get": { - "tags": [ - "Deployments" - ], - "summary": "Get a Deployment", - "description": "Query a deployment or Service object from Inventory", - "operationId": "Get Deployment", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "deploymentId", - "in": "path", - "description": "ID of deployment to query", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/Deployment" - } - } - }, - "400": { - "description": "Invalid status value" - }, - "401": { - "$ref": "#/responses/UnauthorizedError" - } - } - } - }, - "/deployments/{deploymentId}/executions": { - "get": { - "tags": [ - "Deployments" - ], - "summary": "Deployment execution status", - "description": "Query deployment workflow execution status", - "operationId": "Deployment Status", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "deploymentId", - "in": "path", - "description": "ID of deployment to query execution status", - "required": true, - "type": "string" - }, - { - "name": "tenant", - "in": "query", - "description": "tenant name associated with the deployment", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/execution" - } - } - }, - "400": { - "description": "Invalid status value" - }, - "401": { - "$ref": "#/responses/UnauthorizedError" - } - } - } - }, - "/deployments/{deploymentId}/health": { - "get": { - "tags": [ - "Deployments" - ], - "summary": "Deployment health status", - "description": "Query consul for service health using deployment ID filter", - "operationId": "Deployment health", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "deploymentId", - "in": "path", - "description": "ID of deployment to query service health", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/serviceHealth" - } - }, - "401": { - "$ref": "#/responses/UnauthorizedError" - } - } - } - }, - "/deployments/{deploymentId}/inputs": { - "get": { - "tags": [ - "Deployments" - ], - "summary": "Deployment inputs", - "description": "Get blueprint inputs used to create deployment", - "operationId": "Deployment Inputs", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "deploymentId", - "in": "path", - "description": "ID of deployment to query execution status", - "required": true, - "type": "string" - }, - { - "name": "tenant", - "in": "query", - "description": "tenant name associated with the deployment", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "type": "object", - "items": { - "$ref": "#/definitions/deploymentInputs" - } - } - }, - "400": { - "description": "Invalid status value" - }, - "401": { - "$ref": "#/responses/UnauthorizedError" - } - } - } - }, - "/blueprints": { - "get": { - "tags": [ - "Blueprints" - ], - "summary": "Find all blueprint templates", - "description": "Fetch the blueprints data from inventory", - "operationId": "List Blueprints", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "page", - "in": "query", - "description": "page number", - "required": false, - "type": "string" - }, - { - "name": "size", - "in": "query", - "description": "page size", - "required": false, - "type": "string" - }, - { - "name": "filters", - "in": "query", - "description": "search filters, {\"owner\":\"user1\", \"name\":\"user1-bp1\",\"id\":\"2334-343\"}", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "List of `DCAEServiceType` objects", - "schema": { - "$ref": "#/definitions/InlineResponse200" - }, - "headers": { - "Link": { - "type": "string", - "description": "pagination header" - } - } - }, - "400": { - "description": "Invalid tag value" - }, - "401": { - "$ref": "#/responses/UnauthorizedError" - } - } - }, - "post": { - "tags": [ - "Blueprints" - ], - "summary": "Create/Upload a new blueprint template", - "description": "Upload a new blueprint template into inventory", - "operationId": "Create Blueprint", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "body", - "description": "upload blueprint request to inventory", - "required": true, - "schema": { - "$ref": "#/definitions/DCAEServiceTypeRequest" - } - } - ], - "responses": { - "201": { - "description": "A `DCAEServiceType` object", - "schema": { - "$ref": "#/definitions/InlineResponse200" - } - }, - "400": { - "description": "Invalid tag value" - }, - "401": { - "$ref": "#/responses/UnauthorizedError" - } - } - } - }, - "/blueprints/{typeId}": { - "delete": { - "tags": [ - "Blueprints" - ], - "summary": "Delete a blueprint template", - "description": "Delete a blueprint template from inventory", - "operationId": "Delete Blueprint", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "typeId", - "in": "path", - "description": "ID of blueprint to delete", - "required": true, - "type": "string" - } - ], - "responses": { - "204": { - "description": "successful operation" - }, - "401": { - "$ref": "#/responses/UnauthorizedError" - } - } - } - }, - "/blueprints/{typeId}/services": { - "get": { - "tags": [ - "Blueprints" - ], - "summary": "Get Services mapped to a blueprint template", - "description": "Get Deployment References existing for a blueprint", - "operationId": "Get Deployments for a blueprint", - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "typeId", - "in": "path", - "description": "ID of blueprint to query", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "successful operation" - }, - "401": { - "$ref": "#/responses/UnauthorizedError" - } - } - } - } - }, - "securityDefinitions": { - "basicAuth": { - "type": "basic" - } - }, - "security": [ - { - "basicAuth": [] - } - ], - "responses": { - "UnauthorizedError": { - "description": "Authentication information is missing or invalid", - "headers": { - "WWW_Authenticate": { - "type": "string" - } - } - } - }, - "definitions": { - "Tenant": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "cloudify tenant name" - } - } - }, - "InlineResponse200": { - "type": "object", - "properties": { - "totalItems": { - "type": "integer", - "format": "int32" - }, - "totalPages": { - "type": "integer", - "format": "int32" - }, - "items": { - "type": "array", - "items": { - "$ref": "#/definitions/DCAEServiceTypeSummary" - } - } - } - }, - "InlineResponse200Links": { - "type": "object", - "properties": { - "previousLink": { - "$ref": "#/definitions/Link" - }, - "nextLink": { - "$ref": "#/definitions/Link" - } - }, - "description": "Pagination links" - }, - "ApiResponseMessage": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "type": { - "type": "string" - }, - "message": { - "type": "string" - } - } - }, - "Deployment": { - "type": "object", - "properties": { - "id": { - "description": "cloudify deployment name", - "type": "string" - }, - "blueprint_id": { - "description": "cloudify blueprint name", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "tenant_name": { - "type": "string", - "description": "cloudify tenant name" - } - } - }, - "InlineResponse2001": { - "type": "object", - "properties": { - "links": { - "$ref": "#/definitions/InlineResponse200Links" - }, - "totalCount": { - "type": "integer", - "format": "int32" - }, - "items": { - "type": "array", - "items": { - "$ref": "#/definitions/Deployment" - } - } - } - }, - "UriBuilder": { - "type": "object" - }, - "Link": { - "type": "object", - "properties": { - "title": { - "type": "string" - }, - "rel": { - "type": "string" - }, - "uri": { - "type": "string", - "format": "uri" - }, - "uriBuilder": { - "$ref": "#/definitions/UriBuilder" - }, - "rels": { - "type": "array", - "items": { - "type": "string" - } - }, - "params": { - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "type": { - "type": "string" - } - } - }, - "DCAEServiceComponent": { - "type": "object", - "required": [ - "componentId", - "componentLink", - "componentSource", - "componentType", - "created", - "modified", - "shareable" - ], - "properties": { - "componentId": { - "type": "string", - "description": "The id format is unique to the source" - }, - "componentLink": { - "description": "Link to the underlying resource of this component", - "$ref": "#/definitions/Link" - }, - "created": { - "type": "string", - "format": "date-time" - }, - "modified": { - "type": "string", - "format": "date-time" - }, - "componentType": { - "type": "string" - }, - "componentSource": { - "type": "string", - "description": "Specifies the name of the underying source service that is responsible for this components", - "enum": [ - "DCAEController", - "DMaaPController" - ] - }, - "status": { - "type": "string" - }, - "location": { - "type": "string", - "description": "Location information of the component" - }, - "shareable": { - "type": "integer", - "format": "int32", - "description": "Used to determine if this component can be shared amongst different DCAE services" - } - } - }, - "DCAEServiceTypeRequest": { - "type": "object", - "required": [ - "blueprintTemplate", - "owner", - "typeName", - "typeVersion", - "component" - ], - "properties": { - "owner": { - "type": "string" - }, - "typeName": { - "type": "string", - "description": "Descriptive name for this DCAE service type" - }, - "typeVersion": { - "type": "integer", - "format": "int32", - "description": "Version number for this DCAE service type" - }, - "blueprintTemplate": { - "type": "string", - "description": "String representation of a Cloudify blueprint with unbound variables" - }, - "application": { - "type": "string", - "description": "controller application name" - }, - "component": { - "type": "string", - "description": "onboarding component name e.g. dcae" - } - } - }, - "DCAEServiceType": { - "type": "object", - "required": [ - "blueprintTemplate", - "created", - "owner", - "selfLink", - "typeId", - "typeName", - "typeVersion" - ], - "properties": { - "owner": { - "type": "string" - }, - "typeName": { - "type": "string", - "description": "Descriptive name for this DCAE service type" - }, - "typeVersion": { - "type": "integer", - "format": "int32", - "description": "Version number for this DCAE service type" - }, - "blueprintTemplate": { - "type": "string", - "description": "String representation of a Cloudify blueprint with unbound variables" - }, - "serviceIds": { - "type": "array", - "description": "List of service ids that are used to associate with DCAE service type. DCAE service types with this propery as null or empty means them apply for every service id.", - "items": { - "type": "string" - } - }, - "vnfTypes": { - "type": "array", - "items": { - "type": "string" - } - }, - "serviceLocations": { - "type": "array", - "description": "List of service locations that are used to associate with DCAE service type. DCAE service types with this propery as null or empty means them apply for every service location.", - "items": { - "type": "string" - } - }, - "asdcServiceId": { - "type": "string", - "description": "Id of service this DCAE service type is associated with. Value source is from ASDC's notification event's field `serviceInvariantUUID`." - }, - "asdcResourceId": { - "type": "string", - "description": "Id of vf/vnf instance this DCAE service type is associated with. Value source is from ASDC's notification event's field `resourceInvariantUUID`." - }, - "asdcServiceURL": { - "type": "string", - "description": "URL to the ASDC service model" - }, - "typeId": { - "type": "string", - "description": "Unique identifier for this DCAE service type" - }, - "selfLink": { - "description": "Link to self where the Link.title is typeName", - "$ref": "#/definitions/Link" - }, - "created": { - "type": "string", - "format": "date-time", - "description": "Created timestamp for this DCAE service type in epoch time" - }, - "deactivated": { - "type": "string", - "format": "date-time", - "description": "Deactivated timestamp for this DCAE service type in epoch time" - } - } - }, - "DCAEServiceTypeSummary": { - "type": "object", - "required": [ - "created", - "owner", - "selfLink", - "typeId", - "typeName", - "typeVersion", - "application", - "component" - ], - "properties": { - "owner": { - "type": "string" - }, - "typeName": { - "type": "string", - "description": "Descriptive name for this DCAE service type" - }, - "application": { - "type": "string", - "description": "application name" - }, - "component": { - "type": "string", - "description": "component name" - }, - "typeVersion": { - "type": "integer", - "format": "int32", - "description": "Version number for this DCAE service type" - }, - "typeId": { - "type": "string", - "description": "Unique identifier for this DCAE service type" - }, - "created": { - "type": "string", - "format": "date-time", - "description": "Created timestamp for this DCAE service type in epoch time" - } - } - }, - "CloudifyDeploymentUpgradeRequest": { - "type": "object", - "required": [ - "chartVersion", - "chartRepo", - "config_url", - "config_format", - "tenant", - "workflow" - ], - "properties": { - "chartVersion": { - "type": "string", - "description": "Helm package version used for install" - }, - "chartRepo": { - "type": "string", - "description": "Helm repository URL for the chart" - }, - "config_url": { - "type": "string", - "description": "Helm repository URL for the chart values to update" - }, - "config_format": { - "type": "string", - "description": "yaml format or json format" - }, - "tenant": { - "type": "string", - "description": "cloudify tenant name for the deployment upgrade" - }, - "workflow": { - "type": "string", - "description": "input values are upgrade or rollback - helm upgrade workflow or helm rollback workflow " - } - } - }, - "DeploymentInput": { - "type": "object", - "required": [ - "component", - "tag", - "blueprintId", - "tenant", - "inputs" - ], - "properties": { - "component": { - "type": "string", - "description": "component or namespace for the service" - }, - "tag": { - "type": "string", - "description": "unique tag to identify the deployment. A non-unique value results in name conflict error" - }, - "blueprintId": { - "type": "string", - "description": "typeId from inventory, a unique Id for the blueprint, this can be replaced with blueprintName and blueprintVersion" - }, - "blueprintName": { - "type": "string", - "description": "Descriptive name for this DCAE service type" - }, - "blueprintVersion": { - "type": "integer", - "format": "int32", - "description": "Version number for this DCAE service type, optional. Defaults to 1." - }, - "tenant": { - "type": "string", - "description": "cloudify tenant name" - }, - "inputs": { - "type": "object", - "description": "JSON object containing the input parameter names and values" - } - } - }, - "deploymentInputs": { - "type": "object" - }, - "serviceHealth": { - "type": "object", - "properties": { - "node": { - "type": "string", - "description": "The node where service is deployed" - }, - "checkID": { - "type": "string", - "description": "A unique identifier for the service health check" - }, - "name": { - "type": "string", - "description": "A unique name for this service health check" - }, - "status": { - "type": "string", - "description": "Health check status" - }, - "serviceID": { - "type": "string", - "description": "An identifier containing combination of consul registration ID and consul service name" - }, - "serviceName": { - "type": "string", - "description": "A unique consul service name" - } - } - }, - "execution": { - "type": "object", - "properties": { - "created_at": { - "type": "string", - "description": "The time the execution was queued at" - }, - "deployment_id": { - "type": "string", - "description": "The id of the deployment the execution is in the context of" - }, - "id": { - "type": "string", - "description": "A unique identifier for the execution" - }, - "status": { - "type": "string", - "description": "The executions status" - }, - "workflow_id": { - "type": "string", - "description": "The id/name of the workflow the execution is of" - }, - "tenant_name": { - "type": "string", - "description": "Cloudify tenant name where the deployment was done" - } - } - }, - "DeploymentResourceLinks": { - "type": "object", - "properties": { - "self": { - "description": "Link to retrieve information about the service being deployed", - "type": "string" - }, - "outcome": { - "description": "Link to retrieve information about deployment outcome", - "type": "string" - }, - "status": { - "description": "Link to retrieve information about the status of the installation workflow", - "type": "string" - } - } - }, - "DeploymentResource": { - "type": "object", - "properties": { - "deployment_id": { - "type": "string", - "description": "unique ID for the deployment resource" - }, - "links": { - "$ref": "#/definitions/DeploymentResourceLinks", - "description": "Links that the API client can access" - } - } - } - }, - "externalDocs": { - "description": "Find out more about Swagger", - "url": "http://swagger.io" - } -}
\ No newline at end of file diff --git a/docs/sections/apis/dcaedashboard.rst b/docs/sections/apis/dcaedashboard.rst deleted file mode 100644 index c6a2e182..00000000 --- a/docs/sections/apis/dcaedashboard.rst +++ /dev/null @@ -1,26 +0,0 @@ -.. This work is licensed under a - Creative Commons Attribution 4.0 International License. - -DCAE Dashboard -============== - -.. toctree:: - :maxdepth: 3 - -Description -~~~~~~~~~~~ - -DCAE Dashboard is a web application that provides a single interface for -DCAE users and Ops users in ONAP to deploy and manage DCAE microservices. - -.. csv-table:: - :header: "API name", "Swagger JSON" - :widths: 10,5 - - "DCAE Dashboard", ":download:`link <dcaedashboard.json>`" - -Contact Information -~~~~~~~~~~~~~~~~~~~ - -onap-discuss@lists.onap.org - diff --git a/docs/sections/apis/deployment-handler-API.json b/docs/sections/apis/deployment-handler-API.json deleted file mode 100644 index f72cc183..00000000 --- a/docs/sections/apis/deployment-handler-API.json +++ /dev/null @@ -1,561 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "4.3.0", - "title": "deployment-handler API", - "license": { - "name": "Apache 2.0", - "url": "http://www.apache.org/licenses/LICENSE-2.0.html" - }, - "description": "High-level API for deploying/undeploying composed DCAE services using Cloudify Manager.\n" - }, - "tags": [ - { - "name": "info", - "description": "version and links" - }, - { - "name": "dcae-deployments", - "description": "operations on dcae-deployments" - }, - { - "name": "policy", - "description": "policy update API consumed by policy-handler and debug API to find policies on components" - } - ], - "paths": { - "/": { - "get": { - "tags": [ - "info" - ], - "description": "Returns version information and links to API operations", - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "title": "DispatcherInfo", - "type": "object", - "properties": { - "apiVersion": { - "type": "string", - "description": "version of API supported by this server\n" - }, - "serverVersion": { - "type": "string", - "description": "version of software running on this server\n" - }, - "links": { - "type": "object", - "description": "Links to API resources\n", - "properties": { - "info": { - "type": "string", - "description": "path for the server information endpoint\n" - }, - "events": { - "type": "string", - "description": "path for the events endpoint\n" - } - } - } - } - } - } - } - } - }, - "/dcae-deployments": { - "get": { - "tags": [ - "dcae-deployments" - ], - "description": "List service deployments known to the orchestrator, optionally restricted to a single service type\n", - "parameters": [ - { - "name": "serviceTypeId", - "description": "Service type identifier for the type whose deployments are to be listed\n", - "type": "string", - "in": "query", - "required": false - } - ], - "responses": { - "200": { - "description": "Success. (Note that if no matching deployments are found, the request is still a success; the\ndeployments array is empty in that case.)\n", - "schema": { - "$ref": "#/definitions/DCAEDeploymentsListResponse" - } - }, - "500": { - "description": "Problem on the server side. See the message\nin the response for more details.\n", - "schema": { - "$ref": "#/definitions/DCAEErrorResponse" - } - }, - "502": { - "description": "Error reported to the dispatcher by a downstream system. See the message\nin the response for more details.\n", - "schema": { - "$ref": "#/definitions/DCAEErrorResponse" - } - }, - "504": { - "description": "Error communicating with a downstream system. See the message\nin the response for more details.\n", - "schema": { - "$ref": "#/definitions/DCAEErrorResponse" - } - } - } - } - }, - "/dcae-deployments/{deploymentId}": { - "put": { - "tags": [ - "dcae-deployments" - ], - "description": "Request deployment of a DCAE service\n", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "deploymentId", - "description": "Unique deployment identifier assigned by the API client.\n", - "in": "path", - "type": "string", - "required": true - }, - { - "name": "body", - "in": "body", - "schema": { - "$ref": "#/definitions/DCAEDeploymentRequest" - }, - "required": true - } - ], - "responses": { - "202": { - "description": "Success: The content that was posted is valid, the dispatcher has\n found the needed blueprint, created an instance of the topology in the orchestrator,\n and started an installation workflow.\n", - "schema": { - "$ref": "#/definitions/DCAEDeploymentResponse" - } - }, - "400": { - "description": "Bad request: See the message in the response for details.\n", - "schema": { - "$ref": "#/definitions/DCAEErrorResponse" - } - }, - "409": { - "description": "A service with the specified deployment Id already exists. Using PUT to update the service is not a supported operation.\n", - "schema": { - "$ref": "#/definitions/DCAEErrorResponse" - } - }, - "415": { - "description": "Bad request: The Content-Type header does not indicate that the content is\n'application/json'\n", - "schema": { - "$ref": "#/definitions/DCAEErrorResponse" - } - }, - "500": { - "description": "Problem on the server side. See the message\nin the response for more details.\n", - "schema": { - "$ref": "#/definitions/DCAEErrorResponse" - } - }, - "502": { - "description": "Error reported to the dispatcher by a downstream system. See the message\nin the response for more details.\n", - "schema": { - "$ref": "#/definitions/DCAEErrorResponse" - } - }, - "504": { - "description": "Error communicating with a downstream system. See the message\nin the response for more details.\n", - "schema": { - "$ref": "#/definitions/DCAEErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "dcae-deployments" - ], - "description": "Uninstall the DCAE service and remove all associated data from the orchestrator.\n", - "parameters": [ - { - "name": "deploymentId", - "description": "Deployment identifier for the service to be uninstalled.\n", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "202": { - "description": "Success: The dispatcher has initiated the uninstall operation.\n", - "schema": { - "$ref": "#/definitions/DCAEDeploymentResponse" - } - }, - "400": { - "description": "Bad request: See the message in the response for details.\n", - "schema": { - "$ref": "#/definitions/DCAEErrorResponse" - } - }, - "500": { - "description": "Problem on the server side. See the message\nin the response for more details.\n", - "schema": { - "$ref": "#/definitions/DCAEErrorResponse" - } - }, - "502": { - "description": "Error reported to the dispatcher by a downstream system. See the message\nin the response for more details.\n", - "schema": { - "$ref": "#/definitions/DCAEErrorResponse" - } - }, - "504": { - "description": "Error communicating with a downstream system. See the message\nin the response for more details.\n", - "schema": { - "$ref": "#/definitions/DCAEErrorResponse" - } - } - } - } - }, - "/dcae-deployments/{deploymentId}/operation/{operationId}": { - "get": { - "tags": [ - "dcae-deployments" - ], - "description": "Get status of a deployment operation\n", - "parameters": [ - { - "name": "deploymentId", - "in": "path", - "type": "string", - "required": true - }, - { - "name": "operationId", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "Status information retrieved successfully", - "schema": { - "$ref": "#/definitions/DCAEOperationStatusResponse" - } - }, - "404": { - "description": "The operation information does not exist (possibly because the service has been uninstalled and deleted).", - "schema": { - "$ref": "#/definitions/DCAEErrorResponse" - } - }, - "500": { - "description": "Problem on the server side. See the message\nin the response for more details.\n", - "schema": { - "$ref": "#/definitions/DCAEErrorResponse" - } - }, - "502": { - "description": "Error reported to the dispatcher by a downstream system. See the message\nin the response for more details.\n", - "schema": { - "$ref": "#/definitions/DCAEErrorResponse" - } - }, - "504": { - "description": "Error communicating with a downstream system. See the message\nin the response for more details.\n", - "schema": { - "$ref": "#/definitions/DCAEErrorResponse" - } - } - } - } - }, - "/policy": { - "post": { - "tags": [ - "policy" - ], - "description": "policy update API consumed by policy-handler", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "body", - "in": "body", - "schema": { - "$ref": "#/definitions/DCAEPolicyRequest" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "deployment-handler always responds with ok to /policy before processing the request" - } - } - } - }, - "/policy/components": { - "get": { - "tags": [ - "policy" - ], - "description": "debug API to find policies on components", - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "deployment-handler found components with or without policies in cloudify" - } - } - } - } - }, - "definitions": { - "DCAEDeploymentRequest": { - "description": "Request for deploying a DCAE service.\n", - "type": "object", - "required": [ - "serviceTypeId" - ], - "properties": { - "serviceTypeId": { - "description": "The service type identifier (a unique ID assigned by DCAE inventory) for the service to be deployed.\n", - "type": "string" - }, - "inputs": { - "description": "Object containing inputs needed by the service blueprint to create an instance of the service.\nContent of the object depends on the service being deployed.\n", - "type": "object" - } - } - }, - "DCAEDeploymentResponse": { - "description": "Response body for a PUT or DELETE to /dcae-deployments/{deploymentId}\n", - "type": "object", - "required": [ - "requestId", - "links" - ], - "properties": { - "requestId": { - "type": "string", - "description": "Unique identifier for the request\n" - }, - "links": { - "description": "Links that the API client can access.\n", - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "Link used to retrieve information about the service being deployed\n" - }, - "status": { - "type": "string", - "description": "Link used to retrieve information about the status of the installation workflow" - } - } - } - } - }, - "DCAEOperationStatusResponse": { - "description": "Response body for a request for status of an installation or uninstallation operation.\n", - "type": "object", - "required": [ - "requestId", - "operationType", - "status" - ], - "properties": { - "requestId": { - "type": "string", - "description": "A unique identifier assigned to the request. Useful for tracing a request through logs.\n" - }, - "operationType": { - "description": "Type of operation being reported on. (\"install\" or \"uninstall\")\n", - "type": "string" - }, - "status": { - "description": "Status of the installation or uninstallation operation. Possible values are \"processing\",\n\"succeeded\", and \"failed\"\n", - "type": "string" - }, - "error": { - "description": "If status is \"failed\", this field will be present and contain additional information about the reason the operation failed.\n", - "type": "string" - }, - "links": { - "description": "If the operation succeeded, links that the client can follow to take further action. Note that a successful \"uninstall\" operation removes the DCAE service instance completely, so there are no possible further actions, and no links.\n", - "type": "object", - "properties": { - "self": { - "type": "string", - "description": "Link used to retrieve information about the service.\n" - }, - "uninstall": { - "type": "string", - "description": "Link used to trigger an \"uninstall\" operation for the service. (Use the DELETE method.)" - } - } - } - } - }, - "DCAEErrorResponse": { - "description": "Object reporting an error.\n", - "type": "object", - "required": [ - "status" - ], - "properties": { - "status": { - "description": "HTTP status code for the response", - "type": "integer" - }, - "message": { - "description": "Human-readable description of the reason for the error", - "type": "string" - } - } - }, - "DCAEDeploymentsListResponse": { - "description": "Object providing a list of deployments\n", - "type": "object", - "required": [ - "requestId", - "deployments" - ], - "properties": { - "requestId": { - "type": "string", - "description": "Unique identifier for the request\n" - }, - "deployments": { - "type": "array", - "items": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "URL for the service deployment\n" - } - } - } - } - } - }, - "DCAEPolicyBody": { - "description": "policy_body - the whole object received from policy-engine", - "type": "object", - "required": [ - "policyName", - "policyVersion", - "config" - ], - "properties": { - "policyName": { - "description": "unique policy name that contains the version and extension", - "type": "string" - }, - "policyVersion": { - "description": "stringified int that is autoincremented by policy-engine", - "type": "string" - }, - "config": { - "description": "the policy-config - the config data provided by policy owner", - "type": "object" - } - } - }, - "DCAEPolicy": { - "description": "policy object", - "type": "object", - "required": [ - "policy_id", - "policy_body" - ], - "properties": { - "policy_id": { - "description": "unique identifier of policy regardless of its version", - "type": "string" - }, - "policy_body": { - "$ref": "#/definitions/DCAEPolicyBody" - } - } - }, - "DCAEPolicyRequest": { - "description": "request to update policies on DCAE components.", - "type": "object", - "required": [ - "catch_up", - "latest_policies", - "removed_policies" - ], - "properties": { - "catch_up": { - "description": "flag to indicate whether the request contains all the policies in PDP or not", - "type": "boolean", - "default": false - }, - "latest_policies": { - "description": "dictionary of (policy_id -> DCAEPolicy object).\nIn example: replace additionalProp1,2,3 with policy_id1,2,3 values\n", - "type": "object", - "default": {}, - "additionalProperties": { - "$ref": "#/definitions/DCAEPolicy" - } - }, - "removed_policies": { - "description": "whether policy was removed from policy-engine.\ndictionary of (policy_id -> true).\nIn example: replace additionalProp1,2,3 with policy_id1,2,3 values\n", - "type": "object", - "default": {}, - "additionalProperties": { - "type": "boolean" - } - }, - "errored_policies": { - "description": "whether policy-engine returned an error on the policy.\ndictionary of (policy_id -> true).\nIn example: replace additionalProp1,2,3 with policy_id1,2,3 values\n", - "type": "object", - "default": {}, - "additionalProperties": { - "type": "boolean" - } - }, - "errored_scopes": { - "description": "on cartchup - list of policy scope_prefix values on wchich the policy-engine experienced an error other than not-found data.\n", - "type": "array", - "items": { - "type": "string" - } - }, - "scope_prefixes": { - "description": "on catchup - list of all scope_prefixes used by the policy-handler to retrieve the policies from policy-engine.\n", - "type": "array", - "items": { - "type": "string" - } - } - } - } - } -} diff --git a/docs/sections/apis/deployment-handler-API.yaml b/docs/sections/apis/deployment-handler-API.yaml deleted file mode 100644 index edf55821..00000000 --- a/docs/sections/apis/deployment-handler-API.yaml +++ /dev/null @@ -1,541 +0,0 @@ -# ================================================================================ -# Copyright (c) 2017-2018 AT&T Intellectual Property. All rights reserved. -# ================================================================================ -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# ============LICENSE_END========================================================= - ---- - -swagger: '2.0' - -info: - version: "4.3.0" - title: "deployment-handler API" - license: - name: "Apache 2.0" - url: "http://www.apache.org/licenses/LICENSE-2.0.html" - description: | - High-level API for deploying/undeploying composed DCAE services using Cloudify Manager. - -tags: - - name: "info" - description: "version and links" - - name: "dcae-deployments" - description: "operations on dcae-deployments" - - name: "policy" - description: "policy update API consumed by policy-handler and debug API to find policies on components" - -paths: - /: - get: - tags: - - "info" - description: Returns version information and links to API operations - produces: - - "application/json" - responses: - - 200: - description: Success - schema: - title: DispatcherInfo - type: object - properties: - apiVersion: - type: string - description: | - version of API supported by this server - serverVersion: - type: string - description: | - version of software running on this server - links: - type: object - description: | - Links to API resources - properties: - info: - type: string - description: | - path for the server information endpoint - events: - type: string - description: | - path for the events endpoint - - /dcae-deployments: - get: - tags: - - "dcae-deployments" - description: | - List service deployments known to the orchestrator, optionally restricted to a single service type - - parameters: - - name: serviceTypeId - description: | - Service type identifier for the type whose deployments are to be listed - type: string - in: query - required: false - - responses: - - 200: - description: | - Success. (Note that if no matching deployments are found, the request is still a success; the - deployments array is empty in that case.) - schema: - $ref: "#/definitions/DCAEDeploymentsListResponse" - - 500: - description: | - Problem on the server side. See the message - in the response for more details. - schema: - $ref: "#/definitions/DCAEErrorResponse" - 502: - description: | - Error reported to the dispatcher by a downstream system. See the message - in the response for more details. - schema: - $ref: "#/definitions/DCAEErrorResponse" - - 504: - description: | - Error communicating with a downstream system. See the message - in the response for more details. - schema: - $ref: "#/definitions/DCAEErrorResponse" - - /dcae-deployments/{deploymentId}: - put: - tags: - - "dcae-deployments" - description: | - Request deployment of a DCAE service - - consumes: - - application/json - produces: - - application/json - - parameters: - - name: deploymentId - description: | - Unique deployment identifier assigned by the API client. - in: path - type: string - required: true - - - name: body - in: body - schema: - $ref: "#/definitions/DCAEDeploymentRequest" - required: true - - responses: - - 202: - description: | - Success: The content that was posted is valid, the dispatcher has - found the needed blueprint, created an instance of the topology in the orchestrator, - and started an installation workflow. - schema: - $ref: "#/definitions/DCAEDeploymentResponse" - - 400: - description: | - Bad request: See the message in the response for details. - schema: - $ref: "#/definitions/DCAEErrorResponse" - - 409: - description: | - A service with the specified deployment Id already exists. Using PUT to update the service is not a supported operation. - schema: - $ref: "#/definitions/DCAEErrorResponse" - - 415: - description: | - Bad request: The Content-Type header does not indicate that the content is - 'application/json' - schema: - $ref: "#/definitions/DCAEErrorResponse" - - 500: - description: | - Problem on the server side. See the message - in the response for more details. - schema: - $ref: "#/definitions/DCAEErrorResponse" - - 502: - description: | - Error reported to the dispatcher by a downstream system. See the message - in the response for more details. - schema: - $ref: "#/definitions/DCAEErrorResponse" - - 504: - description: | - Error communicating with a downstream system. See the message - in the response for more details. - schema: - $ref: "#/definitions/DCAEErrorResponse" - - delete: - tags: - - "dcae-deployments" - description: | - Uninstall the DCAE service and remove all associated data from the orchestrator. - - parameters: - - name: deploymentId - description: | - Deployment identifier for the service to be uninstalled. - in: path - type: string - required: true - - responses: - - 202: - description: | - Success: The dispatcher has initiated the uninstall operation. - schema: - $ref: "#/definitions/DCAEDeploymentResponse" - - 400: - description: | - Bad request: See the message in the response for details. - schema: - $ref: "#/definitions/DCAEErrorResponse" - - 500: - description: | - Problem on the server side. See the message - in the response for more details. - schema: - $ref: "#/definitions/DCAEErrorResponse" - - 502: - description: | - Error reported to the dispatcher by a downstream system. See the message - in the response for more details. - schema: - $ref: "#/definitions/DCAEErrorResponse" - - 504: - description: | - Error communicating with a downstream system. See the message - in the response for more details. - schema: - $ref: "#/definitions/DCAEErrorResponse" - - /dcae-deployments/{deploymentId}/operation/{operationId}: - get: - tags: - - "dcae-deployments" - description: | - Get status of a deployment operation - parameters: - - name: deploymentId - in: path - type: string - required: true - - name: operationId - in: path - type: string - required: true - - responses: - - 200: - description: Status information retrieved successfully - schema: - $ref: "#/definitions/DCAEOperationStatusResponse" - - 404: - description: The operation information does not exist (possibly because the service has been uninstalled and deleted). - schema: - $ref: "#/definitions/DCAEErrorResponse" - - 500: - description: | - Problem on the server side. See the message - in the response for more details. - schema: - $ref: "#/definitions/DCAEErrorResponse" - - 502: - description: | - Error reported to the dispatcher by a downstream system. See the message - in the response for more details. - schema: - $ref: "#/definitions/DCAEErrorResponse" - - 504: - description: | - Error communicating with a downstream system. See the message - in the response for more details. - schema: - $ref: "#/definitions/DCAEErrorResponse" - - /policy: - post: - tags: - - "policy" - description: policy update API consumed by policy-handler - - consumes: - - application/json - produces: - - application/json - - parameters: - - name: body - in: body - schema: - $ref: "#/definitions/DCAEPolicyRequest" - required: true - - responses: - 200: - description: deployment-handler always responds with ok to /policy before processing the request - - /policy/components: - get: - tags: - - "policy" - description: debug API to find policies on components - produces: - - application/json - - responses: - 200: - description: deployment-handler found components with or without policies in cloudify - - -definitions: - - DCAEDeploymentRequest: - description: | - Request for deploying a DCAE service. - type: - object - required: [serviceTypeId] - - properties: - - serviceTypeId: - description: | - The service type identifier (a unique ID assigned by DCAE inventory) for the service to be deployed. - type: string - - inputs: - description: | - Object containing inputs needed by the service blueprint to create an instance of the service. - Content of the object depends on the service being deployed. - type: object - - DCAEDeploymentResponse: - description: | - Response body for a PUT or DELETE to /dcae-deployments/{deploymentId} - type: object - - required: [requestId, links] - - properties: - requestId: - type: string - description: | - Unique identifier for the request - links: - description: | - Links that the API client can access. - type: object - properties: - self: - type: string - description: | - Link used to retrieve information about the service being deployed - status: - type: string - description: - Link used to retrieve information about the status of the installation workflow - - DCAEOperationStatusResponse: - description: | - Response body for a request for status of an installation or uninstallation operation. - type: object - - required: [requestId, operationType, status] - - properties: - requestId: - type: string - description: | - A unique identifier assigned to the request. Useful for tracing a request through logs. - operationType: - description: | - Type of operation being reported on. ("install" or "uninstall") - type: string - status: - description: | - Status of the installation or uninstallation operation. Possible values are "processing", - "succeeded", and "failed" - type: string - error: - description: | - If status is "failed", this field will be present and contain additional information about the reason the operation failed. - type: string - links: - description: | - If the operation succeeded, links that the client can follow to take further action. Note that a successful "uninstall" operation removes the DCAE service instance completely, so there are no possible further actions, and no links. - type: object - properties: - self: - type: string - description: | - Link used to retrieve information about the service. - uninstall: - type: string - description: - Link used to trigger an "uninstall" operation for the service. (Use the DELETE method.) - - DCAEErrorResponse: - description: | - Object reporting an error. - type: - object - required: [status] - - properties: - status: - description: HTTP status code for the response - type: integer - - message: - description: Human-readable description of the reason for the error - type: string - - DCAEDeploymentsListResponse: - description: | - Object providing a list of deployments - type: object - required: [requestId, deployments] - - properties: - requestId: - type: string - description: | - Unique identifier for the request - deployments: - type: array - items: - type: object - properties: - href: - type: string - description: | - URL for the service deployment - - DCAEPolicyBody: - description: policy_body - the whole object received from policy-engine - type: object - required: - - policyName - - policyVersion - - config - properties: - policyName: - description: unique policy name that contains the version and extension - type: string - policyVersion: - description: stringified int that is autoincremented by policy-engine - type: string - config: - description: the policy-config - the config data provided by policy owner - type: object - - DCAEPolicy: - description: policy object - type: object - required: - - policy_id - - policy_body - properties: - policy_id: - description: unique identifier of policy regardless of its version - type: string - policy_body: - $ref: "#/definitions/DCAEPolicyBody" - - DCAEPolicyRequest: - description: request to update policies on DCAE components. - type: object - required: - - catch_up - - latest_policies - - removed_policies - - properties: - catch_up: - description: flag to indicate whether the request contains all the policies in PDP or not - type: boolean - default: false - - latest_policies: - description: | - dictionary of (policy_id -> DCAEPolicy object). - In example: replace additionalProp1,2,3 with policy_id1,2,3 values - type: object - default: {} - additionalProperties: - $ref: "#/definitions/DCAEPolicy" - - removed_policies: - description: | - whether policy was removed from policy-engine. - dictionary of (policy_id -> true). - In example: replace additionalProp1,2,3 with policy_id1,2,3 values - type: object - default: {} - additionalProperties: - type: boolean - - errored_policies: - description: | - whether policy-engine returned an error on the policy. - dictionary of (policy_id -> true). - In example: replace additionalProp1,2,3 with policy_id1,2,3 values - type: object - default: {} - additionalProperties: - type: boolean - - errored_scopes: - description: > - on cartchup - list of policy scope_prefix values on wchich - the policy-engine experienced an error other than not-found data. - type: array - items: - type: string - - scope_prefixes: - description: > - on catchup - list of all scope_prefixes used by the policy-handler - to retrieve the policies from policy-engine. - type: array - items: - type: string diff --git a/docs/sections/apis/deployment-handler.rst b/docs/sections/apis/deployment-handler.rst deleted file mode 100644 index a35bc8bd..00000000 --- a/docs/sections/apis/deployment-handler.rst +++ /dev/null @@ -1,944 +0,0 @@ -.. This work is licensed under a - Creative Commons Attribution 4.0 International License. - -Deployment-Handler -================== - -.. toctree:: - :maxdepth: 3 - -.. csv-table:: - :header: "API name", "Swagger JSON", "Swagger YAML" - :widths: 10,5,5 - - "deployment-handler", ":download:`link <deployment-handler-API.json>`", ":download:`link <deployment-handler-API.yaml>`" - -Description -~~~~~~~~~~~ - -High-level API for deploying/undeploying composed DCAE services using -Cloudify Manager. - -License -~~~~~~~ - -`Apache 2.0 <http://www.apache.org/licenses/LICENSE-2.0.html>`_ - -DCAE-DEPLOYMENTS -~~~~~~~~~~~~~~~~ - -operations on dcae-deployments - -DELETE ``/dcae-deployments/{deploymentId}`` -------------------------------------------- - -Description -+++++++++++ - -.. raw:: html - - Uninstall the DCAE service and remove all associated data from the orchestrator. - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - deploymentId | path | Yes | string | | | Deployment identifier for the service to be uninstalled. - -Request -+++++++ - -Responses -+++++++++ - -**202** -^^^^^^^ - -Success: The dispatcher has initiated the uninstall operation. - -Type: :ref:`DCAEDeploymentResponse <d_6157bd3de5c8c7de78f2ab86397667e0>` - -**Example:** - -.. code-block:: javascript - - { - "links": { - "self": "somestring", - "status": "somestring" - }, - "requestId": "somestring" - } - -**400** -^^^^^^^ - -Bad request: See the message in the response for details. - -Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` - -**Example:** - -.. code-block:: javascript - - { - "message": "somestring", - "status": 1 - } - -**500** -^^^^^^^ - -Problem on the server side. See the message -in the response for more details. - -Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` - -**Example:** - -.. code-block:: javascript - - { - "message": "somestring", - "status": 1 - } - -**502** -^^^^^^^ - -Error reported to the dispatcher by a downstream system. See the message -in the response for more details. - -Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` - -**Example:** - -.. code-block:: javascript - - { - "message": "somestring", - "status": 1 - } - -**504** -^^^^^^^ - -Error communicating with a downstream system. See the message -in the response for more details. - -Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` - -**Example:** - -.. code-block:: javascript - - { - "message": "somestring", - "status": 1 - } - -GET ``/dcae-deployments`` -------------------------- - -Description -+++++++++++ - -.. raw:: html - - List service deployments known to the orchestrator, optionally restricted to a single service type - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - serviceTypeId | query | No | string | | | Service type identifier for the type whose deployments are to be listed - -Request -+++++++ - -Responses -+++++++++ - -**200** -^^^^^^^ - -Success. (Note that if no matching deployments are found, the request is still -a success; the deployments array is empty in that case.) - -Type: :ref:`DCAEDeploymentsListResponse <d_c51e57d9583f6119caf83dd017cf214c>` - -**Example:** - -.. code-block:: javascript - - { - "deployments": [ - { - "href": "somestring" - }, - { - "href": "somestring" - } - ], - "requestId": "somestring" - } - -**500** -^^^^^^^ - -Problem on the server side. See the message -in the response for more details. - -Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` - -**Example:** - -.. code-block:: javascript - - { - "message": "somestring", - "status": 1 - } - -**502** -^^^^^^^ - -Error reported to the dispatcher by a downstream system. See the message -in the response for more details. - -Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` - -**Example:** - -.. code-block:: javascript - - { - "message": "somestring", - "status": 1 - } - -**504** -^^^^^^^ - -Error communicating with a downstream system. See the message -in the response for more details. - -Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` - -**Example:** - -.. code-block:: javascript - - { - "message": "somestring", - "status": 1 - } - -GET ``/dcae-deployments/{deploymentId}/operation/{operationId}`` ----------------------------------------------------------------- - -Description -+++++++++++ - -.. raw:: html - - Get status of a deployment operation - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - deploymentId | path | Yes | string | | | - operationId | path | Yes | string | | | - -Request -+++++++ - -Responses -+++++++++ - -**200** -^^^^^^^ - -Status information retrieved successfully - -Type: :ref:`DCAEOperationStatusResponse <d_f0103f05736b04468a4f85fe90da2e16>` - -**Example:** - -.. code-block:: javascript - - { - "error": "somestring", - "links": { - "self": "somestring", - "uninstall": "somestring" - }, - "operationType": "somestring", - "requestId": "somestring", - "status": "somestring" - } - -**404** -^^^^^^^ - -The operation information does not exist (possibly because the service has been -uninstalled and deleted). - -Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` - -**Example:** - -.. code-block:: javascript - - { - "message": "somestring", - "status": 1 - } - -**500** -^^^^^^^ - -Problem on the server side. See the message -in the response for more details. - -Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` - -**Example:** - -.. code-block:: javascript - - { - "message": "somestring", - "status": 1 - } - -**502** -^^^^^^^ - -Error reported to the dispatcher by a downstream system. See the message -in the response for more details. - -Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` - -**Example:** - -.. code-block:: javascript - - { - "message": "somestring", - "status": 1 - } - -**504** -^^^^^^^ - -Error communicating with a downstream system. See the message -in the response for more details. - -Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` - -**Example:** - -.. code-block:: javascript - - { - "message": "somestring", - "status": 1 - } - -PUT ``/dcae-deployments/{deploymentId}`` ----------------------------------------- - -Description -+++++++++++ - -.. raw:: html - - Request deployment of a DCAE service - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - deploymentId | path | Yes | string | | | Unique deployment identifier assigned by the API client. - -Request -+++++++ - -.. _d_eea14e4929853a5aa415f44cd4868302: - -Body -^^^^ - -Request for deploying a DCAE service. - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - inputs | No | | | | Object containing inputs needed by the service blueprint to create an instance of the service. Content of the object depends on the service being deployed. - serviceTypeId | Yes | string | | | The service type identifier (a unique ID assigned by DCAE inventory) for the service to be deployed. - -.. _i_08ada55a389e24cd45beef83306fd08e: - -**Inputs schema:** - -Object containing inputs needed by the service blueprint to create an instance -of the service. Content of the object depends on the service being deployed. - -.. code-block:: javascript - - { - "inputs": {}, - "serviceTypeId": "somestring" - } - -Responses -+++++++++ - -**202** -^^^^^^^ - -Success: The content that was posted is valid, the dispatcher has - found the needed blueprint, created an instance of the topology in the - orchestrator, and started an installation workflow. - -Type: :ref:`DCAEDeploymentResponse <d_6157bd3de5c8c7de78f2ab86397667e0>` - -**Example:** - -.. code-block:: javascript - - { - "links": { - "self": "somestring", - "status": "somestring" - }, - "requestId": "somestring" - } - -**400** -^^^^^^^ - -Bad request: See the message in the response for details. - -Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` - -**Example:** - -.. code-block:: javascript - - { - "message": "somestring", - "status": 1 - } - -**409** -^^^^^^^ - -A service with the specified deployment Id already exists. Using PUT to update -the service is not a supported operation. - -Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` - -**Example:** - -.. code-block:: javascript - - { - "message": "somestring", - "status": 1 - } - -**415** -^^^^^^^ - -Bad request: The Content-Type header does not indicate that the content is -'application/json' - -Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` - -**Example:** - -.. code-block:: javascript - - { - "message": "somestring", - "status": 1 - } - -**500** -^^^^^^^ - -Problem on the server side. See the message -in the response for more details. - -Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` - -**Example:** - -.. code-block:: javascript - - { - "message": "somestring", - "status": 1 - } - -**502** -^^^^^^^ - -Error reported to the dispatcher by a downstream system. See the message -in the response for more details. - -Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` - -**Example:** - -.. code-block:: javascript - - { - "message": "somestring", - "status": 1 - } - -**504** -^^^^^^^ - -Error communicating with a downstream system. See the message -in the response for more details. - -Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` - -**Example:** - -.. code-block:: javascript - - { - "message": "somestring", - "status": 1 - } - - -INFO -~~~~ - -version and links - -GET ``/`` ---------- - -Description -+++++++++++ - -.. raw:: html - - Returns version information and links to API operations - -Request -+++++++ - -Responses -+++++++++ - -**200** -^^^^^^^ - -Success - -.. _i_2e7b26d45eaa7203222963d454a86a88: - -**Response Schema:** - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - apiVersion | No | string | | | version of API supported by this server - - links | No | :ref:`links <i_bcea41e897f5de95cd50fa873acb5f65>` | | | Links to API resources - - serverVersion | No | string | | | version of software running on this server - -.. _i_bcea41e897f5de95cd50fa873acb5f65: - -**Links schema:** - -Links to API resources - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - events | No | string | | | path for the events endpoint - - info | No | string | | | path for the server information endpoint - -**Example:** - -.. code-block:: javascript - - { - "apiVersion": "somestring", - "links": { - "events": "somestring", - "info": "somestring" - }, - "serverVersion": "somestring" - } - - -POLICY -~~~~~~ - -policy update API consumed by policy-handler and debug API to find policies -on components - -GET ``/policy/components`` --------------------------- - -Description -+++++++++++ - -.. raw:: html - - debug API to find policies on components - -Request -+++++++ - -Responses -+++++++++ - -**200** -^^^^^^^ - -deployment-handler found components with or without policies in cloudify - - -POST ``/policy`` ----------------- - -Description -+++++++++++ - -.. raw:: html - - policy update API consumed by policy-handler - -Request -+++++++ - -.. _d_6ea6e6f48a0302e963a67833bbd0ff4a: - -Body -^^^^ - -request to update policies on DCAE components. - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - catch_up | Yes | boolean | | | flag to indicate whether the request contains all the policies in PDP or not - errored_policies | No | | | | whether policy-engine returned an error on the policy. - errored_scopes | No | array of string | | | on cartchup - list of policy scope_prefix values on wchich the policy-engine experienced an error other than not-found data. - latest_policies | Yes | | | | dictionary of (policy_id -> DCAEPolicy object). - removed_policies | Yes | | | | whether policy was removed from policy-engine. - scope_prefixes | No | array of string | | | on catchup - list of all scope_prefixes used by the policy-handler to retrieve the policies from policy-engine. - -.. _i_0e88fa72c5312eaae3990753181ce5fe: - -**Errored_policies schema:** - -whether policy-engine returned an error on the policy. -dictionary of (policy_id -> true). -In example: replace additionalProp1,2,3 with policy_id1,2,3 values - -Map of {"key":"boolean"} - -.. _i_cbc40bad95bddbd536eeab0a92f483af: - -**Latest_policies schema:** - -dictionary of (policy_id -> DCAEPolicy object). -In example: replace additionalProp1,2,3 with policy_id1,2,3 values - -Map of {"key":":ref:`DCAEPolicy <d_1e3e880a733b457b648bd8c99e6c859c>`"} - -.. _i_0ce52a29e44aa0cc7929fe7b555551bc: - -**Removed_policies schema:** - -whether policy was removed from policy-engine. -dictionary of (policy_id -> true). -In example: replace additionalProp1,2,3 with policy_id1,2,3 values - -Map of {"key":"boolean"} - -.. code-block:: javascript - - { - "catch_up": true, - "errored_policies": {}, - "errored_scopes": [ - "somestring", - "somestring" - ], - "latest_policies": { - "DCAEPolicy": { - "policy_body": { - "config": {}, - "policyName": "somestring", - "policyVersion": "somestring" - }, - "policy_id": "somestring" - } - }, - "removed_policies": {}, - "scope_prefixes": [ - "somestring", - "somestring" - ] - } - -Responses -+++++++++ - -**200** -^^^^^^^ - -deployment-handler always responds with ok to /policy before processing -the request - - -Data Structures -~~~~~~~~~~~~~~~ - -DCAEDeploymentRequest Model Structure -------------------------------------- - -Request for deploying a DCAE service. - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - inputs | No | | | | Object containing inputs needed by the service blueprint to create an instance of the service. - serviceTypeId | Yes | string | | | The service type identifier (a unique ID assigned by DCAE inventory) for the service to be deployed. - -**Inputs schema:** - -Object containing inputs needed by the service blueprint to create an instance -of the service. Content of the object depends on the service being deployed. - -.. _d_6157bd3de5c8c7de78f2ab86397667e0: - -DCAEDeploymentResponse Model Structure --------------------------------------- - -Response body for a PUT or DELETE to /dcae-deployments/{deploymentId} - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - links | Yes | :ref:`links <i_4a894329f99280d2268e250444b59376>` | | | Links that the API client can access. - - requestId | Yes | string | | | Unique identifier for the request - -.. _i_4a894329f99280d2268e250444b59376: - -**Links schema:** - -Links that the API client can access. - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - self | No | string | | | Link used to retrieve information about the service being deployed - - status | No | string | | | Link used to retrieve information about the status of the installation workflow - -.. _d_c51e57d9583f6119caf83dd017cf214c: - -DCAEDeploymentsListResponse Model Structure -------------------------------------------- - -Object providing a list of deployments - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - deployments | Yes | array of :ref:`deployments <i_98a80d81e7d1973d54db7713913d37e8>` | | | - requestId | Yes | string | | | Unique identifier for the request - -.. _i_98a80d81e7d1973d54db7713913d37e8: - -**Deployments schema:** - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - href | No | string | | | URL for the service deployment - -.. _d_74f3f4f847dfb6bd181fcae06ad880b4: - -DCAEErrorResponse Model Structure ---------------------------------- - -Object reporting an error. - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - message | No | string | | | Human-readable description of the reason for the error - status | Yes | integer | | | HTTP status code for the response - -.. _d_f0103f05736b04468a4f85fe90da2e16: - -DCAEOperationStatusResponse Model Structure -------------------------------------------- - -Response body for a request for status of an installation or uninstallation -operation. - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - error | No | string | | | If status is 'failed', this field will be present and contain additional information about the reason the operation failed. - - links | No | :ref:`links <i_2feace8c1d3584ec637edc0eb1b92699>` | | | If the operation succeeded, links that the client can follow to take further action. Note that a successful 'uninstall' operation removes the DCAE service instance completely, so there are no possible further actions, and no links. - - operationType | Yes | string | | | Type of operation being reported on. ('install' or 'uninstall') - - requestId | Yes | string | | | A unique identifier assigned to the request. Useful for tracing a request through logs. - - status | Yes | string | | | Status of the installation or uninstallation operation. Possible values are 'processing', - -.. _i_2feace8c1d3584ec637edc0eb1b92699: - -**Links schema:** - -If the operation succeeded, links that the client can follow to take further -action. Note that a successful 'uninstall' operation removes the DCAE service -instance completely, so there are no possible further actions, and no links. - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - self | No | string | | | Link used to retrieve information about the service. - - uninstall | No | string | | | Link used to trigger an 'uninstall' operation for the service. (Use the DELETE method.) - -.. _d_1e3e880a733b457b648bd8c99e6c859c: - -DCAEPolicy Model Structure --------------------------- - -policy object - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - policy_body | Yes | :ref:`DCAEPolicyBody <d_7ffe00ee1aaae6811199d64ff3fea344>` | | | - policy_id | Yes | string | | | unique identifier of policy regardless of its version - -.. _d_7ffe00ee1aaae6811199d64ff3fea344: - -DCAEPolicyBody Model Structure ------------------------------- - -policy_body - the whole object received from policy-engine - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - config | Yes | :ref:`config <i_ba9593ef6832fb8401f266e173acaa5c>` | | | the policy-config - the config data provided by policy owner - policyName | Yes | string | | | unique policy name that contains the version and extension - policyVersion | Yes | string | | | stringified int that is autoincremented by policy-engine - -.. _i_ba9593ef6832fb8401f266e173acaa5c: - -**Config schema:** - -the policy-config - the config data provided by policy owner - -DCAEPolicyRequest Model Structure ---------------------------------- - -request to update policies on DCAE components. - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - catch_up | Yes | boolean | | | flag to indicate whether the request contains all the policies in PDP or not - errored_policies | No | | | | whether policy-engine returned an error on the policy. - errored_scopes | No | array of string | | | on cartchup - list of policy scope_prefix values on wchich the policy-engine experienced an error other than not-found data. - latest_policies | Yes | | | | dictionary of (policy_id -> DCAEPolicy object). - removed_policies | Yes | | | | whether policy was removed from policy-engine. - scope_prefixes | No | array of string | | | on catchup - list of all scope_prefixes used by the policy-handler to retrieve the policies from policy-engine. - -**Errored_policies schema:** - -whether policy-engine returned an error on the policy. -dictionary of (policy_id -> true). -In example: replace additionalProp1,2,3 with policy_id1,2,3 values - -Map of {"key":"boolean"} - -**Latest_policies schema:** - -dictionary of (policy_id -> DCAEPolicy object). -In example: replace additionalProp1,2,3 with policy_id1,2,3 values - -Map of {"key":":ref:`DCAEPolicy <d_1e3e880a733b457b648bd8c99e6c859c>`"} - -**Removed_policies schema:** - -whether policy was removed from policy-engine. -dictionary of (policy_id -> true). -In example: replace additionalProp1,2,3 with policy_id1,2,3 values - -Map of {"key":"boolean"} - diff --git a/docs/sections/apis/inventory.rst b/docs/sections/apis/inventory.rst deleted file mode 100644 index 7420102d..00000000 --- a/docs/sections/apis/inventory.rst +++ /dev/null @@ -1,1538 +0,0 @@ -.. This work is licensed under a - Creative Commons Attribution 4.0 International License. - -Inventory API -============= - -.. toctree:: - :maxdepth: 3 - -Description -~~~~~~~~~~~ - -DCAE Inventory is a web service that provides the following: - -1. Real-time data on all DCAE services and their components -2. Comprehensive details on available DCAE service types - -.. csv-table:: - :header: "API name", "Swagger YAML" - :widths: 10,5 - - "Inventory", ":download:`link <swagger_inventory.yaml>`" - -Contact Information -~~~~~~~~~~~~~~~~~~~ - -dcae@lists.openecomp.org - - -DEFAULT -~~~~~~~ - -GET ``/dcae-service-types`` ---------------------------- - -Description -+++++++++++ - -.. raw:: html - - Get a list of `DCAEServiceType` objects. - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - typeName | query | No | string | | | Filter by service type name - onlyLatest | query | No | boolean | | {"default": true} | If set to true, query returns just the latest versions of DCAE service types. If set to false, then all versions are returned. Default is true - onlyActive | query | No | boolean | | {"default": true} | If set to true, query returns only *active* DCAE service types. If set to false, then all DCAE service types are returned. Default is true - vnfType | query | No | string | | | Filter by associated vnf type. No wildcards, matches are explicit. This field is treated case insensitive. - serviceId | query | No | string | | | Filter by assocaited service id. Instances with service id null or empty is always returned. - serviceLocation | query | No | string | | | Filter by associated service location. Instances with service location null or empty is always returned. - asdcServiceId | query | No | string | | | Filter by associated asdc design service id. Setting this to `NONE` will return instances that have asdc service id set to null - asdcResourceId | query | No | string | | | Filter by associated asdc design resource id. Setting this to `NONE` will return instances that have asdc resource id set to null - offset | query | No | integer | int32 | | Query resultset offset used for pagination (zero-based) - -Request -+++++++ - -Responses -+++++++++ - -**200** -^^^^^^^ - -List of `DCAEServiceType` objects - -Type: :ref:`InlineResponse200 <d_b1ccd4187d31690b8e704c0aa01b2c59>` - -**Example:** - -.. code-block:: javascript - - { - "items": [ - { - "asdcResourceId": "somestring", - "asdcServiceId": "somestring", - "asdcServiceURL": "somestring", - "blueprintTemplate": "somestring", - "created": "2015-01-01T15:00:00.000Z", - "deactivated": "2015-01-01T15:00:00.000Z", - "owner": "somestring", - "selfLink": { - "params": {}, - "rel": "somestring", - "rels": [ - "somestring", - "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", - "uriBuilder": {} - }, - "serviceIds": [ - "somestring", - "somestring" - ], - "serviceLocations": [ - "somestring", - "somestring" - ], - "typeId": "somestring", - "typeName": "somestring", - "typeVersion": 1, - "vnfTypes": [ - "somestring", - "somestring" - ] - }, - { - "asdcResourceId": "somestring", - "asdcServiceId": "somestring", - "asdcServiceURL": "somestring", - "blueprintTemplate": "somestring", - "created": "2015-01-01T15:00:00.000Z", - "deactivated": "2015-01-01T15:00:00.000Z", - "owner": "somestring", - "selfLink": { - "params": {}, - "rel": "somestring", - "rels": [ - "somestring", - "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", - "uriBuilder": {} - }, - "serviceIds": [ - "somestring", - "somestring" - ], - "serviceLocations": [ - "somestring", - "somestring" - ], - "typeId": "somestring", - "typeName": "somestring", - "typeVersion": 1, - "vnfTypes": [ - "somestring", - "somestring" - ] - } - ], - "links": { - "nextLink": { - "params": {}, - "rel": "somestring", - "rels": [ - "somestring", - "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", - "uriBuilder": {} - }, - "previousLink": { - "params": {}, - "rel": "somestring", - "rels": [ - "somestring", - "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", - "uriBuilder": {} - } - }, - "totalCount": 1 - } - -DELETE ``/dcae-service-types/{typeId}`` ---------------------------------------- - -Description -+++++++++++ - -.. raw:: html - - Deactivates existing `DCAEServiceType` instances - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - typeId | path | Yes | string | | | - -Request -+++++++ - -Responses -+++++++++ - -**200** -^^^^^^^ - -`DCAEServiceType` has been deactivated - -Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` - -**Example:** - -.. code-block:: javascript - - { - "code": 1, - "message": "somestring", - "type": "somestring" - } - -**404** -^^^^^^^ - -`DCAEServiceType` not found - -Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` - -**Example:** - -.. code-block:: javascript - - { - "code": 1, - "message": "somestring", - "type": "somestring" - } - -**410** -^^^^^^^ - -`DCAEServiceType` already gone - -Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` - -**Example:** - -.. code-block:: javascript - - { - "code": 1, - "message": "somestring", - "type": "somestring" - } - -GET ``/dcae-service-types/{typeId}`` ------------------------------------- - -Description -+++++++++++ - -.. raw:: html - - Get a `DCAEServiceType` object. - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - typeId | path | Yes | string | | | - -Request -+++++++ - -Responses -+++++++++ - -**200** -^^^^^^^ - -Single `DCAEServiceType` object - -Type: :ref:`DCAEServiceType <d_b0cb5f12dbde8c0c42487c089983687e>` - -**Example:** - -.. code-block:: javascript - - { - "asdcResourceId": "somestring", - "asdcServiceId": "somestring", - "asdcServiceURL": "somestring", - "blueprintTemplate": "somestring", - "created": "2015-01-01T15:00:00.000Z", - "deactivated": "2015-01-01T15:00:00.000Z", - "owner": "somestring", - "selfLink": { - "params": {}, - "rel": "somestring", - "rels": [ - "somestring", - "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", - "uriBuilder": {} - }, - "serviceIds": [ - "somestring", - "somestring" - ], - "serviceLocations": [ - "somestring", - "somestring" - ], - "typeId": "somestring", - "typeName": "somestring", - "typeVersion": 1, - "vnfTypes": [ - "somestring", - "somestring" - ] - } - -**404** -^^^^^^^ - -Resource not found - -Type: :ref:`DCAEServiceType <d_b0cb5f12dbde8c0c42487c089983687e>` - -**Example:** - -.. code-block:: javascript - - { - "asdcResourceId": "somestring", - "asdcServiceId": "somestring", - "asdcServiceURL": "somestring", - "blueprintTemplate": "somestring", - "created": "2015-01-01T15:00:00.000Z", - "deactivated": "2015-01-01T15:00:00.000Z", - "owner": "somestring", - "selfLink": { - "params": {}, - "rel": "somestring", - "rels": [ - "somestring", - "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", - "uriBuilder": {} - }, - "serviceIds": [ - "somestring", - "somestring" - ], - "serviceLocations": [ - "somestring", - "somestring" - ], - "typeId": "somestring", - "typeName": "somestring", - "typeVersion": 1, - "vnfTypes": [ - "somestring", - "somestring" - ] - } - -POST ``/dcae-service-types`` ----------------------------- - -Description -+++++++++++ - -.. raw:: html - - Inserts a new `DCAEServiceType` or updates an existing instance. Updates are only allowed iff there are no running DCAE services of the requested type, - -Request -+++++++ - -.. _d_57dc24aa38507ded2f27eec90206336e: - -Body -^^^^ - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - asdcResourceId | No | string | | | Id of vf/vnf instance this DCAE service type is associated with. Value source is from ASDC's notification event's field `resourceInvariantUUID`. - asdcServiceId | No | string | | | Id of service this DCAE service type is associated with. Value source is from ASDC's notification event's field `serviceInvariantUUID`. - asdcServiceURL | No | string | | | URL to the ASDC service model - blueprintTemplate | Yes | string | | | String representation of a Cloudify blueprint with unbound variables - owner | Yes | string | | | - serviceIds | No | array of string | | | List of service ids that are used to associate with DCAE service type. DCAE service types with this propery as null or empty means them apply for every service id. - serviceLocations | No | array of string | | | List of service locations that are used to associate with DCAE service type. DCAE service types with this propery as null or empty means them apply for every service location. - typeName | Yes | string | | | Descriptive name for this DCAE service type - typeVersion | Yes | integer | int32 | | Version number for this DCAE service type - vnfTypes | No | array of string | | | - -.. code-block:: javascript - - { - "asdcResourceId": "somestring", - "asdcServiceId": "somestring", - "asdcServiceURL": "somestring", - "blueprintTemplate": "somestring", - "owner": "somestring", - "serviceIds": [ - "somestring", - "somestring" - ], - "serviceLocations": [ - "somestring", - "somestring" - ], - "typeName": "somestring", - "typeVersion": 1, - "vnfTypes": [ - "somestring", - "somestring" - ] - } - -Responses -+++++++++ - -**200** -^^^^^^^ - -Single `DCAEServiceType` object. - -Type: :ref:`DCAEServiceType <d_b0cb5f12dbde8c0c42487c089983687e>` - -**Example:** - -.. code-block:: javascript - - { - "asdcResourceId": "somestring", - "asdcServiceId": "somestring", - "asdcServiceURL": "somestring", - "blueprintTemplate": "somestring", - "created": "2015-01-01T15:00:00.000Z", - "deactivated": "2015-01-01T15:00:00.000Z", - "owner": "somestring", - "selfLink": { - "params": {}, - "rel": "somestring", - "rels": [ - "somestring", - "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", - "uriBuilder": {} - }, - "serviceIds": [ - "somestring", - "somestring" - ], - "serviceLocations": [ - "somestring", - "somestring" - ], - "typeId": "somestring", - "typeName": "somestring", - "typeVersion": 1, - "vnfTypes": [ - "somestring", - "somestring" - ] - } - -**400** -^^^^^^^ - -Bad request provided. - -Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` - -**Example:** - -.. code-block:: javascript - - { - "code": 1, - "message": "somestring", - "type": "somestring" - } - -**409** -^^^^^^^ - -Failed to update because there are still DCAE services of the requested type -running. - -Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` - -**Example:** - -.. code-block:: javascript - - { - "code": 1, - "message": "somestring", - "type": "somestring" - } - -GET ``/dcae-services`` ----------------------- - -Description -+++++++++++ - -.. raw:: html - - Get a list of `DCAEService` objects. - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - typeId | query | No | string | | | DCAE service type name - vnfId | query | No | string | | | - vnfType | query | No | string | | | Filter by associated vnf type. This field is treated case insensitive. - vnfLocation | query | No | string | | | - componentType | query | No | string | | | Use to filter by a specific DCAE service component type - shareable | query | No | boolean | | | Use to filter by DCAE services that have shareable components or not - created | query | No | string | | | Use to filter by created time - offset | query | No | integer | int32 | | Query resultset offset used for pagination (zero-based) - -Request -+++++++ - -Responses -+++++++++ - -**200** -^^^^^^^ - -List of `DCAEService` objects - -Type: :ref:`InlineResponse2001 <d_31bb361a8900a0bed20df49b94f1e33b>` - -**Example:** - -.. code-block:: javascript - - { - "items": [ - { - "components": [ - { - "componentId": "somestring", - "componentLink": { - "params": {}, - "rel": "somestring", - "rels": [ - "somestring", - "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", - "uriBuilder": {} - }, - "componentSource": "DCAEController", - "componentType": "somestring", - "created": "2015-01-01T15:00:00.000Z", - "location": "somestring", - "modified": "2015-01-01T15:00:00.000Z", - "shareable": 1, - "status": "somestring" - }, - { - "componentId": "somestring", - "componentLink": { - "params": {}, - "rel": "somestring", - "rels": [ - "somestring", - "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", - "uriBuilder": {} - }, - "componentSource": "DCAEController", - "componentType": "somestring", - "created": "2015-01-01T15:00:00.000Z", - "location": "somestring", - "modified": "2015-01-01T15:00:00.000Z", - "shareable": 1, - "status": "somestring" - } - ], - "created": "2015-01-01T15:00:00.000Z", - "deploymentRef": "somestring", - "modified": "2015-01-01T15:00:00.000Z", - "selfLink": { - "params": {}, - "rel": "somestring", - "rels": [ - "somestring", - "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", - "uriBuilder": {} - }, - "serviceId": "somestring", - "typeLink": { - "params": {}, - "rel": "somestring", - "rels": [ - "somestring", - "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", - "uriBuilder": {} - }, - "vnfId": "somestring", - "vnfLink": { - "params": {}, - "rel": "somestring", - "rels": [ - "somestring", - "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", - "uriBuilder": {} - }, - "vnfLocation": "somestring", - "vnfType": "somestring" - }, - { - "components": [ - { - "componentId": "somestring", - "componentLink": { - "params": {}, - "rel": "somestring", - "rels": [ - "somestring", - "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", - "uriBuilder": {} - }, - "componentSource": "DCAEController", - "componentType": "somestring", - "created": "2015-01-01T15:00:00.000Z", - "location": "somestring", - "modified": "2015-01-01T15:00:00.000Z", - "shareable": 1, - "status": "somestring" - }, - { - "componentId": "somestring", - "componentLink": { - "params": {}, - "rel": "somestring", - "rels": [ - "somestring", - "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", - "uriBuilder": {} - }, - "componentSource": "DCAEController", - "componentType": "somestring", - "created": "2015-01-01T15:00:00.000Z", - "location": "somestring", - "modified": "2015-01-01T15:00:00.000Z", - "shareable": 1, - "status": "somestring" - } - ], - "created": "2015-01-01T15:00:00.000Z", - "deploymentRef": "somestring", - "modified": "2015-01-01T15:00:00.000Z", - "selfLink": { - "params": {}, - "rel": "somestring", - "rels": [ - "somestring", - "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", - "uriBuilder": {} - }, - "serviceId": "somestring", - "typeLink": { - "params": {}, - "rel": "somestring", - "rels": [ - "somestring", - "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", - "uriBuilder": {} - }, - "vnfId": "somestring", - "vnfLink": { - "params": {}, - "rel": "somestring", - "rels": [ - "somestring", - "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", - "uriBuilder": {} - }, - "vnfLocation": "somestring", - "vnfType": "somestring" - } - ], - "links": { - "nextLink": { - "params": {}, - "rel": "somestring", - "rels": [ - "somestring", - "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", - "uriBuilder": {} - }, - "previousLink": { - "params": {}, - "rel": "somestring", - "rels": [ - "somestring", - "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", - "uriBuilder": {} - } - }, - "totalCount": 1 - } - -**502** -^^^^^^^ - -Bad response from DCAE controller - -Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` - -**Example:** - -.. code-block:: javascript - - { - "code": 1, - "message": "somestring", - "type": "somestring" - } - -**504** -^^^^^^^ - -Failed to connect with DCAE controller - -Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` - -**Example:** - -.. code-block:: javascript - - { - "code": 1, - "message": "somestring", - "type": "somestring" - } - -GET ``/dcae-services-groupby/{propertyName}`` ---------------------------------------------- - -Description -+++++++++++ - -.. raw:: html - - Get a list of unique values for the given `propertyName` - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - propertyName | path | Yes | string | | | Property to find unique values. Restricted to `type`, `vnfType`, `vnfLocation` - -Request -+++++++ - -Responses -+++++++++ - -**200** -^^^^^^^ - -List of unique property values - -Type: :ref:`DCAEServiceGroupByResults <d_a6dc4f986873bc126fc916189ffa5e91>` - -**Example:** - -.. code-block:: javascript - - { - "propertyName": "somestring", - "propertyValues": [ - { - "count": 1, - "dcaeServiceQueryLink": { - "params": {}, - "rel": "somestring", - "rels": [ - "somestring", - "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", - "uriBuilder": {} - }, - "propertyValue": "somestring" - }, - { - "count": 1, - "dcaeServiceQueryLink": { - "params": {}, - "rel": "somestring", - "rels": [ - "somestring", - "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", - "uriBuilder": {} - }, - "propertyValue": "somestring" - } - ] - } - -DELETE ``/dcae-services/{serviceId}`` -------------------------------------- - -Description -+++++++++++ - -.. raw:: html - - Remove an existing `DCAEService` object. - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - serviceId | path | Yes | string | | | - -Request -+++++++ - -Responses -+++++++++ - -**200** -^^^^^^^ - -DCAE service has been removed - -**404** -^^^^^^^ - -Unknown DCAE service - -Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` - -**Example:** - -.. code-block:: javascript - - { - "code": 1, - "message": "somestring", - "type": "somestring" - } - -GET ``/dcae-services/{serviceId}`` ----------------------------------- - -Description -+++++++++++ - -.. raw:: html - - Get a `DCAEService` object. - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - serviceId | path | Yes | string | | | - -Request -+++++++ - -Responses -+++++++++ - -**200** -^^^^^^^ - -Single `DCAEService` object - -Type: :ref:`DCAEService <d_ae85cd292c2b4046e1ea1bbb02c7ea63>` - -**Example:** - -.. code-block:: javascript - - { - "components": [ - { - "componentId": "somestring", - "componentLink": { - "params": {}, - "rel": "somestring", - "rels": [ - "somestring", - "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", - "uriBuilder": {} - }, - "componentSource": "DCAEController", - "componentType": "somestring", - "created": "2015-01-01T15:00:00.000Z", - "location": "somestring", - "modified": "2015-01-01T15:00:00.000Z", - "shareable": 1, - "status": "somestring" - }, - { - "componentId": "somestring", - "componentLink": { - "params": {}, - "rel": "somestring", - "rels": [ - "somestring", - "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", - "uriBuilder": {} - }, - "componentSource": "DCAEController", - "componentType": "somestring", - "created": "2015-01-01T15:00:00.000Z", - "location": "somestring", - "modified": "2015-01-01T15:00:00.000Z", - "shareable": 1, - "status": "somestring" - } - ], - "created": "2015-01-01T15:00:00.000Z", - "deploymentRef": "somestring", - "modified": "2015-01-01T15:00:00.000Z", - "selfLink": { - "params": {}, - "rel": "somestring", - "rels": [ - "somestring", - "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", - "uriBuilder": {} - }, - "serviceId": "somestring", - "typeLink": { - "params": {}, - "rel": "somestring", - "rels": [ - "somestring", - "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", - "uriBuilder": {} - }, - "vnfId": "somestring", - "vnfLink": { - "params": {}, - "rel": "somestring", - "rels": [ - "somestring", - "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", - "uriBuilder": {} - }, - "vnfLocation": "somestring", - "vnfType": "somestring" - } - -**404** -^^^^^^^ - -DCAE service not found - -Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` - -**Example:** - -.. code-block:: javascript - - { - "code": 1, - "message": "somestring", - "type": "somestring" - } - -**502** -^^^^^^^ - -Bad response from DCAE controller - -Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` - -**Example:** - -.. code-block:: javascript - - { - "code": 1, - "message": "somestring", - "type": "somestring" - } - -**504** -^^^^^^^ - -Failed to connect with DCAE controller - -Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` - -**Example:** - -.. code-block:: javascript - - { - "code": 1, - "message": "somestring", - "type": "somestring" - } - -PUT ``/dcae-services/{serviceId}`` ----------------------------------- - -Description -+++++++++++ - -.. raw:: html - - Put a new or update an existing `DCAEService` object. - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - serviceId | path | Yes | string | | | - -Request -+++++++ - -.. _d_81c18e0dd7a3af8fb1ba658e72907e7b: - -Body -^^^^ - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - components | Yes | array of :ref:`DCAEServiceComponentRequest <d_55af22c43245c290d643f75be1f4f254>` | | | List of DCAE service components that this service is composed of - deploymentRef | No | string | | | Reference to a Cloudify deployment - typeId | Yes | string | | | Id of the associated DCAE service type - vnfId | Yes | string | | | Id of the associated VNF that this service is monitoring - vnfLocation | Yes | string | | | Location identifier of the associated VNF that this service is monitoring - vnfType | Yes | string | | | The type of the associated VNF that this service is monitoring - -.. code-block:: javascript - - { - "components": [ - { - "componentId": "somestring", - "componentSource": "DCAEController", - "componentType": "somestring", - "shareable": 1 - }, - { - "componentId": "somestring", - "componentSource": "DCAEController", - "componentType": "somestring", - "shareable": 1 - } - ], - "deploymentRef": "somestring", - "typeId": "somestring", - "vnfId": "somestring", - "vnfLocation": "somestring", - "vnfType": "somestring" - } - -Responses -+++++++++ - -**200** -^^^^^^^ - -Single `DCAEService` object - -Type: :ref:`DCAEService <d_ae85cd292c2b4046e1ea1bbb02c7ea63>` - -**Example:** - -.. code-block:: javascript - - { - "components": [ - { - "componentId": "somestring", - "componentLink": { - "params": {}, - "rel": "somestring", - "rels": [ - "somestring", - "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", - "uriBuilder": {} - }, - "componentSource": "DCAEController", - "componentType": "somestring", - "created": "2015-01-01T15:00:00.000Z", - "location": "somestring", - "modified": "2015-01-01T15:00:00.000Z", - "shareable": 1, - "status": "somestring" - }, - { - "componentId": "somestring", - "componentLink": { - "params": {}, - "rel": "somestring", - "rels": [ - "somestring", - "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", - "uriBuilder": {} - }, - "componentSource": "DCAEController", - "componentType": "somestring", - "created": "2015-01-01T15:00:00.000Z", - "location": "somestring", - "modified": "2015-01-01T15:00:00.000Z", - "shareable": 1, - "status": "somestring" - } - ], - "created": "2015-01-01T15:00:00.000Z", - "deploymentRef": "somestring", - "modified": "2015-01-01T15:00:00.000Z", - "selfLink": { - "params": {}, - "rel": "somestring", - "rels": [ - "somestring", - "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", - "uriBuilder": {} - }, - "serviceId": "somestring", - "typeLink": { - "params": {}, - "rel": "somestring", - "rels": [ - "somestring", - "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", - "uriBuilder": {} - }, - "vnfId": "somestring", - "vnfLink": { - "params": {}, - "rel": "somestring", - "rels": [ - "somestring", - "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", - "uriBuilder": {} - }, - "vnfLocation": "somestring", - "vnfType": "somestring" - } - -**422** -^^^^^^^ - -Bad request provided - -Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` - -**Example:** - -.. code-block:: javascript - - { - "code": 1, - "message": "somestring", - "type": "somestring" - } - -Data Structures -~~~~~~~~~~~~~~~ - -.. _d_8a94f348f7df00259702f8d9b7d2ea84: - -ApiResponseMessage Model Structure ----------------------------------- - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - code | No | integer | int32 | | - message | No | string | | | - type | No | string | | | - -.. _d_ae85cd292c2b4046e1ea1bbb02c7ea63: - -DCAEService Model Structure ---------------------------- - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - components | No | array of :ref:`DCAEServiceComponent <d_51674dafcc623be79f21ecea545c345d>` | | | - created | No | string | date-time | | - deploymentRef | No | string | | | Reference to a Cloudify deployment - modified | No | string | date-time | | - selfLink | No | :ref:`Link <d_add3c3fd2e145f9e5a78be6e7b208ebb>` | | | Link.title is serviceId - serviceId | No | string | | | - typeLink | No | :ref:`Link <d_add3c3fd2e145f9e5a78be6e7b208ebb>` | | | Link.title is typeId - vnfId | No | string | | | - vnfLink | No | :ref:`Link <d_add3c3fd2e145f9e5a78be6e7b208ebb>` | | | Link.title is vnfId - vnfLocation | No | string | | | Location information of the associated VNF - vnfType | No | string | | | - -.. _d_51674dafcc623be79f21ecea545c345d: - -DCAEServiceComponent Model Structure ------------------------------------- - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - componentId | Yes | string | | | The id format is unique to the source - componentLink | Yes | :ref:`Link <d_add3c3fd2e145f9e5a78be6e7b208ebb>` | | | Link to the underlying resource of this component - componentSource | Yes | string | | {'enum': ['DCAEController', 'DMaaPController']} | Specifies the name of the underying source service that is responsible for this components - componentType | Yes | string | | | - created | Yes | string | date-time | | - location | No | string | | | Location information of the component - modified | Yes | string | date-time | | - shareable | Yes | integer | int32 | | Used to determine if this component can be shared amongst different DCAE services - status | No | string | | | - -.. _d_55af22c43245c290d643f75be1f4f254: - -DCAEServiceComponentRequest Model Structure -------------------------------------------- - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - componentId | Yes | string | | | The id format is unique to the source - componentSource | Yes | string | | {'enum': ['DCAEController', 'DMaaPController']} | Specifies the name of the underying source service that is responsible for this components - componentType | Yes | string | | | - shareable | Yes | integer | int32 | | Used to determine if this component can be shared amongst different DCAE services - -.. _d_a6dc4f986873bc126fc916189ffa5e91: - -DCAEServiceGroupByResults Model Structure ------------------------------------------ - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - propertyName | No | string | | | Property name of DCAE service that the group by operation was performed on - propertyValues | No | array of :ref:`DCAEServiceGroupByResultsPropertyValues <d_0119caa52e274e5e2311b367df38d686>` | | | - -.. _d_0119caa52e274e5e2311b367df38d686: - -DCAEServiceGroupByResultsPropertyValues Model Structure -------------------------------------------------------- - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - count | No | integer | int32 | | - dcaeServiceQueryLink | No | :ref:`Link <d_add3c3fd2e145f9e5a78be6e7b208ebb>` | | | Link.title is the DCAE service property value. Following this link will provide a list of DCAE services that all have this property value. - propertyValue | No | string | | | - -DCAEServiceRequest Model Structure ----------------------------------- - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - components | Yes | array of :ref:`DCAEServiceComponentRequest <d_55af22c43245c290d643f75be1f4f254>` | | | List of DCAE service components that this service is composed of - deploymentRef | No | string | | | Reference to a Cloudify deployment - typeId | Yes | string | | | Id of the associated DCAE service type - vnfId | Yes | string | | | Id of the associated VNF that this service is monitoring - vnfLocation | Yes | string | | | Location identifier of the associated VNF that this service is monitoring - vnfType | Yes | string | | | The type of the associated VNF that this service is monitoring - -.. _d_b0cb5f12dbde8c0c42487c089983687e: - -DCAEServiceType Model Structure -------------------------------- - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - asdcResourceId | No | string | | | Id of vf/vnf instance this DCAE service type is associated with. Value source is from ASDC's notification event's field `resourceInvariantUUID`. - asdcServiceId | No | string | | | Id of service this DCAE service type is associated with. Value source is from ASDC's notification event's field `serviceInvariantUUID`. - asdcServiceURL | No | string | | | URL to the ASDC service model - blueprintTemplate | Yes | string | | | String representation of a Cloudify blueprint with unbound variables - created | Yes | string | date-time | | Created timestamp for this DCAE service type in epoch time - deactivated | No | string | date-time | | Deactivated timestamp for this DCAE service type in epoch time - owner | Yes | string | | | - selfLink | Yes | :ref:`Link <d_add3c3fd2e145f9e5a78be6e7b208ebb>` | | | Link to self where the Link.title is typeName - serviceIds | No | array of string | | | List of service ids that are used to associate with DCAE service type. DCAE service types with this propery as null or empty means them apply for every service id. - serviceLocations | No | array of string | | | List of service locations that are used to associate with DCAE service type. DCAE service types with this propery as null or empty means them apply for every service location. - typeId | Yes | string | | | Unique identifier for this DCAE service type - typeName | Yes | string | | | Descriptive name for this DCAE service type - typeVersion | Yes | integer | int32 | | Version number for this DCAE service type - vnfTypes | No | array of string | | | - -DCAEServiceTypeRequest Model Structure --------------------------------------- - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - asdcResourceId | No | string | | | Id of vf/vnf instance this DCAE service type is associated with. Value source is from ASDC's notification event's field `resourceInvariantUUID`. - asdcServiceId | No | string | | | Id of service this DCAE service type is associated with. Value source is from ASDC's notification event's field `serviceInvariantUUID`. - asdcServiceURL | No | string | | | URL to the ASDC service model - blueprintTemplate | Yes | string | | | String representation of a Cloudify blueprint with unbound variables - owner | Yes | string | | | - serviceIds | No | array of string | | | List of service ids that are used to associate with DCAE service type. DCAE service types with this propery as null or empty means them apply for every service id. - serviceLocations | No | array of string | | | List of service locations that are used to associate with DCAE service type. DCAE service types with this propery as null or empty means them apply for every service location. - typeName | Yes | string | | | Descriptive name for this DCAE service type - typeVersion | Yes | integer | int32 | | Version number for this DCAE service type - vnfTypes | No | array of string | | | - -.. _d_b1ccd4187d31690b8e704c0aa01b2c59: - -InlineResponse200 Model Structure ---------------------------------- - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - items | No | array of :ref:`DCAEServiceType <d_b0cb5f12dbde8c0c42487c089983687e>` | | | - links | No | :ref:`InlineResponse200Links <d_e52a59e574408d4d622b3f1f61619b1c>` | | | - totalCount | No | integer | int32 | | - -.. _d_31bb361a8900a0bed20df49b94f1e33b: - -InlineResponse2001 Model Structure ----------------------------------- - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - items | No | array of :ref:`DCAEService <d_ae85cd292c2b4046e1ea1bbb02c7ea63>` | | | - links | No | :ref:`InlineResponse200Links <d_e52a59e574408d4d622b3f1f61619b1c>` | | | - totalCount | No | integer | int32 | | - -.. _d_e52a59e574408d4d622b3f1f61619b1c: - -InlineResponse200Links Model Structure --------------------------------------- - -Pagination links - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - nextLink | No | :ref:`Link <d_add3c3fd2e145f9e5a78be6e7b208ebb>` | | | - previousLink | No | :ref:`Link <d_add3c3fd2e145f9e5a78be6e7b208ebb>` | | | - -.. _d_add3c3fd2e145f9e5a78be6e7b208ebb: - -Link Model Structure --------------------- - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - params | No | :ref:`params <i_f76783e4d75c137d1fc68696fcfdb72c>` | | | - rel | No | string | | | - rels | No | array of string | | | - title | No | string | | | - type | No | string | | | - uri | No | string | uri | | - uriBuilder | No | :ref:`UriBuilder <d_a7b6b5c694147ea9dcfb5a5a6cbef017>` | | | - -.. _i_f76783e4d75c137d1fc68696fcfdb72c: - -**Params schema:** - -Map of {"key":"string"} - -.. _d_a7b6b5c694147ea9dcfb5a5a6cbef017: - -UriBuilder Model Structure --------------------------- - diff --git a/docs/sections/apis/swagger-bbs-event-processor.yaml b/docs/sections/apis/swagger-bbs-event-processor.yaml deleted file mode 100644 index d1fa002d..00000000 --- a/docs/sections/apis/swagger-bbs-event-processor.yaml +++ /dev/null @@ -1,164 +0,0 @@ ---- -swagger: '2.0' -info: - description: This page lists bbs-event-processor REST API details - version: '1.0' - title: BBS Event Processor -host: localhost:32100 -basePath: "/" -tags: -- name: bbs-event-processor-controller - description: Manage bbs-event-processor microService -paths: - "/cancel-tasks": - post: - tags: - - bbs-event-processor-controller - summary: Returns result of request to cancel running microservice tasks - operationId: cancelTasksUsingPOST - consumes: - - application/json - produces: - - "*/*" - responses: - '200': - description: Tasks were successfully cancelled - schema: - "$ref": "#/definitions/Mono«ResponseEntity«string»»" - '201': - description: Created - '401': - description: Not authorized to view the resource - '403': - description: Resource access is forbidden - '404': - description: Resource is not found - '406': - description: Cancellation failed. Check logs - "/heartbeat": - get: - tags: - - bbs-event-processor-controller - summary: Returns liveness of bbs-event-processor microService - operationId: handleHeartBeatUsingGET - produces: - - "*/*" - responses: - '200': - description: bbs-event-processor microService is alive - schema: - "$ref": "#/definitions/Mono«ResponseEntity«string»»" - '401': - description: Not authorized to view the resource - '403': - description: Resource access is forbidden - '404': - description: Resource is not found - "/logging/{level}": - post: - tags: - - bbs-event-processor-controller - summary: Returns result of request to change application logging level - operationId: changeLoggingLevelUsingPOST - consumes: - - application/json - produces: - - "*/*" - parameters: - - name: level - in: path - description: level - required: true - type: string - responses: - '200': - description: Application logging level was successfully changed - schema: - "$ref": "#/definitions/Mono«ResponseEntity«string»»" - '201': - description: Created - '401': - description: Unauthorized - '403': - description: Forbidden - '404': - description: Not Found - '406': - description: Application logging level change failure. Check logs - "/poll-cpe-authentication-events": - post: - tags: - - bbs-event-processor-controller - summary: Returns result of request submission. CPE authentication polling will - occur asynchronously - operationId: handleCpeAuthenticationRestCallUsingPOST - consumes: - - application/json - produces: - - "*/*" - responses: - '200': - description: CPE authentication task submitted successfully - schema: - "$ref": "#/definitions/Mono«ResponseEntity«string»»" - '201': - description: Created - '401': - description: Not authorized to view the resource - '403': - description: Resource access is forbidden - '404': - description: Resource is not found - "/poll-reregistration-events": - post: - tags: - - bbs-event-processor-controller - summary: Returns result of request submission. PNF re-registration polling will - occur asynchronously - operationId: handleReRegistrationRestCallUsingPOST - consumes: - - application/json - produces: - - "*/*" - responses: - '200': - description: Polling Re-registration events task submitted successfully - schema: - "$ref": "#/definitions/Mono«ResponseEntity«string»»" - '201': - description: Created - '401': - description: Not authorized to view the resource - '403': - description: Resource access is forbidden - '404': - description: Resource is not found - "/start-tasks": - post: - tags: - - bbs-event-processor-controller - summary: Returns result of request to start microservice tasks - operationId: reScheduleTasksUsingPOST - consumes: - - application/json - produces: - - "*/*" - responses: - '200': - description: Tasks were successfully started - schema: - "$ref": "#/definitions/Mono«ResponseEntity«string»»" - '201': - description: Created - '401': - description: Not authorized to view the resource - '403': - description: Resource access is forbidden - '404': - description: Resource is not found - '406': - description: Task initiation failed. Check logs -definitions: - Mono«ResponseEntity«string»»: - type: object - title: Mono«ResponseEntity«string»» |