diff options
| author |   Eric Debeau <eric.debeau@orange.com> | 2019-05-14 17:45:22 +0000 |
|---|---|---|
| committer | Eric Debeau <eric.debeau@orange.com> | 2019-05-16 13:58:23 +0000 |
| commit | 1af30536774a0872b180f6c74a3e4ed487218747 (patch) | |
| tree | bd09e30c08462cd1a032ca21ac6c5aac54ef1399 | |
| parent | b643761e44851acf519fa039e11c2f413e7a25aa (diff) | |
Integration with Swagger
Correct doc8 errors
Add licence in RST
Add API table
Add swaggerv2doc when OK
Issue-ID: DCAEGEN2-1049
Change-Id: I7478b1c34625ce03ee4f1278a04a408f6f73718e
Signed-off-by: Eric Debeau <eric.debeau@orange.com>
| -rw-r--r-- | docs/sections/apis/DFC.rst | 6 | ||||
| -rw-r--r-- | docs/sections/apis/PNDA.rst | 4 | ||||
| -rw-r--r-- | docs/sections/apis/PRH.json | 115 | ||||
| -rw-r--r-- | docs/sections/apis/PRH.rst | 31 | ||||
| -rw-r--r-- | docs/sections/apis/SDK.rst | 9 | ||||
| -rw-r--r-- | docs/sections/apis/configbinding.json | 118 | ||||
| -rw-r--r-- | docs/sections/apis/configbinding.rst | 78 | ||||
| -rw-r--r-- | docs/sections/apis/dcaecdap.rst | 3 | ||||
| -rw-r--r-- | docs/sections/apis/deployment-handler-API.json | 561 | ||||
| -rw-r--r-- | docs/sections/apis/deployment-handler.rst | 239 | ||||
| -rw-r--r-- | docs/sections/apis/inventory.rst | 210 | ||||
| -rw-r--r-- | docs/sections/apis/pmmapper.rst | 21 | ||||
| -rw-r--r-- | docs/sections/apis/swagger_vescollector.json | 928 | ||||
| -rw-r--r-- | docs/sections/apis/ves.rst | 213 |
14 files changed, 1954 insertions, 582 deletions
diff --git a/docs/sections/apis/DFC.rst b/docs/sections/apis/DFC.rst index f345d93f..1470ce7a 100644 --- a/docs/sections/apis/DFC.rst +++ b/docs/sections/apis/DFC.rst @@ -1,3 +1,6 @@ +.. This work is licensed under a + Creative Commons Attribution 4.0 International License. + ======================== DFC (DataFile Collector) ======================== @@ -6,7 +9,6 @@ DFC (DataFile Collector) .. contents:: :depth: 3 -.. Overview ======== @@ -15,7 +17,6 @@ Component description can be found under `DFC`_. .. _DFC: ../../sections/services/dfc/index.html - Offered APIs ============ @@ -24,3 +25,4 @@ Offered APIs :widths: 10,5 "Datafile Collector API", ":download:`link <DFC.json>`" + diff --git a/docs/sections/apis/PNDA.rst b/docs/sections/apis/PNDA.rst index f93ee2f1..4423e7c6 100644 --- a/docs/sections/apis/PNDA.rst +++ b/docs/sections/apis/PNDA.rst @@ -1,7 +1,9 @@ +.. This work is licensed under a + Creative Commons Attribution 4.0 International License. + PNDA – Platform for Network Data Analytics ========================================== - PNDA has several APIs that are documented as part of the PNDA project. * https://github.com/pndaproject/platform-package-repository#repository-api diff --git a/docs/sections/apis/PRH.json b/docs/sections/apis/PRH.json new file mode 100644 index 00000000..7ac63a55 --- /dev/null +++ b/docs/sections/apis/PRH.json @@ -0,0 +1,115 @@ +{ + "swagger": "2.0", + "info": { + "description": "This page lists all the rest apis for PRH app server.", + "version": "1.0", + "title": "PRH app server" + }, + "host": "localhost:8100", + "basePath": "/", + "tags": [ + { + "name": "heartbeat-controller", + "description": "Check liveness of PRH service" + }, + { + "name": "schedule-controller", + "description": "Schedule Controller" + } + ], + "paths": { + "/heartbeat": { + "get": { + "tags": [ + "heartbeat-controller" + ], + "summary": "Returns liveness of PRH service", + "operationId": "heartbeatUsingGET", + "produces": [ + "*/*" + ], + "responses": { + "200": { + "description": "PRH sevice is living", + "schema": { + "$ref": "#/definitions/Mono«ResponseEntity«string»»" + } + }, + "401": { + "description": "You are not authorized to view the resource" + }, + "403": { + "description": "Accessing the resource you were trying to reach is forbidden" + }, + "404": { + "description": "The resource you were trying to reach is not found" + } + } + } + }, + "/start": { + "get": { + "tags": [ + "schedule-controller" + ], + "summary": "Start scheduling worker request", + "operationId": "startTasksUsingGET", + "produces": [ + "*/*" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Mono«ResponseEntity«string»»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/stopPrh": { + "get": { + "tags": [ + "schedule-controller" + ], + "summary": "Stop scheduling worker request", + "operationId": "stopTaskUsingGET", + "produces": [ + "*/*" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Mono«ResponseEntity«string»»" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + } + }, + "definitions": { + "Mono«ResponseEntity«string»»": { + "type": "object", + "title": "Mono«ResponseEntity«string»»" + } + } +} diff --git a/docs/sections/apis/PRH.rst b/docs/sections/apis/PRH.rst index 2a7d0eae..e566c86e 100644 --- a/docs/sections/apis/PRH.rst +++ b/docs/sections/apis/PRH.rst @@ -1,3 +1,6 @@ +.. This work is licensed under a + Creative Commons Attribution 4.0 International License. + .. _prh_api: ============================== @@ -8,24 +11,32 @@ PRH (PNF Registration Handler) .. contents:: :depth: 3 -.. Overview ======== -Physical Network Function Registration Handler is responsible for registration of PNF (Physical Network Function) to -ONAP (Open Network Automation Platform) in plug and play manner. +Physical Network Function Registration Handler is responsible for registration +of PNF (Physical Network Function) to ONAP (Open Network Automation Platform) +in plug and play manner. + +.. csv-table:: + :header: "API name", "Swagger JSON", "Swagger YAML" + :widths: 10,5,5 + + "PNF Registration Handler", ":download:`link <PRH.json>`", ":download:`link <PRH.yaml>`" + +.. swaggerv2doc:: PRH.json Introduction ============ -PRH is delivered as one **Docker container** which hosts application server and can be started by `docker-compose`. +PRH is delivered as one **Docker container** which hosts application server and +can be started by `docker-compose`. Functionality ============= .. image:: ../images/prhAlgo.png - Paths ===== @@ -37,7 +48,6 @@ Description Reads PNF registration fromD DMaaP (Data Movement as a Platform) - Responses ~~~~~~~~~ @@ -47,7 +57,6 @@ Responses | **200** | successful response | +-----------+-------------------------------------------+ - PATCH /aai/v12/network/pnfs/{pnf-name} -------------------------------------- @@ -70,7 +79,6 @@ Parameters | **Body** | **patchbody** | Required patch body. | | +----------+---------------+---------------------------------+------------------+ - Responses ~~~~~~~~~ @@ -80,7 +88,6 @@ Responses | **200** | successful response | +-----------+-------------------------------------------+ - POST /events/unauthenticated.PNF_READY -------------------------------------- @@ -103,7 +110,6 @@ Parameters | | | | t>`__ | +----------+----------------+---------------------------------+------------------+ - Responses ~~~~~~~~~ @@ -116,8 +122,8 @@ Responses Compiling PRH ============= -Whole project (top level of PRH directory) and each module (sub module directory) can be compiled using -`mvn clean install` command. +Whole project (top level of PRH directory) and each module (sub module +directory) can be compiled using `mvn clean install` command. Main API Endpoints ================== @@ -145,4 +151,3 @@ Maven Children Artifacts: 3. prh-dmaap-client: Contains implementation of DmaaP client 4. prh-commons: Common code for whole prh modules - diff --git a/docs/sections/apis/SDK.rst b/docs/sections/apis/SDK.rst index d44dda59..40e7f4d6 100644 --- a/docs/sections/apis/SDK.rst +++ b/docs/sections/apis/SDK.rst @@ -1,3 +1,6 @@ +.. This work is licensed under a + Creative Commons Attribution 4.0 International License. + ======== DCAE SDK ======== @@ -11,7 +14,9 @@ DCAE SDK Overview ======== -DCAE SDK contains utilities and clients which may be used for fetching configuration from CBS, consuming messages from DMaaP, interacting with A&AI, etc. SDK is written in Java. +DCAE SDK contains utilities and clients which may be used for fetching +configuration from CBS, consuming messages from DMaaP, interacting with A&AI, +etc. SDK is written in Java. Introduction ============ @@ -51,4 +56,4 @@ Introduction </dependency> <!-- more to go --> - </dependencies>
\ No newline at end of file + </dependencies> diff --git a/docs/sections/apis/configbinding.json b/docs/sections/apis/configbinding.json new file mode 100644 index 00000000..14454bb2 --- /dev/null +++ b/docs/sections/apis/configbinding.json @@ -0,0 +1,118 @@ +{ + "swagger": "2.0", + "info": { + "version": "2.2.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 index 85df2316..0b947dbf 100644 --- a/docs/sections/apis/configbinding.rst +++ b/docs/sections/apis/configbinding.rst @@ -1,24 +1,18 @@ -Config Binding Service 2.1.0 +Config Binding Service 2.2.3 ============================ .. toctree:: :maxdepth: 3 +.. csv-table:: + :header: "API name", "Swagger JSON", "Swagger YAML" + :widths: 10,5,5 - - - -DEFAULT -~~~~~~~ - - - + "Config Binding Service", ":download:`link <configbinding.json>`", ":download:`link <configbinding.yaml>`" GET ``/service_component_all/{service_component_name}`` ------------------------------------------------------- - - Description +++++++++++ @@ -34,13 +28,11 @@ Parameters :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. - + service_component_name | path | Yes | string | | | Service Component Name. service_component_name must be a key in consul. Request +++++++ - Responses +++++++++ @@ -49,14 +41,10 @@ Responses OK; returns {config : ..., policies : ....., k : ...} for all other k in Consul - .. _i_4d863967ef9a9d9efdadd1b250c76bd6: **Response Schema:** - - - **Example:** .. code-block:: javascript @@ -68,16 +56,9 @@ OK; returns {config : ..., policies : ....., k : ...} for all other k in Consul there is no configuration in Consul for this component - - - - - GET ``/service_component/{service_component_name}`` --------------------------------------------------- - - Description +++++++++++ @@ -93,13 +74,11 @@ Parameters :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. - + service_component_name | path | Yes | string | | | Service Component Name. service_component_name must be a key in consul. Request +++++++ - Responses +++++++++ @@ -108,12 +87,8 @@ Responses OK; the bound config is returned as an object - **Response Schema:** - - - **Example:** .. code-block:: javascript @@ -125,16 +100,9 @@ OK; the bound config is returned as an object there is no configuration in Consul for this component - - - - - GET ``/{key}/{service_component_name}`` --------------------------------------- - - Description +++++++++++ @@ -150,14 +118,12 @@ Parameters :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. - + 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 +++++++++ @@ -166,13 +132,8 @@ Responses OK; returns service_component_name:key - - **Response Schema:** - - - **Example:** .. code-block:: javascript @@ -182,24 +143,17 @@ OK; returns service_component_name:key **400** ^^^^^^^ -bad request. Currently this is only returned on :policies, which is a complex object, and should be gotten through service_component_all - +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 +++++++++++ @@ -207,11 +161,9 @@ 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 - Request +++++++ - Responses +++++++++ @@ -220,16 +172,8 @@ Responses Successful response - **503** ^^^^^^^ the config binding service cannot reach Consul - - - - -Data Structures -~~~~~~~~~~~~~~~ - diff --git a/docs/sections/apis/dcaecdap.rst b/docs/sections/apis/dcaecdap.rst index 038d98f1..9e6bc92c 100644 --- a/docs/sections/apis/dcaecdap.rst +++ b/docs/sections/apis/dcaecdap.rst @@ -1,3 +1,6 @@ +.. This work is licensed under a + Creative Commons Attribution 4.0 International License. + =============== CDAP Broker API =============== diff --git a/docs/sections/apis/deployment-handler-API.json b/docs/sections/apis/deployment-handler-API.json new file mode 100644 index 00000000..91a78279 --- /dev/null +++ b/docs/sections/apis/deployment-handler-API.json @@ -0,0 +1,561 @@ +{ + "swagger": "2.0", + "info": { + "version": "3.0.3", + "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.rst b/docs/sections/apis/deployment-handler.rst index 32373c9b..dc172a29 100644 --- a/docs/sections/apis/deployment-handler.rst +++ b/docs/sections/apis/deployment-handler.rst @@ -1,43 +1,37 @@ +.. This work is licensed under a + Creative Commons Attribution 4.0 International License. + deployment-handler API 3.0.3 ============================ .. 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. - - - - +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 +++++++++++ @@ -45,7 +39,6 @@ Description Uninstall the DCAE service and remove all associated data from the orchestrator. - Parameters ++++++++++ @@ -54,13 +47,11 @@ Parameters :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. - + deploymentId | path | Yes | string | | | Deployment identifier for the service to be uninstalled. Request +++++++ - Responses +++++++++ @@ -69,8 +60,6 @@ Responses Success: The dispatcher has initiated the uninstall operation. - - Type: :ref:`DCAEDeploymentResponse <d_6157bd3de5c8c7de78f2ab86397667e0>` **Example:** @@ -90,8 +79,6 @@ Type: :ref:`DCAEDeploymentResponse <d_6157bd3de5c8c7de78f2ab86397667e0>` Bad request: See the message in the response for details. - - Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` **Example:** @@ -109,8 +96,6 @@ Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` Problem on the server side. See the message in the response for more details. - - Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` **Example:** @@ -128,8 +113,6 @@ Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` Error reported to the dispatcher by a downstream system. See the message in the response for more details. - - Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` **Example:** @@ -147,8 +130,6 @@ Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` Error communicating with a downstream system. See the message in the response for more details. - - Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` **Example:** @@ -160,15 +141,9 @@ Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` "status": 1 } - - - - GET ``/dcae-deployments`` ------------------------- - - Description +++++++++++ @@ -176,7 +151,6 @@ Description List service deployments known to the orchestrator, optionally restricted to a single service type - Parameters ++++++++++ @@ -185,23 +159,19 @@ Parameters :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 - + 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.) - - +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>` @@ -227,8 +197,6 @@ Type: :ref:`DCAEDeploymentsListResponse <d_c51e57d9583f6119caf83dd017cf214c>` Problem on the server side. See the message in the response for more details. - - Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` **Example:** @@ -246,8 +214,6 @@ Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` Error reported to the dispatcher by a downstream system. See the message in the response for more details. - - Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` **Example:** @@ -265,8 +231,6 @@ Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` Error communicating with a downstream system. See the message in the response for more details. - - Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` **Example:** @@ -278,15 +242,9 @@ Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` "status": 1 } - - - - GET ``/dcae-deployments/{deploymentId}/operation/{operationId}`` ---------------------------------------------------------------- - - Description +++++++++++ @@ -294,7 +252,6 @@ Description Get status of a deployment operation - Parameters ++++++++++ @@ -303,14 +260,12 @@ Parameters :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 | | | - + deploymentId | path | Yes | string | | | + operationId | path | Yes | string | | | Request +++++++ - Responses +++++++++ @@ -319,7 +274,6 @@ Responses Status information retrieved successfully - Type: :ref:`DCAEOperationStatusResponse <d_f0103f05736b04468a4f85fe90da2e16>` **Example:** @@ -340,8 +294,8 @@ Type: :ref:`DCAEOperationStatusResponse <d_f0103f05736b04468a4f85fe90da2e16>` **404** ^^^^^^^ -The operation information does not exist (possibly because the service has been uninstalled and deleted). - +The operation information does not exist (possibly because the service has been +uninstalled and deleted). Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` @@ -360,8 +314,6 @@ Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` Problem on the server side. See the message in the response for more details. - - Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` **Example:** @@ -379,8 +331,6 @@ Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` Error reported to the dispatcher by a downstream system. See the message in the response for more details. - - Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` **Example:** @@ -398,8 +348,6 @@ Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` Error communicating with a downstream system. See the message in the response for more details. - - Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` **Example:** @@ -411,15 +359,9 @@ Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` "status": 1 } - - - - PUT ``/dcae-deployments/{deploymentId}`` ---------------------------------------- - - Description +++++++++++ @@ -427,7 +369,6 @@ Description Request deployment of a DCAE service - Parameters ++++++++++ @@ -436,14 +377,11 @@ Parameters :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. - + deploymentId | path | Yes | string | | | Unique deployment identifier assigned by the API client. Request +++++++ - - .. _d_eea14e4929853a5aa415f44cd4868302: Body @@ -451,29 +389,20 @@ 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. - + 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. - - - +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 @@ -489,10 +418,8 @@ Responses ^^^^^^^ 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. - - + found the needed blueprint, created an instance of the topology in the + orchestrator, and started an installation workflow. Type: :ref:`DCAEDeploymentResponse <d_6157bd3de5c8c7de78f2ab86397667e0>` @@ -513,8 +440,6 @@ Type: :ref:`DCAEDeploymentResponse <d_6157bd3de5c8c7de78f2ab86397667e0>` Bad request: See the message in the response for details. - - Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` **Example:** @@ -529,9 +454,8 @@ Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` **409** ^^^^^^^ -A service with the specified deployment Id already exists. Using PUT to update the service is not a supported operation. - - +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>` @@ -550,8 +474,6 @@ Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` Bad request: The Content-Type header does not indicate that the content is 'application/json' - - Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` **Example:** @@ -569,8 +491,6 @@ Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` Problem on the server side. See the message in the response for more details. - - Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` **Example:** @@ -588,8 +508,6 @@ Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` Error reported to the dispatcher by a downstream system. See the message in the response for more details. - - Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` **Example:** @@ -607,8 +525,6 @@ Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` Error communicating with a downstream system. See the message in the response for more details. - - Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` **Example:** @@ -621,23 +537,14 @@ Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` } - - INFO ~~~~ - version and links - - - - GET ``/`` --------- - - Description +++++++++++ @@ -645,11 +552,9 @@ Description Returns version information and links to API operations - Request +++++++ - Responses +++++++++ @@ -658,7 +563,6 @@ Responses Success - .. _i_2e7b26d45eaa7203222963d454a86a88: **Response Schema:** @@ -674,15 +578,12 @@ Success 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" @@ -692,8 +593,6 @@ Links to API resources info | No | string | | | path for the server information endpoint - - **Example:** .. code-block:: javascript @@ -708,23 +607,15 @@ Links to API resources } - - POLICY ~~~~~~ - -policy update API consumed by policy-handler and debug API to find policies on components - - - - +policy update API consumed by policy-handler and debug API to find policies +on components GET ``/policy/components`` -------------------------- - - Description +++++++++++ @@ -732,11 +623,9 @@ Description debug API to find policies on components - Request +++++++ - Responses +++++++++ @@ -746,15 +635,9 @@ Responses deployment-handler found components with or without policies in cloudify - - - - POST ``/policy`` ---------------- - - Description +++++++++++ @@ -762,12 +645,9 @@ Description policy update API consumed by policy-handler - Request +++++++ - - .. _d_6ea6e6f48a0302e963a67833bbd0ff4a: Body @@ -787,42 +667,33 @@ request to update policies on DCAE components. 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 @@ -857,22 +728,18 @@ Responses **200** ^^^^^^^ -deployment-handler always responds with ok to /policy before processing the request - - +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" @@ -881,16 +748,10 @@ Request for deploying a DCAE service. 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. - - - +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: @@ -899,7 +760,6 @@ DCAEDeploymentResponse Model Structure Response body for a PUT or DELETE to /dcae-deployments/{deploymentId} - .. csv-table:: :delim: | :header: "Name", "Required", "Type", "Format", "Properties", "Description" @@ -909,15 +769,12 @@ Response body for a PUT or DELETE to /dcae-deployments/{deploymentId} 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" @@ -934,21 +791,18 @@ 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>` | | | + 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" @@ -956,7 +810,6 @@ Object providing a list of deployments href | No | string | | | URL for the service deployment - .. _d_74f3f4f847dfb6bd181fcae06ad880b4: DCAEErrorResponse Model Structure @@ -964,7 +817,6 @@ DCAEErrorResponse Model Structure Object reporting an error. - .. csv-table:: :delim: | :header: "Name", "Required", "Type", "Format", "Properties", "Description" @@ -978,8 +830,8 @@ Object reporting an error. DCAEOperationStatusResponse Model Structure ------------------------------------------- -Response body for a request for status of an installation or uninstallation operation. - +Response body for a request for status of an installation or uninstallation +operation. .. csv-table:: :delim: | @@ -996,14 +848,13 @@ Response body for a request for status of an installation or uninstallation oper 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. - +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: | @@ -1026,7 +877,7 @@ policy object :header: "Name", "Required", "Type", "Format", "Properties", "Description" :widths: 20, 10, 15, 15, 30, 25 - policy_body | Yes | :ref:`DCAEPolicyBody <d_7ffe00ee1aaae6811199d64ff3fea344>` | | | + policy_body | Yes | :ref:`DCAEPolicyBody <d_7ffe00ee1aaae6811199d64ff3fea344>` | | | policy_id | Yes | string | | | unique identifier of policy regardless of its version .. _d_7ffe00ee1aaae6811199d64ff3fea344: @@ -1049,11 +900,8 @@ policy_body - the whole object received from policy-engine **Config schema:** - the policy-config - the config data provided by policy owner - - DCAEPolicyRequest Model Structure --------------------------------- @@ -1071,35 +919,26 @@ request to update policies on DCAE components. 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 index a37ef14e..e392bab4 100644 --- a/docs/sections/apis/inventory.rst +++ b/docs/sections/apis/inventory.rst @@ -1,10 +1,12 @@ +.. This work is licensed under a + Creative Commons Attribution 4.0 International License. + DCAE Inventory API 3.0.4 ======================== .. toctree:: :maxdepth: 3 - Description ~~~~~~~~~~~ @@ -13,32 +15,24 @@ 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 +++++++++++ @@ -64,11 +58,9 @@ Parameters 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 +++++++++ @@ -77,7 +69,6 @@ Responses List of `DCAEServiceType` objects - Type: :ref:`InlineResponse200 <d_b1ccd4187d31690b8e704c0aa01b2c59>` **Example:** @@ -188,15 +179,9 @@ Type: :ref:`InlineResponse200 <d_b1ccd4187d31690b8e704c0aa01b2c59>` "totalCount": 1 } - - - - DELETE ``/dcae-service-types/{typeId}`` --------------------------------------- - - Description +++++++++++ @@ -212,13 +197,11 @@ Parameters :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" :widths: 20, 15, 10, 10, 10, 20, 30 - typeId | path | Yes | string | | | - + typeId | path | Yes | string | | | Request +++++++ - Responses +++++++++ @@ -227,7 +210,6 @@ Responses `DCAEServiceType` has been deactivated - Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` **Example:** @@ -245,7 +227,6 @@ Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` `DCAEServiceType` not found - Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` **Example:** @@ -263,7 +244,6 @@ Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` `DCAEServiceType` already gone - Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` **Example:** @@ -276,15 +256,9 @@ Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` "type": "somestring" } - - - - GET ``/dcae-service-types/{typeId}`` ------------------------------------ - - Description +++++++++++ @@ -300,13 +274,11 @@ Parameters :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" :widths: 20, 15, 10, 10, 10, 20, 30 - typeId | path | Yes | string | | | - + typeId | path | Yes | string | | | Request +++++++ - Responses +++++++++ @@ -315,7 +287,6 @@ Responses Single `DCAEServiceType` object - Type: :ref:`DCAEServiceType <d_b0cb5f12dbde8c0c42487c089983687e>` **Example:** @@ -364,7 +335,6 @@ Type: :ref:`DCAEServiceType <d_b0cb5f12dbde8c0c42487c089983687e>` Resource not found - Type: :ref:`DCAEServiceType <d_b0cb5f12dbde8c0c42487c089983687e>` **Example:** @@ -408,15 +378,9 @@ Type: :ref:`DCAEServiceType <d_b0cb5f12dbde8c0c42487c089983687e>` ] } - - - - POST ``/dcae-service-types`` ---------------------------- - - Description +++++++++++ @@ -424,12 +388,9 @@ Description 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 @@ -444,12 +405,12 @@ Body 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 | | | + 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 | | | + vnfTypes | No | array of string | | | .. code-block:: javascript @@ -483,7 +444,6 @@ Responses Single `DCAEServiceType` object. - Type: :ref:`DCAEServiceType <d_b0cb5f12dbde8c0c42487c089983687e>` **Example:** @@ -532,7 +492,6 @@ Type: :ref:`DCAEServiceType <d_b0cb5f12dbde8c0c42487c089983687e>` Bad request provided. - Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` **Example:** @@ -548,8 +507,8 @@ Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` **409** ^^^^^^^ -Failed to update because there are still DCAE services of the requested type running. - +Failed to update because there are still DCAE services of the requested type +running. Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` @@ -563,15 +522,9 @@ Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` "type": "somestring" } - - - - GET ``/dcae-services`` ---------------------- - - Description +++++++++++ @@ -588,19 +541,17 @@ Parameters :widths: 20, 15, 10, 10, 10, 20, 30 typeId | query | No | string | | | DCAE service type name - vnfId | query | No | string | | | + vnfId | query | No | string | | | vnfType | query | No | string | | | Filter by associated vnf type. This field is treated case insensitive. - vnfLocation | query | No | string | | | + 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 +++++++++ @@ -609,7 +560,6 @@ Responses List of `DCAEService` objects - Type: :ref:`InlineResponse2001 <d_31bb361a8900a0bed20df49b94f1e33b>` **Example:** @@ -835,7 +785,6 @@ Type: :ref:`InlineResponse2001 <d_31bb361a8900a0bed20df49b94f1e33b>` Bad response from DCAE controller - Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` **Example:** @@ -853,7 +802,6 @@ Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` Failed to connect with DCAE controller - Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` **Example:** @@ -866,15 +814,9 @@ Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` "type": "somestring" } - - - - GET ``/dcae-services-groupby/{propertyName}`` --------------------------------------------- - - Description +++++++++++ @@ -892,11 +834,9 @@ Parameters propertyName | path | Yes | string | | | Property to find unique values. Restricted to `type`, `vnfType`, `vnfLocation` - Request +++++++ - Responses +++++++++ @@ -905,7 +845,6 @@ Responses List of unique property values - Type: :ref:`DCAEServiceGroupByResults <d_a6dc4f986873bc126fc916189ffa5e91>` **Example:** @@ -950,15 +889,9 @@ Type: :ref:`DCAEServiceGroupByResults <d_a6dc4f986873bc126fc916189ffa5e91>` ] } - - - - DELETE ``/dcae-services/{serviceId}`` ------------------------------------- - - Description +++++++++++ @@ -974,13 +907,11 @@ Parameters :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" :widths: 20, 15, 10, 10, 10, 20, 30 - serviceId | path | Yes | string | | | - + serviceId | path | Yes | string | | | Request +++++++ - Responses +++++++++ @@ -989,13 +920,11 @@ Responses DCAE service has been removed - **404** ^^^^^^^ Unknown DCAE service - Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` **Example:** @@ -1008,15 +937,9 @@ Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` "type": "somestring" } - - - - GET ``/dcae-services/{serviceId}`` ---------------------------------- - - Description +++++++++++ @@ -1032,13 +955,11 @@ Parameters :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" :widths: 20, 15, 10, 10, 10, 20, 30 - serviceId | path | Yes | string | | | - + serviceId | path | Yes | string | | | Request +++++++ - Responses +++++++++ @@ -1047,7 +968,6 @@ Responses Single `DCAEService` object - Type: :ref:`DCAEService <d_ae85cd292c2b4046e1ea1bbb02c7ea63>` **Example:** @@ -1151,7 +1071,6 @@ Type: :ref:`DCAEService <d_ae85cd292c2b4046e1ea1bbb02c7ea63>` DCAE service not found - Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` **Example:** @@ -1169,7 +1088,6 @@ Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` Bad response from DCAE controller - Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` **Example:** @@ -1187,7 +1105,6 @@ Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` Failed to connect with DCAE controller - Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` **Example:** @@ -1200,15 +1117,9 @@ Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` "type": "somestring" } - - - - PUT ``/dcae-services/{serviceId}`` ---------------------------------- - - Description +++++++++++ @@ -1224,14 +1135,11 @@ Parameters :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" :widths: 20, 15, 10, 10, 10, 20, 30 - serviceId | path | Yes | string | | | - + serviceId | path | Yes | string | | | Request +++++++ - - .. _d_81c18e0dd7a3af8fb1ba658e72907e7b: Body @@ -1281,7 +1189,6 @@ Responses Single `DCAEService` object - Type: :ref:`DCAEService <d_ae85cd292c2b4046e1ea1bbb02c7ea63>` **Example:** @@ -1385,7 +1292,6 @@ Type: :ref:`DCAEService <d_ae85cd292c2b4046e1ea1bbb02c7ea63>` Bad request provided - Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` **Example:** @@ -1398,9 +1304,6 @@ Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` "type": "somestring" } - - - Data Structures ~~~~~~~~~~~~~~~ @@ -1414,9 +1317,9 @@ ApiResponseMessage Model Structure :header: "Name", "Required", "Type", "Format", "Properties", "Description" :widths: 20, 10, 15, 15, 30, 25 - code | No | integer | int32 | | - message | No | string | | | - type | No | string | | | + code | No | integer | int32 | | + message | No | string | | | + type | No | string | | | .. _d_ae85cd292c2b4046e1ea1bbb02c7ea63: @@ -1428,17 +1331,17 @@ DCAEService Model Structure :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 | | + 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 | | + modified | No | string | date-time | | selfLink | No | :ref:`Link <d_add3c3fd2e145f9e5a78be6e7b208ebb>` | | | Link.title is serviceId - serviceId | No | string | | | + serviceId | No | string | | | typeLink | No | :ref:`Link <d_add3c3fd2e145f9e5a78be6e7b208ebb>` | | | Link.title is typeId - vnfId | No | string | | | + 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 | | | + vnfType | No | string | | | .. _d_51674dafcc623be79f21ecea545c345d: @@ -1453,12 +1356,12 @@ DCAEServiceComponent Model Structure 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 | | + componentType | Yes | string | | | + created | Yes | string | date-time | | location | No | string | | | Location information of the component - modified | Yes | string | date-time | | + 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 | | | + status | No | string | | | .. _d_55af22c43245c290d643f75be1f4f254: @@ -1472,7 +1375,7 @@ DCAEServiceComponentRequest Model Structure 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 | | | + componentType | Yes | string | | | shareable | Yes | integer | int32 | | Used to determine if this component can be shared amongst different DCAE services .. _d_a6dc4f986873bc126fc916189ffa5e91: @@ -1486,7 +1389,7 @@ DCAEServiceGroupByResults Model Structure :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>` | | | + propertyValues | No | array of :ref:`DCAEServiceGroupByResultsPropertyValues <d_0119caa52e274e5e2311b367df38d686>` | | | .. _d_0119caa52e274e5e2311b367df38d686: @@ -1498,10 +1401,9 @@ DCAEServiceGroupByResultsPropertyValues Model Structure :header: "Name", "Required", "Type", "Format", "Properties", "Description" :widths: 20, 10, 15, 15, 30, 25 - count | No | integer | int32 | | + 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 | | | - + propertyValue | No | string | | | DCAEServiceRequest Model Structure ---------------------------------- @@ -1534,15 +1436,14 @@ DCAEServiceType Model Structure 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 | | | + 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 | | | - + vnfTypes | No | array of string | | | DCAEServiceTypeRequest Model Structure -------------------------------------- @@ -1556,12 +1457,12 @@ DCAEServiceTypeRequest Model Structure 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 | | | + 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 | | | + vnfTypes | No | array of string | | | .. _d_b1ccd4187d31690b8e704c0aa01b2c59: @@ -1573,9 +1474,9 @@ InlineResponse200 Model Structure :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 | | + items | No | array of :ref:`DCAEServiceType <d_b0cb5f12dbde8c0c42487c089983687e>` | | | + links | No | :ref:`InlineResponse200Links <d_e52a59e574408d4d622b3f1f61619b1c>` | | | + totalCount | No | integer | int32 | | .. _d_31bb361a8900a0bed20df49b94f1e33b: @@ -1587,9 +1488,9 @@ InlineResponse2001 Model Structure :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 | | + items | No | array of :ref:`DCAEService <d_ae85cd292c2b4046e1ea1bbb02c7ea63>` | | | + links | No | :ref:`InlineResponse200Links <d_e52a59e574408d4d622b3f1f61619b1c>` | | | + totalCount | No | integer | int32 | | .. _d_e52a59e574408d4d622b3f1f61619b1c: @@ -1603,8 +1504,8 @@ Pagination links :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>` | | | + nextLink | No | :ref:`Link <d_add3c3fd2e145f9e5a78be6e7b208ebb>` | | | + previousLink | No | :ref:`Link <d_add3c3fd2e145f9e5a78be6e7b208ebb>` | | | .. _d_add3c3fd2e145f9e5a78be6e7b208ebb: @@ -1616,19 +1517,18 @@ Link Model Structure :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>` | | | + 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: @@ -1636,5 +1536,3 @@ Map of {"key":"string"} UriBuilder Model Structure -------------------------- - - diff --git a/docs/sections/apis/pmmapper.rst b/docs/sections/apis/pmmapper.rst index 6b736e36..5da8bf16 100644 --- a/docs/sections/apis/pmmapper.rst +++ b/docs/sections/apis/pmmapper.rst @@ -1,12 +1,12 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 +.. This work is licensed under a + Creative Commons Attribution 4.0 International License. + ======================== 3GPP PM Mapper ======================== .. contents:: :depth: 3 -.. Overview ======== @@ -15,7 +15,6 @@ Component description can be found under `3GPP PM Mapper`_. .. _3GPP PM Mapper: ../../sections/services/pm-mapper/index.html - Paths ===== @@ -26,7 +25,6 @@ Description ~~~~~~~~~~~ Publish the PM Measurment file to PM Mapper. - Responses ~~~~~~~~~ @@ -36,15 +34,14 @@ Responses | **200** | successful response | +-----------+---------------------+ - GET ``/healthcheck`` -------------------- - - Description ~~~~~~~~~~~ -This is the health check endpoint. If this returns a 200, the server is alive. If anything other than a 200, the server is either dead or no connection to pm mapper. +This is the health check endpoint. If this returns a 200, the server is alive. +If anything other than a 200, the server is either dead or no connection to +pm mapper. Responses ~~~~~~~~~ @@ -55,15 +52,13 @@ Responses | **200** | successful response | +-----------+---------------------+ - GET ``/reconfigure`` -------------------- - - Description ~~~~~~~~~~~ -This is the reconfigure endpoint to fetch updated config information using config binding service. +This is the reconfigure endpoint to fetch updated config information using +config binding service. Responses ~~~~~~~~~ diff --git a/docs/sections/apis/swagger_vescollector.json b/docs/sections/apis/swagger_vescollector.json new file mode 100644 index 00000000..90cc769e --- /dev/null +++ b/docs/sections/apis/swagger_vescollector.json @@ -0,0 +1,928 @@ +{ + "swagger": "2.0", + "info": { + "version": "1.3.2", + "title": "VES Collector", + "description": "Virtual Event Streaming (VES) Collector is RESTful collector for processing JSON messages. The collector verifies the source and validates the events against VES schema before distributing to DMAAP MR topics\n", + "termsOfService": "urn:tos", + "contact": {}, + "license": { + "name": "Apache 2.0", + "url": "http://www.apache.org/licenses/LICENSE-2.0" + } + }, + "host": "localhost:8080", + "basePath": "/", + "tags": [ + { + "name": "basic-error-controller", + "description": "Basic Error Controller" + }, + { + "name": "ves-rest-controller", + "description": "Ves Rest Controller" + } + ], + "paths": { + "/": { + "get": { + "tags": [ + "ves-rest-controller" + ], + "summary": "mainPage", + "operationId": "mainPageUsingGET", + "produces": [ + "*/*" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/error": { + "get": { + "tags": [ + "basic-error-controller" + ], + "summary": "errorHtml", + "operationId": "errorHtmlUsingGET", + "produces": [ + "text/html" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ModelAndView" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + }, + "head": { + "tags": [ + "basic-error-controller" + ], + "summary": "errorHtml", + "operationId": "errorHtmlUsingHEAD", + "consumes": [ + "application/json" + ], + "produces": [ + "text/html" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ModelAndView" + } + }, + "204": { + "description": "No Content" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + } + } + }, + "post": { + "tags": [ + "basic-error-controller" + ], + "summary": "errorHtml", + "operationId": "errorHtmlUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "text/html" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ModelAndView" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + }, + "put": { + "tags": [ + "basic-error-controller" + ], + "summary": "errorHtml", + "operationId": "errorHtmlUsingPUT", + "consumes": [ + "application/json" + ], + "produces": [ + "text/html" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ModelAndView" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + }, + "delete": { + "tags": [ + "basic-error-controller" + ], + "summary": "errorHtml", + "operationId": "errorHtmlUsingDELETE", + "produces": [ + "text/html" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ModelAndView" + } + }, + "204": { + "description": "No Content" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + } + } + }, + "options": { + "tags": [ + "basic-error-controller" + ], + "summary": "errorHtml", + "operationId": "errorHtmlUsingOPTIONS", + "consumes": [ + "application/json" + ], + "produces": [ + "text/html" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ModelAndView" + } + }, + "204": { + "description": "No Content" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + } + } + }, + "patch": { + "tags": [ + "basic-error-controller" + ], + "summary": "errorHtml", + "operationId": "errorHtmlUsingPATCH", + "consumes": [ + "application/json" + ], + "produces": [ + "text/html" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ModelAndView" + } + }, + "204": { + "description": "No Content" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + } + } + } + }, + "/eventListener/v1": { + "post": { + "tags": [ + "ves-rest-controller" + ], + "summary": "receiveEvent", + "operationId": "receiveEventUsingPOST", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "in": "body", + "name": "jsonPayload", + "description": "jsonPayload", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/eventListener/v1/eventBatch": { + "post": { + "tags": [ + "ves-rest-controller" + ], + "summary": "receiveEvent", + "operationId": "receiveEventUsingPOST_1", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "in": "body", + "name": "jsonPayload", + "description": "jsonPayload", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/eventListener/v2": { + "post": { + "tags": [ + "ves-rest-controller" + ], + "summary": "receiveEvent", + "operationId": "receiveEventUsingPOST_2", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "in": "body", + "name": "jsonPayload", + "description": "jsonPayload", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/eventListener/v2/eventBatch": { + "post": { + "tags": [ + "ves-rest-controller" + ], + "summary": "receiveEvent", + "operationId": "receiveEventUsingPOST_3", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "in": "body", + "name": "jsonPayload", + "description": "jsonPayload", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/eventListener/v3": { + "post": { + "tags": [ + "ves-rest-controller" + ], + "summary": "receiveEvent", + "operationId": "receiveEventUsingPOST_4", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "in": "body", + "name": "jsonPayload", + "description": "jsonPayload", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/eventListener/v3/eventBatch": { + "post": { + "tags": [ + "ves-rest-controller" + ], + "summary": "receiveEvent", + "operationId": "receiveEventUsingPOST_5", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "in": "body", + "name": "jsonPayload", + "description": "jsonPayload", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/eventListener/v4": { + "post": { + "tags": [ + "ves-rest-controller" + ], + "summary": "receiveEvent", + "operationId": "receiveEventUsingPOST_6", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "in": "body", + "name": "jsonPayload", + "description": "jsonPayload", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/eventListener/v4/eventBatch": { + "post": { + "tags": [ + "ves-rest-controller" + ], + "summary": "receiveEvent", + "operationId": "receiveEventUsingPOST_7", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "in": "body", + "name": "jsonPayload", + "description": "jsonPayload", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/eventListener/v5": { + "post": { + "tags": [ + "ves-rest-controller" + ], + "summary": "receiveEvent", + "operationId": "receiveEventUsingPOST_8", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "in": "body", + "name": "jsonPayload", + "description": "jsonPayload", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/eventListener/v5/eventBatch": { + "post": { + "tags": [ + "ves-rest-controller" + ], + "summary": "receiveEvent", + "operationId": "receiveEventUsingPOST_9", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "in": "body", + "name": "jsonPayload", + "description": "jsonPayload", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/eventListener/v7": { + "post": { + "tags": [ + "ves-rest-controller" + ], + "summary": "receiveEvent", + "operationId": "receiveEventUsingPOST_10", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "in": "body", + "name": "jsonPayload", + "description": "jsonPayload", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + }, + "/eventListener/v7/eventBatch": { + "post": { + "tags": [ + "ves-rest-controller" + ], + "summary": "receiveEvent", + "operationId": "receiveEventUsingPOST_11", + "consumes": [ + "application/json" + ], + "produces": [ + "*/*" + ], + "parameters": [ + { + "in": "body", + "name": "jsonPayload", + "description": "jsonPayload", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" + } + }, + "201": { + "description": "Created" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + } + } + } + } + }, + "definitions": { + "ModelAndView": { + "type": "object", + "properties": { + "empty": { + "type": "boolean" + }, + "model": { + "type": "object" + }, + "modelMap": { + "type": "object", + "additionalProperties": { + "type": "object" + } + }, + "reference": { + "type": "boolean" + }, + "status": { + "type": "string", + "enum": [ + "100", + "101", + "102", + "103", + "200", + "201", + "202", + "203", + "204", + "205", + "206", + "207", + "208", + "226", + "300", + "301", + "302", + "303", + "304", + "305", + "307", + "308", + "400", + "401", + "402", + "403", + "404", + "405", + "406", + "407", + "408", + "409", + "410", + "411", + "412", + "413", + "414", + "415", + "416", + "417", + "418", + "419", + "420", + "421", + "422", + "423", + "424", + "426", + "428", + "429", + "431", + "451", + "500", + "501", + "502", + "503", + "504", + "505", + "506", + "507", + "508", + "509", + "510", + "511" + ] + }, + "view": { + "$ref": "#/definitions/View" + }, + "viewName": { + "type": "string" + } + }, + "title": "ModelAndView" + }, + "View": { + "type": "object", + "properties": { + "contentType": { + "type": "string" + } + }, + "title": "View" + } + } +} diff --git a/docs/sections/apis/ves.rst b/docs/sections/apis/ves.rst index a4503d23..f7f88020 100644 --- a/docs/sections/apis/ves.rst +++ b/docs/sections/apis/ves.rst @@ -1,63 +1,49 @@ -VES Collector 1.3.1 +.. This work is licensed under a + Creative Commons Attribution 4.0 International License. + +VES Collector 1.3.2 =================== .. toctree:: :maxdepth: 3 - Description ~~~~~~~~~~~ -Virtual Event Streaming (VES) Collector is RESTful collector for processing JSON messages. The collector verifies the source and validates the events against VES schema before distributing to DMAAP MR topics - +Virtual Event Streaming (VES) Collector is RESTful collector for processing +JSON messages. The collector verifies the source and validates the events +against VES schema before distributing to DMAAP MR topics. +.. csv-table:: + :header: "API name", "Swagger JSON", "Swagger YAML" + :widths: 10,5,5 + "VES Collector", ":download:`link <swagger_vescollector.json>`", ":download:`link <swagger_vescollector.yaml>`" Contact Information ~~~~~~~~~~~~~~~~~~~ - - dcae@lists.openecomp.org - - - - - Security ~~~~~~~~ - .. _securities_basicAuth: basicAuth (HTTP Basic Authentication) ------------------------------------- - *HTTP Basic Authentication. Works over `HTTP` and `HTTPS`* - - - - DEFAULT ~~~~~~~ - - - GET ``/healthcheck`` -------------------- - - - - Request +++++++ - Responses +++++++++ @@ -66,16 +52,9 @@ Responses healthcheck successful - - - - - POST ``/eventListener/v5`` -------------------------- - - Description +++++++++++ @@ -83,12 +62,9 @@ Description uri for posting VES event objects - Request +++++++ - - .. _d_f598222d7a83ca9c3538556b263682d1: Body @@ -99,7 +75,7 @@ Body :header: "Name", "Required", "Type", "Format", "Properties", "Description" :widths: 20, 10, 15, 15, 30, 25 - event | No | :ref:`event <d_0eeffb3cd3e31135c2f3cf8ee4a2bdbb>` | | | + event | No | :ref:`event <d_0eeffb3cd3e31135c2f3cf8ee4a2bdbb>` | | | .. code-block:: javascript @@ -956,7 +932,6 @@ Responses VES Event Accepted. - Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` **Example:** @@ -974,7 +949,6 @@ Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` Bad request provided - Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` **Example:** @@ -992,7 +966,6 @@ Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` Unauthorized request - Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` **Example:** @@ -1010,7 +983,6 @@ Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` Service Unavailable - Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` **Example:** @@ -1023,8 +995,6 @@ Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` "type": "somestring" } - - Security ++++++++ @@ -1034,12 +1004,9 @@ Security :ref:`basicAuth <securities_basicAuth>`, "" - POST ``/eventListener/v5/eventBatch`` ------------------------------------- - - Description +++++++++++ @@ -1047,13 +1014,9 @@ Description uri for posting VES batch event objects - Request +++++++ - - - Body ^^^^ @@ -1062,7 +1025,7 @@ Body :header: "Name", "Required", "Type", "Format", "Properties", "Description" :widths: 20, 10, 15, 15, 30, 25 - event | No | :ref:`event <d_0eeffb3cd3e31135c2f3cf8ee4a2bdbb>` | | | + event | No | :ref:`event <d_0eeffb3cd3e31135c2f3cf8ee4a2bdbb>` | | | .. code-block:: javascript @@ -1919,7 +1882,6 @@ Responses VES Event Accepted. - Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` **Example:** @@ -1937,7 +1899,6 @@ Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` Bad request provided - Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` **Example:** @@ -1955,7 +1916,6 @@ Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` Unauthorized request - Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` **Example:** @@ -1973,7 +1933,6 @@ Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` Service Unavailable - Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` **Example:** @@ -1986,8 +1945,6 @@ Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` "type": "somestring" } - - Security ++++++++ @@ -1996,11 +1953,10 @@ Security :widths: 15, 45 :ref:`basicAuth <securities_basicAuth>`, "" - + Data Structures ~~~~~~~~~~~~~~~ - ApiResponseMessage Model Structure ---------------------------------- @@ -2009,10 +1965,9 @@ ApiResponseMessage Model Structure :header: "Name", "Required", "Type", "Format", "Properties", "Description" :widths: 20, 10, 15, 15, 30, 25 - code | No | integer | int32 | | - message | No | string | | | - type | No | string | | | - + code | No | integer | int32 | | + message | No | string | | | + type | No | string | | | VES5Request Model Structure --------------------------- @@ -2022,7 +1977,7 @@ VES5Request Model Structure :header: "Name", "Required", "Type", "Format", "Properties", "Description" :widths: 20, 10, 15, 15, 30, 25 - event | No | :ref:`event <d_0eeffb3cd3e31135c2f3cf8ee4a2bdbb>` | | | + event | No | :ref:`event <d_0eeffb3cd3e31135c2f3cf8ee4a2bdbb>` | | | .. _d_df249c51a416f54e5609f2ffffe059c0: @@ -2036,8 +1991,8 @@ number of times an identified codec was used over the measurementInterval :header: "Name", "Required", "Type", "Format", "Properties", "Description" :widths: 20, 10, 15, 15, 30, 25 - codecIdentifier | Yes | string | | | - numberInUse | Yes | integer | | | + codecIdentifier | Yes | string | | | + numberInUse | Yes | integer | | | .. _d_a68e1b21fdcef792db73f711201c56ad: @@ -2055,7 +2010,7 @@ fields common to all events eventId | Yes | string | | | event key that is unique to the event source eventName | Yes | string | | | unique event name eventType | No | string | | | for example - applicationVnf, guestOS, hostOS, platform - internalHeaderFields | No | :ref:`internalHeaderFields <d_2873d30f54c59ef635c1fc0cbbaa89f1>` | | | + internalHeaderFields | No | :ref:`internalHeaderFields <d_2873d30f54c59ef635c1fc0cbbaa89f1>` | | | lastEpochMicrosec | Yes | number | | | the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds nfNamingCode | No | string | | | 4 character network function type, aligned with vnf naming standards nfcNamingCode | No | string | | | 3 character network function component type, aligned with vfc naming standards @@ -2080,10 +2035,10 @@ performance counter :header: "Name", "Required", "Type", "Format", "Properties", "Description" :widths: 20, 10, 15, 15, 30, 25 - criticality | Yes | string | | {'enum': ['CRIT', 'MAJ']} | - name | Yes | string | | | - thresholdCrossed | Yes | string | | | - value | Yes | string | | | + criticality | Yes | string | | {'enum': ['CRIT', 'MAJ']} | + name | Yes | string | | | + thresholdCrossed | Yes | string | | | + value | Yes | string | | | .. _d_6f081937f31c09078c8acf9212d6c449: @@ -2176,23 +2131,23 @@ provides end of call voice quality metrics adjacencyName | Yes | string | | | adjacency name endpointDescription | Yes | string | | {'enum': ['Caller', 'Callee']} | Either Caller or Callee - endpointJitter | No | number | | | - endpointRtpOctetsDiscarded | No | number | | | - endpointRtpOctetsReceived | No | number | | | - endpointRtpOctetsSent | No | number | | | - endpointRtpPacketsDiscarded | No | number | | | - endpointRtpPacketsReceived | No | number | | | - endpointRtpPacketsSent | No | number | | | - localJitter | No | number | | | - localRtpOctetsDiscarded | No | number | | | - localRtpOctetsReceived | No | number | | | - localRtpOctetsSent | No | number | | | - localRtpPacketsDiscarded | No | number | | | - localRtpPacketsReceived | No | number | | | - localRtpPacketsSent | No | number | | | + endpointJitter | No | number | | | + endpointRtpOctetsDiscarded | No | number | | | + endpointRtpOctetsReceived | No | number | | | + endpointRtpOctetsSent | No | number | | | + endpointRtpPacketsDiscarded | No | number | | | + endpointRtpPacketsReceived | No | number | | | + endpointRtpPacketsSent | No | number | | | + localJitter | No | number | | | + localRtpOctetsDiscarded | No | number | | | + localRtpOctetsReceived | No | number | | | + localRtpOctetsSent | No | number | | | + localRtpPacketsDiscarded | No | number | | | + localRtpPacketsReceived | No | number | | | + localRtpPacketsSent | No | number | | | mosCqe | No | number | | | 1-5 1dp packetLossPercent | No | number | | | Calculated percentage packet loss based on Endpoint RTP packets lost (as reported in RTCP) and Local RTP packets sent. Direction is based on Endpoint description (Caller, Callee). Decimal (2 dp) - packetsLost | No | number | | | + packetsLost | No | number | | | rFactor | No | number | | | 0-100 roundTripDelay | No | number | | | millisecs @@ -2208,17 +2163,17 @@ the root level of the common event format :header: "Name", "Required", "Type", "Format", "Properties", "Description" :widths: 20, 10, 15, 15, 30, 25 - commonEventHeader | Yes | :ref:`commonEventHeader <d_2dc9a27be1410f60241c5f63c636bb7e>` | | | - faultFields | No | :ref:`faultFields <d_e7aa5254472f7823fdd6d5a090bfd0a4>` | | | - heartbeatFields | No | :ref:`heartbeatFields <d_6ea626e11ce7887cddd39c36ff4f0926>` | | | - measurementsForVfScalingFields | No | :ref:`measurementsForVfScalingFields <d_669cf98e276c9992abd27056c432bbb2>` | | | - mobileFlowFields | No | :ref:`mobileFlowFields <d_dc18fe1d28fe3ef664c3f4ab777d8424>` | | | - otherFields | No | :ref:`otherFields <d_5a79cd7ce784d60fd832d9c7c0a24322>` | | | - sipSignalingFields | No | :ref:`sipSignalingFields <d_c3e191f0b26ddd68f927ac0c8b551c5e>` | | | - stateChangeFields | No | :ref:`stateChangeFields <d_c5450f1a263d0a2b0c64c96119f7d759>` | | | - syslogFields | No | :ref:`syslogFields <d_782271970af04a3b0e5a5da9b30996d2>` | | | - thresholdCrossingAlertFields | No | :ref:`thresholdCrossingAlertFields <d_bd95ac8a5536a5bb5e6a0de7e64b9f20>` | | | - voiceQualityFields | No | :ref:`voiceQualityFields <d_9551641bd1c775d9fcf4e45353de8e43>` | | | + commonEventHeader | Yes | :ref:`commonEventHeader <d_2dc9a27be1410f60241c5f63c636bb7e>` | | | + faultFields | No | :ref:`faultFields <d_e7aa5254472f7823fdd6d5a090bfd0a4>` | | | + heartbeatFields | No | :ref:`heartbeatFields <d_6ea626e11ce7887cddd39c36ff4f0926>` | | | + measurementsForVfScalingFields | No | :ref:`measurementsForVfScalingFields <d_669cf98e276c9992abd27056c432bbb2>` | | | + mobileFlowFields | No | :ref:`mobileFlowFields <d_dc18fe1d28fe3ef664c3f4ab777d8424>` | | | + otherFields | No | :ref:`otherFields <d_5a79cd7ce784d60fd832d9c7c0a24322>` | | | + sipSignalingFields | No | :ref:`sipSignalingFields <d_c3e191f0b26ddd68f927ac0c8b551c5e>` | | | + stateChangeFields | No | :ref:`stateChangeFields <d_c5450f1a263d0a2b0c64c96119f7d759>` | | | + syslogFields | No | :ref:`syslogFields <d_782271970af04a3b0e5a5da9b30996d2>` | | | + thresholdCrossingAlertFields | No | :ref:`thresholdCrossingAlertFields <d_bd95ac8a5536a5bb5e6a0de7e64b9f20>` | | | + voiceQualityFields | No | :ref:`voiceQualityFields <d_9551641bd1c775d9fcf4e45353de8e43>` | | | .. _d_4089a4a9ee684770c6f37a588a577589: @@ -2270,8 +2225,8 @@ number of times an identified feature was used over the measurementInterval :header: "Name", "Required", "Type", "Format", "Properties", "Description" :widths: 20, 10, 15, 15, 30, 25 - featureIdentifier | Yes | string | | | - featureUtilization | Yes | integer | | | + featureIdentifier | Yes | string | | | + featureUtilization | Yes | integer | | | .. _d_a9799335edbbc52c7f0c5191f7bd09ee: @@ -2285,28 +2240,29 @@ name value pair :header: "Name", "Required", "Type", "Format", "Properties", "Description" :widths: 20, 10, 15, 15, 30, 25 - name | Yes | string | | | - value | Yes | string | | | + name | Yes | string | | | + value | Yes | string | | | .. _d_18e1fa5fd6774deefce826b075f8b6e7: filesystemUsage Model Structure ------------------------------- -disk usage of an identified virtual machine in gigabytes and/or gigabytes per second +disk usage of an identified virtual machine in gigabytes and/or gigabytes per +second .. csv-table:: :delim: | :header: "Name", "Required", "Type", "Format", "Properties", "Description" :widths: 20, 10, 15, 15, 30, 25 - blockConfigured | Yes | number | | | - blockIops | Yes | number | | | - blockUsed | Yes | number | | | - ephemeralConfigured | Yes | number | | | - ephemeralIops | Yes | number | | | - ephemeralUsed | Yes | number | | | - filesystemName | Yes | string | | | + blockConfigured | Yes | number | | | + blockIops | Yes | number | | | + blockUsed | Yes | number | | | + ephemeralConfigured | Yes | number | | | + ephemeralIops | Yes | number | | | + ephemeralUsed | Yes | number | | | + filesystemName | Yes | string | | | .. _d_bb1527d221e848e0896c78552979238b: @@ -2392,16 +2348,16 @@ optional field block for fields specific to heartbeat events internalHeaderFields Model Structure ------------------------------------ -enrichment fields for internal VES Event Listener service use only, not supplied by event sources - - +enrichment fields for internal VES Event Listener service use only, not +supplied by event sources .. _d_d8868aee802ae8e2b1e7ea1c4ecc1f54: jsonObject Model Structure -------------------------- -json object schema, name and other meta-information along with one or more object instances +json object schema, name and other meta-information along with one or more +object instances .. csv-table:: :delim: | @@ -2420,7 +2376,8 @@ json object schema, name and other meta-information along with one or more objec jsonObjectInstance Model Structure ---------------------------------- -meta-information about an instance of a jsonObject along with the actual object instance +meta-information about an instance of a jsonObject along with the actual +object instance .. csv-table:: :delim: | @@ -2435,11 +2392,8 @@ meta-information about an instance of a jsonObject along with the actual object **Objectinstance schema:** - an instance conforming to the jsonObject schema - - .. _d_a217491e9c44487ec7bbd9ce3ac9dddb: key Model Structure @@ -2468,9 +2422,9 @@ number of counts falling within a defined latency bucket :header: "Name", "Required", "Type", "Format", "Properties", "Description" :widths: 20, 10, 15, 15, 30, 25 - countsInTheBucket | Yes | number | | | - highEndOfLatencyBucket | No | number | | | - lowEndOfLatencyBucket | No | number | | | + countsInTheBucket | Yes | number | | | + highEndOfLatencyBucket | No | number | | | + lowEndOfLatencyBucket | No | number | | | .. _d_669cf98e276c9992abd27056c432bbb2: @@ -2545,7 +2499,7 @@ mobileFlow fields connectionType | No | string | | | Abbreviation referencing a 3GPP reference point e.g., S1-U, S11, etc ecgi | No | string | | | Evolved Cell Global Id flowDirection | Yes | string | | | Flow direction, indicating if the reporting node is the source of the flow or destination for the flow - gtpPerFlowMetrics | Yes | :ref:`gtpPerFlowMetrics <d_bb1527d221e848e0896c78552979238b>` | | | + gtpPerFlowMetrics | Yes | :ref:`gtpPerFlowMetrics <d_bb1527d221e848e0896c78552979238b>` | | | gtpProtocolType | No | string | | | GTP protocol gtpVersion | No | string | | | GTP protocol version httpHeader | No | string | | | HTTP request header, if the flow connects to a node referenced by HTTP @@ -2584,14 +2538,15 @@ an array of name value pairs along with a name for the array :widths: 20, 10, 15, 15, 30, 25 arrayOfFields | Yes | array of :ref:`field <d_a9799335edbbc52c7f0c5191f7bd09ee>` | | | array of name value pairs - name | Yes | string | | | + name | Yes | string | | | .. _d_5a79cd7ce784d60fd832d9c7c0a24322: otherFields Model Structure --------------------------- -fields for events belonging to the 'other' domain of the commonEventHeader domain enumeration +fields for events belonging to the 'other' domain of the commonEventHeader +domain enumeration .. csv-table:: :delim: | @@ -2641,7 +2596,7 @@ sip signaling fields remotePort | Yes | string | | | port of peer endpoint sipSignalingFieldsVersion | Yes | number | | | version of the sipSignalingFields block summarySip | No | string | | | the SIP Method or Response (INVITE, 200 OK, BYE, etc) - vendorVnfNameFields | Yes | :ref:`vendorVnfNameFields <d_d694eebbbc0078612d2ba22e0cbf814c>` | | | + vendorVnfNameFields | Yes | :ref:`vendorVnfNameFields <d_d694eebbbc0078612d2ba22e0cbf814c>` | | | .. _d_c5450f1a263d0a2b0c64c96119f7d759: @@ -2666,7 +2621,8 @@ stateChange fields suppressedNvPairs Model Structure --------------------------------- -List of specific NvPairsNames to suppress within a given Name-Value Field for event Throttling +List of specific NvPairsNames to suppress within a given Name-Value Field +for event Throttling .. csv-table:: :delim: | @@ -2688,7 +2644,7 @@ sysLog fields :header: "Name", "Required", "Type", "Format", "Properties", "Description" :widths: 20, 10, 15, 15, 30, 25 - additionalFields | No | string | | | additional syslog fields if needed provided as name=value + additionalFields | No | string | | | additional syslog fields if needed provided as name=value eventSourceHost | No | string | | | hostname of the device eventSourceType | Yes | string | | | type of event source; examples: other, router, switch, host, card, port, slotThreshold, portThreshold, virtualMachine, virtualNetworkFunction syslogFacility | No | integer | | | numeric code from 0 to 23 for facility--see table in documentation @@ -2737,7 +2693,8 @@ fields specific to threshold crossing alert events vNicPerformance Model Structure ------------------------------- -describes the performance and errors of an identified virtual network interface card +describes the performance and errors of an identified virtual network +interface card .. csv-table:: :delim: | @@ -2807,9 +2764,9 @@ provides statistics related to customer facing voice products calleeSideCodec | Yes | string | | | callee codec for the call callerSideCodec | Yes | string | | | caller codec for the call correlator | Yes | string | | | this is the same for all events on this call - endOfCallVqmSummaries | No | :ref:`endOfCallVqmSummaries <d_c911a0a8abdb511d7cd6590f383d817b>` | | | + endOfCallVqmSummaries | No | :ref:`endOfCallVqmSummaries <d_c911a0a8abdb511d7cd6590f383d817b>` | | | midCallRtcp | Yes | string | | | Base64 encoding of the binary RTCP data excluding Eth/IP/UDP headers phoneNumber | No | string | | | phone number associated with the correlator - vendorVnfNameFields | Yes | :ref:`vendorVnfNameFields <d_d694eebbbc0078612d2ba22e0cbf814c>` | | | + vendorVnfNameFields | Yes | :ref:`vendorVnfNameFields <d_d694eebbbc0078612d2ba22e0cbf814c>` | | | voiceQualityFieldsVersion | Yes | number | | | version of the voiceQualityFields block |