diff options
Diffstat (limited to 'docs/sections/apis')
| -rw-r--r-- | docs/sections/apis/cdapbroker.rst | 996 | ||||
| -rw-r--r-- | docs/sections/apis/cdapbroker.yaml | 435 | ||||
| -rw-r--r-- | docs/sections/apis/config_binding.rst | 113 | ||||
| -rw-r--r-- | docs/sections/apis/config_binding.yaml | 50 | ||||
| -rw-r--r-- | docs/sections/apis/configbinding.rst | 238 | ||||
| -rw-r--r-- | docs/sections/apis/configbinding.yaml | 100 | ||||
| -rw-r--r-- | docs/sections/apis/deployment-handler-API.yaml | 50 | ||||
| -rw-r--r-- | docs/sections/apis/deployment-handler.rst (renamed from docs/sections/apis/deploymenthandler.rst) | 262 | ||||
| -rw-r--r-- | docs/sections/apis/inventory.rst (renamed from docs/sections/apis/inventory_api.rst) | 938 | ||||
| -rw-r--r-- | docs/sections/apis/swagger_inventory.yaml (renamed from docs/sections/apis/inventory_api.yaml) | 0 | ||||
| -rw-r--r-- | docs/sections/apis/swagger_vescollector.yaml (renamed from docs/sections/apis/ves.yaml) | 0 | ||||
| -rw-r--r-- | docs/sections/apis/ves.rst | 161 |
12 files changed, 1114 insertions, 2229 deletions
diff --git a/docs/sections/apis/cdapbroker.rst b/docs/sections/apis/cdapbroker.rst deleted file mode 100644 index c145dbce..00000000 --- a/docs/sections/apis/cdapbroker.rst +++ /dev/null @@ -1,996 +0,0 @@ -CDAP Broker API 4.0.10 -====================== - -.. toctree:: - :maxdepth: 3 - - - - - -DEFAULT -~~~~~~~ - - - - -DELETE ``/application/{appname}`` ---------------------------------- - - - -Description -+++++++++++ - -.. raw:: html - - Remove an app for service and configuration discovery. This will remove the metrics and health endpoints for this app. - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - appname | path | Yes | string | text | | Name of the application. - - -Request -+++++++ - - -Responses -+++++++++ - -**200** -^^^^^^^ - -Successful response - - -**404** -^^^^^^^ - -no app with name 'appname' registered with this broker. - - - - - - -GET ``/`` ---------- - - - -Description -+++++++++++ - -.. raw:: html - - shows some information about this service - - -Request -+++++++ - - -Responses -+++++++++ - -**200** -^^^^^^^ - -successful response - - -Type: :ref:`info <d_060ca512d6d771a97a7d0f50886f6b14>` - -**Example:** - -.. code-block:: javascript - - { - "broker API version": "somestring", - "cdap GUI port": 1, - "cdap cluster version": "somestring", - "managed cdap url": "somestring", - "number of applications registered": 1, - "uptime (s)": 1 - } - - - - - -GET ``/application`` --------------------- - - - -Description -+++++++++++ - -.. raw:: html - - get all applications registered with this broker - - -Request -+++++++ - - -Responses -+++++++++ - -**200** -^^^^^^^ - -successful response - - -Type: array of :ref:`appname <d_2f6991f1775468c3ce48a2778455be93>` - - -**Example:** - -.. code-block:: javascript - - [ - "somestring", - "somestring" - ] - - - - - -GET ``/application/{appname}`` ------------------------------- - - - -Description -+++++++++++ - -.. raw:: html - - Returns the representation of the application resource, including the links for healthcheck and metrics. - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - appname | path | Yes | string | text | | Name of the application. - - -Request -+++++++ - - -Responses -+++++++++ - -**200** -^^^^^^^ - -Successful response - - -Type: :ref:`Application <d_2b315c86978b3cd8c6edfbe745f1afa2>` - -**Example:** - -.. code-block:: javascript - - { - "appname": "somestring", - "connectionurl": "somestring", - "healthcheckurl": "somestring", - "metricsurl": "somestring", - "serviceendpoints": [ - { - "method": "somestring", - "url": "somestring" - }, - { - "method": "somestring", - "url": "somestring" - } - ], - "url": "somestring" - } - -**404** -^^^^^^^ - -no app with name 'appname' registered with this broker. - - - - - - -GET ``/application/{appname}/healthcheck`` ------------------------------------------- - - - -Description -+++++++++++ - -.. raw:: html - - Perform a healthcheck on the running app appname. - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - appname | path | Yes | string | test | | Name of the application to get the healthcheck for. - - -Request -+++++++ - - -Responses -+++++++++ - -**200** -^^^^^^^ - -Successful response, healthcheck pass - - -**404** -^^^^^^^ - -no app with name 'appname' registered with this broker, or the healthcheck has failed (though I would like to disambiguiate from the first case, CDAP returns a 404 for this). - - - - - - -GET ``/application/{appname}/metrics`` --------------------------------------- - - - -Description -+++++++++++ - -.. raw:: html - - Get live (real-time) app specific metrics for the running app appname. Metrics are customized per each app by the component developer - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - appname | path | Yes | string | test | | Name of the application to get metrics for. - - -Request -+++++++ - - -Responses -+++++++++ - -**200** -^^^^^^^ - -Successful response - - -Type: :ref:`MetricsObject <d_5d4c5a47c1043833affa67eb27bf3d9d>` - -**Example:** - -.. code-block:: javascript - - { - "appmetrics": {} - } - -**404** -^^^^^^^ - -no app with name 'appname' registered with this broker. - - - - - - -POST ``/application/delete`` ----------------------------- - - - -Description -+++++++++++ - -.. raw:: html - - endpoint to delete multiple applications at once. Returns an array of status codes, where statuscode[i] = response returned from DELETE(application/i) - - -Request -+++++++ - - - -.. _d_c0830b0f8b495da06c2fef152ce05dba: - -Body -^^^^ - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - appnames | No | array of :ref:`appname <d_2f6991f1775468c3ce48a2778455be93>` | | | - -.. code-block:: javascript - - { - "appnames": [ - "somestring", - "somestring" - ] - } - -Responses -+++++++++ - -**200** -^^^^^^^ - -successful response - - -Type: array of :ref:`returncode <d_5a28f16eed72be7d9a8279c0e1f05386>` - - -**Example:** - -.. code-block:: javascript - - [ - 1, - 1 - ] - - - - - -PUT ``/application/{appname}`` ------------------------------- - - - -Description -+++++++++++ - -.. raw:: html - - Register an app for service and configuration discovery. This will light up a metrics and health endpoint for this app. `appname` is assumed to also be the key in consul. - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - appname | path | Yes | string | text | | Name of the application. - - -Request -+++++++ - - - -.. _d_a151b00939024528c17a91cf47a4eae3: - -Body -^^^^ - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - app_config | No | :ref:`app_config <i_13b2658afc25a955a6b4b48b9898c1a3>` | | | the application config JSON - app_preferences | No | :ref:`app_preferences <i_57297f6d8a6251aeb045f0872bf38d81>` | | | the application preferences JSON - artifact_name | No | string | | | the name of the CDAP artifact to be added - cdap_application_type | No | string | | {'enum': ['program-flowlet']} | denotes whether this is a program-flowlet style application or a hydrator pipeline. For program-flowlet style apps, this value must be 'program-flowlet' - jar_url | No | string | | | the URL that the JAR you're deploying resides - namespace | No | string | | | the cdap namespace this is deployed into - program_preferences | No | array of :ref:`programpref <d_610742fa78204adc388d0f7fbe30ad61>` | | | - programs | No | array of :ref:`programs <d_7bc8b39312a070aee5928f4e730192ae>` | | | - services | No | array of :ref:`service_endpoint <d_ad781f0dd64e16123fc1cbfefb4b9ded>` | | | - streamname | No | string | | | name of the CDAP stream to ingest data into this app. Should come from the developer and Tosca model. - -.. _i_13b2658afc25a955a6b4b48b9898c1a3: - -**App_config schema:** - - -the application config JSON - - - -.. _i_57297f6d8a6251aeb045f0872bf38d81: - -**App_preferences schema:** - - -the application preferences JSON - - - -.. code-block:: javascript - - { - "app_config": {}, - "app_preferences": {}, - "artifact_name": "somestring", - "cdap_application_type": "program-flowlet", - "jar_url": "somestring", - "namespace": "somestring", - "program_preferences": [ - { - "program_id": "somestring", - "program_pref": {}, - "program_type": "somestring" - }, - { - "program_id": "somestring", - "program_pref": {}, - "program_type": "somestring" - } - ], - "programs": [ - { - "program_id": "somestring", - "program_type": "somestring" - }, - { - "program_id": "somestring", - "program_type": "somestring" - } - ], - "services": [ - { - "endpoint_method": "somestring", - "service_endpoint": "somestring", - "service_name": "somestring" - }, - { - "endpoint_method": "somestring", - "service_endpoint": "somestring", - "service_name": "somestring" - } - ], - "streamname": "somestring" - } - -Responses -+++++++++ - -**200** -^^^^^^^ - -Successful response - - -Type: :ref:`Application <d_2b315c86978b3cd8c6edfbe745f1afa2>` - -**Example:** - -.. code-block:: javascript - - { - "appname": "somestring", - "connectionurl": "somestring", - "healthcheckurl": "somestring", - "metricsurl": "somestring", - "serviceendpoints": [ - { - "method": "somestring", - "url": "somestring" - }, - { - "method": "somestring", - "url": "somestring" - } - ], - "url": "somestring" - } - -**400** -^^^^^^^ - -put was performed but the appname was already registered with the broker, or Invalid PUT body - - - - - - -PUT ``/application*/{appname}`` -------------------------------- - - - -Description -+++++++++++ - -.. raw:: html - - (This is a hacky way of supporting "oneOf" because Swagger does not support oneOf https://github.com/OAI/OpenAPI-Specification/issues/333. This is the same endpoint as PUT /application/appname, except the PUT body is different.) - -Register a hydrator app for service and configuration discovery. This will light up a metrics and health endpoint for this app. `appname` is assumed to also be the key in consul. - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - appname | path | Yes | string | text | | Name of the application. - - -Request -+++++++ - - - -.. _d_d43078a75182938dccdbeac654cea43c: - -Body -^^^^ - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - cdap_application_type | Yes | string | | {'enum': ['hydrator-pipeline']} | denotes whether this is a program-flowlet style application or a hydrator pipeline. For hydrator, this value must be 'hydrator-pipeline' - dependencies | No | array of :ref:`hydratordep <d_c5aa8c778f283571705fbe7a21d0f5c7>` | | | represents a list of dependencies to be loaded for this pipeline. Not required. - namespace | Yes | string | | | the cdap namespace this is deployed into - pipeline_config_json_url | Yes | string | | | the URL of the config.json for this pipeline - streamname | Yes | string | | | name of the CDAP stream to ingest data into this app. Should come from the developer and Tosca model. - -.. code-block:: javascript - - { - "cdap_application_type": "hydrator-pipeline", - "dependencies": [ - { - "artifact_extends_header": "somestring", - "artifact_name": "somestring", - "artifact_url": "somestring", - "artifact_version_header": "somestring", - "ui_properties_url": "somestring" - }, - { - "artifact_extends_header": "somestring", - "artifact_name": "somestring", - "artifact_url": "somestring", - "artifact_version_header": "somestring", - "ui_properties_url": "somestring" - } - ], - "namespace": "somestring", - "pipeline_config_json_url": "somestring", - "streamname": "somestring" - } - -Responses -+++++++++ - -**200** -^^^^^^^ - -Successful response - - -Type: :ref:`Application <d_2b315c86978b3cd8c6edfbe745f1afa2>` - -**Example:** - -.. code-block:: javascript - - { - "appname": "somestring", - "connectionurl": "somestring", - "healthcheckurl": "somestring", - "metricsurl": "somestring", - "serviceendpoints": [ - { - "method": "somestring", - "url": "somestring" - }, - { - "method": "somestring", - "url": "somestring" - } - ], - "url": "somestring" - } - -**400** -^^^^^^^ - -put was performed but the appname was already registered with the broker, or Invalid PUT body - - - - - - -PUT ``/application/{appname}/reconfigure`` ------------------------------------------- - - - -Description -+++++++++++ - -.. raw:: html - - Reconfigures the application. - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - appname | path | Yes | string | text | | Name of the application. - - -Request -+++++++ - - - -.. _d_2a32645bc6d3020744d3d17500c34bc3: - -Body -^^^^ - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - config | Yes | :ref:`config <i_6a9d9951a40bf655fda365aa310e1ddc>` | | | the config JSON - reconfiguration_type | Yes | string | | {'enum': ['program-flowlet-app-config', 'program-flowlet-app-preferences', 'program-flowlet-smart']} | the type of reconfiguration - -.. _i_6a9d9951a40bf655fda365aa310e1ddc: - -**Config schema:** - - -the config JSON - - - -.. code-block:: javascript - - { - "config": {}, - "reconfiguration_type": "program-flowlet-app-config" - } - -Responses -+++++++++ - -**200** -^^^^^^^ - -Successful response - - -**400** -^^^^^^^ - -Bad request. Can happen with 1) {appname} is not registered with the broker, 2) the required PUT body is wrong, or 3) the smart interface was chosen and none of the config keys match anything in app_config or app_preferences - - - - - -Data Structures -~~~~~~~~~~~~~~~ - -.. _d_2b315c86978b3cd8c6edfbe745f1afa2: - -Application Model Structure ---------------------------- - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - appname | No | string | | | application name - connectionurl | No | string | | | input URL that you can POST data into (URL of the CDAP stream) - healthcheckurl | No | string | | | fully qualified url to perform healthcheck - metricsurl | No | string | | | fully qualified url to get metrics from - serviceendpoints | No | array of :ref:`service_method <d_e5edc5fd82a1190817cf350e70cb7e0e>` | | | a list of HTTP services exposed by this CDAP application - url | No | string | | | fully qualified url of the resource - -.. _d_5d4c5a47c1043833affa67eb27bf3d9d: - -MetricsObject Model Structure ------------------------------ - -key,value object where the key is 'appmetrics' and the value is an app dependent json and specified by the component developer - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - appmetrics | No | :ref:`appmetrics <i_6cb44a56118e2966acccfb86f18d0570>` | | | - -.. _i_6cb44a56118e2966acccfb86f18d0570: - -**Appmetrics schema:** - - - - -.. _d_2f6991f1775468c3ce48a2778455be93: - -appname Model Structure ------------------------ - -an application name - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - appname | No | string | | | an application name - -.. _d_a151b00939024528c17a91cf47a4eae3: - -appput Model Structure ----------------------- - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - app_config | No | :ref:`app_config <i_13b2658afc25a955a6b4b48b9898c1a3>` | | | the application config JSON - app_preferences | No | :ref:`app_preferences <i_57297f6d8a6251aeb045f0872bf38d81>` | | | the application preferences JSON - artifact_name | No | string | | | the name of the CDAP artifact to be added - cdap_application_type | No | string | | {'enum': ['program-flowlet']} | denotes whether this is a program-flowlet style application or a hydrator pipeline. For program-flowlet style apps, this value must be 'program-flowlet' - jar_url | No | string | | | the URL that the JAR you're deploying resides - namespace | No | string | | | the cdap namespace this is deployed into - program_preferences | No | array of :ref:`programpref <d_610742fa78204adc388d0f7fbe30ad61>` | | | - programs | No | array of :ref:`programs <d_7bc8b39312a070aee5928f4e730192ae>` | | | - services | No | array of :ref:`service_endpoint <d_ad781f0dd64e16123fc1cbfefb4b9ded>` | | | - streamname | No | string | | | name of the CDAP stream to ingest data into this app. Should come from the developer and Tosca model. - -.. _i_13b2658afc25a955a6b4b48b9898c1a3: - -**App_config schema:** - - -the application config JSON - - - -.. _i_57297f6d8a6251aeb045f0872bf38d81: - -**App_preferences schema:** - - -the application preferences JSON - - - -.. _d_d43078a75182938dccdbeac654cea43c: - -hydratorappput Model Structure ------------------------------- - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - cdap_application_type | Yes | string | | {'enum': ['hydrator-pipeline']} | denotes whether this is a program-flowlet style application or a hydrator pipeline. For hydrator, this value must be 'hydrator-pipeline' - dependencies | No | array of :ref:`hydratordep <d_c5aa8c778f283571705fbe7a21d0f5c7>` | | | represents a list of dependencies to be loaded for this pipeline. Not required. - namespace | Yes | string | | | the cdap namespace this is deployed into - pipeline_config_json_url | Yes | string | | | the URL of the config.json for this pipeline - streamname | Yes | string | | | name of the CDAP stream to ingest data into this app. Should come from the developer and Tosca model. - -.. _d_c5aa8c778f283571705fbe7a21d0f5c7: - -hydratordep Model Structure ---------------------------- - -represents a hydrator pipeline dependency. An equivelent to the following CURLs are formed with the below four params shown in CAPS 'curl -v -w'\n' -X POST http://cdapurl:11015/v3/namespaces/setelsewhere/artifacts/ARTIFACT_NAME -H 'Artifact-Extends:ARTIFACT_EXTENDS_HEADER' -H “Artifact-Version:ARTIFACT_VERSION_HEADER” --data-binary @(DOWNLOADED FROM ARTIFACT_URL)','curl -v -w'\n' -X PUT http://cdapurl:11015/v3/namespaces/setelsewhere/artifacts/ARTIFACT_NAME/versions/ARTIFACT_VERSION_HEADER/properties -d (DOWNLOADED FROM UI_PROPERTIES_URL)' - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - artifact_extends_header | Yes | string | | | the value of the header that gets passed in for artifact-extends, e.g., 'Artifact-Extends:system:cdap-data-pipeline[4.0.1,5.0.0)' - artifact_name | Yes | string | | | the name of the artifact - artifact_url | Yes | string | | | the URL of the artifact JAR - artifact_version_header | Yes | string | | | the value of the header that gets passed in for artifact-version, e.g., 'Artifact-Version:1.0.0-SNAPSHOT' - ui_properties_url | No | string | | | the URL of the properties.json if the custom artifact has UI properties. This is optional. - -.. _d_060ca512d6d771a97a7d0f50886f6b14: - -info Model Structure --------------------- - -some broker information - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - broker API version | No | string | | | the API version of this running broker - cdap GUI port | No | integer | | | The GUI port of the CDAP cluster this broker is managing. Mostly to help users of this API check their application in cdap. Note, will return UNKNOWN_CDAP_VERSION if it cannot be determined. - cdap cluster version | No | string | | | the version of the CDAP cluster this broker is managing. Note, will return UKNOWN_CDAP_VERSION if it cannot be determined. - managed cdap url | No | string | | | the url of the CDAP cluster API this broker is managing - number of applications registered | No | integer | | | - uptime (s) | No | integer | | | - -.. _d_c0830b0f8b495da06c2fef152ce05dba: - -multideleteput Model Structure ------------------------------- - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - appnames | No | array of :ref:`appname <d_2f6991f1775468c3ce48a2778455be93>` | | | - -.. _d_610742fa78204adc388d0f7fbe30ad61: - -programpref Model Structure ---------------------------- - -the list of programs in this CDAP app - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - program_id | No | string | | | the name of the program - program_pref | No | :ref:`program_pref <i_07225a64d44b62a92699f22d603b563c>` | | | the preference JSON to set for this program - program_type | No | string | | | must be one of flows, mapreduce, schedules, spark, workflows, workers, or services - -.. _i_07225a64d44b62a92699f22d603b563c: - -**Program_pref schema:** - - -the preference JSON to set for this program - - - -.. _d_7bc8b39312a070aee5928f4e730192ae: - -programs Model Structure ------------------------- - -the list of programs in this CDAP app - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - program_id | No | string | | | the name of the program - program_type | No | string | | | must be one of flows, mapreduce, schedules, spark, workflows, workers, or services - -.. _d_2a32645bc6d3020744d3d17500c34bc3: - -reconfigput Model Structure ---------------------------- - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - config | Yes | :ref:`config <i_6a9d9951a40bf655fda365aa310e1ddc>` | | | the config JSON - reconfiguration_type | Yes | string | | {'enum': ['program-flowlet-app-config', 'program-flowlet-app-preferences', 'program-flowlet-smart']} | the type of reconfiguration - -.. _i_6a9d9951a40bf655fda365aa310e1ddc: - -**Config schema:** - - -the config JSON - - - -.. _d_5a28f16eed72be7d9a8279c0e1f05386: - -returncode Model Structure --------------------------- - -an httpreturncode - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - returncode | No | integer | | | an httpreturncode - -.. _d_ad781f0dd64e16123fc1cbfefb4b9ded: - -service_endpoint Model Structure --------------------------------- - -descirbes a service endpoint, including the service name, the method name, and the method type (GET, PUT, etc, most of the time will be GET) - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - endpoint_method | No | string | | | GET, POST, PUT, etc - service_endpoint | No | string | | | the name of the endpoint on the service - service_name | No | string | | | the name of the service - -.. _d_e5edc5fd82a1190817cf350e70cb7e0e: - -service_method Model Structure ------------------------------- - -a URL and HTTP method exposed via a CDAP service - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - method | No | string | | | HTTP method you can perform on the URL, e.g., GET, PUT, etc - url | No | string | | | the fully qualified URL in CDAP for this service - diff --git a/docs/sections/apis/cdapbroker.yaml b/docs/sections/apis/cdapbroker.yaml deleted file mode 100644 index f6325b7f..00000000 --- a/docs/sections/apis/cdapbroker.yaml +++ /dev/null @@ -1,435 +0,0 @@ -# ================================================================================ -# Copyright (c) 2017-2018 AT&T Intellectual Property. All rights reserved. -# ================================================================================ -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# ============LICENSE_END========================================================= -# -# ECOMP is a trademark and service mark of AT&T Intellectual Property. -# Example YAML to get you started quickly. -# Be aware that YAML has indentation based scoping. -# Code completion support is available so start typing for available options. -swagger: '2.0' - -# This is your document metadata -info: - version: "4.0.10" - title: CDAP Broker API - -paths: - /: - get: - description: shows some information about this service - responses: - 200: - description: successful response - schema: - $ref: '#/definitions/info' - - /application: - get: - description: get all applications registered with this broker - responses: - 200: - description: successful response - schema: - type: array - items: - $ref: '#/definitions/appname' - - /application/delete: - post: - description: endpoint to delete multiple applications at once. Returns an array of status codes, where statuscode[i] = response returned from DELETE(application/i) - parameters: - - name: postbody - in: body - description: required post body - required: true - schema: - $ref: '#/definitions/multideleteput' - responses: - 200: - description: successful response - schema: - type: array - items: - $ref: '#/definitions/returncode' - - /application/{appname}: - parameters: - - name: appname - in: path - description: Name of the application. - required: true - type: string - format: text - - get: - description: Returns the representation of the application resource, including the links for healthcheck and metrics. - responses: - 200: - description: Successful response - schema: - $ref: '#/definitions/Application' - 404: - description: no app with name 'appname' registered with this broker. - - put: - description: Register an app for service and configuration discovery. This will light up a metrics and health endpoint for this app. `appname` is assumed to also be the key in consul. - consumes: - - application/json - produces: - - application/json - parameters: - - name: putbody - in: body - description: required put body - required: true - schema: - $ref: '#/definitions/appput' - - responses: - 200: - description: Successful response - schema: - $ref: '#/definitions/Application' - 400: - description: put was performed but the appname was already registered with the broker, or Invalid PUT body - - - delete: - description: Remove an app for service and configuration discovery. This will remove the metrics and health endpoints for this app. - responses: - 200: - description: Successful response - 404: - description: no app with name 'appname' registered with this broker. - - /application*/{appname}: - parameters: - - name: appname - in: path - description: Name of the application. - required: true - type: string - format: text - - put: - description: (This is a hacky way of supporting "oneOf" because Swagger does not support oneOf https://github.com/OAI/OpenAPI-Specification/issues/333. This is the same endpoint as PUT /application/appname, except the PUT body is different.) - - - Register a hydrator app for service and configuration discovery. This will light up a metrics and health endpoint for this app. `appname` is assumed to also be the key in consul. - consumes: - - application/json - produces: - - application/json - parameters: - - name: putbody - in: body - description: required put body - required: true - schema: - $ref: '#/definitions/hydratorappput' - - responses: - 200: - description: Successful response - schema: - $ref: '#/definitions/Application' - 400: - description: put was performed but the appname was already registered with the broker, or Invalid PUT body - - - /application/{appname}/metrics: - get: - # This is array of GET operation parameters: - description: Get live (real-time) app specific metrics for the running app appname. Metrics are customized per each app by the component developer - parameters: - # An example parameter that is in query and is required - - name: appname - in: path - description: Name of the application to get metrics for. - required: true - type: string - format: test - - # Expected responses for this operation: - responses: - 200: - description: Successful response - schema: - $ref: '#/definitions/MetricsObject' - 404: - description: no app with name 'appname' registered with this broker. - - /application/{appname}/healthcheck: - get: - # This is array of GET operation parameters: - description: Perform a healthcheck on the running app appname. - parameters: - # An example parameter that is in query and is required - - name: appname - in: path - description: Name of the application to get the healthcheck for. - required: true - type: string - format: test - - # Expected responses for this operation: - responses: - # Response code - 200: - description: Successful response, healthcheck pass - 404: - description: no app with name 'appname' registered with this broker, or the healthcheck has failed (though I would like to disambiguiate from the first case, CDAP returns a 404 for this). - - /application/{appname}/reconfigure: - parameters: - - name: appname - in: path - description: Name of the application. - required: true - type: string - format: text - put: - description: Reconfigures the application. - parameters: - - name: putbody - in: body - description: required put body - required: true - schema: - $ref: '#/definitions/reconfigput' - responses: - 200: - description: Successful response - 400: - description: Bad request. Can happen with 1) {appname} is not registered with the broker, 2) the required PUT body is wrong, or 3) the smart interface was chosen and none of the config keys match anything in app_config or app_preferences - -definitions: - MetricsObject: - type: object - description: key,value object where the key is 'appmetrics' and the value is an app dependent json and specified by the component developer - properties: - appmetrics: - type: object - - Application: - type: object - properties: - appname: - description: application name - type: string - healthcheckurl: - description: fully qualified url to perform healthcheck - type: string - metricsurl: - description: fully qualified url to get metrics from - type: string - url: - description: fully qualified url of the resource - type: string - connectionurl: - description: input URL that you can POST data into (URL of the CDAP stream) - type: string - serviceendpoints: - description: a list of HTTP services exposed by this CDAP application - type: array - items: - $ref: '#/definitions/service_method' - - reconfigput: - type: object - properties: - reconfiguration_type: - description: the type of reconfiguration - type: string - enum: ["program-flowlet-app-config", "program-flowlet-app-preferences", "program-flowlet-smart"] - config: - description: the config JSON - type: object - required: ["reconfiguration_type", "config"] - - multideleteput: - type: object - properties: - appnames: - type: array - items: - $ref: '#/definitions/appname' - - appname: - description: an application name - type: string - - hydratorappput: - type: object - properties: - cdap_application_type: - description: denotes whether this is a program-flowlet style application or a hydrator pipeline. For hydrator, this value must be "hydrator-pipeline" - type: string - enum: ["hydrator-pipeline"] - namespace: - description: the cdap namespace this is deployed into - type: string - pipeline_config_json_url: - description: the URL of the config.json for this pipeline - type: string - streamname: - description: name of the CDAP stream to ingest data into this app. Should come from the developer and Tosca model. - type: string - dependencies: - description: represents a list of dependencies to be loaded for this pipeline. Not required. - type: array - items: - $ref: '#/definitions/hydratordep' - required: ["cdap_application_type", "namespace", "pipeline_config_json_url", "streamname"] - - appput: - type: object - properties: - cdap_application_type: - description: denotes whether this is a program-flowlet style application or a hydrator pipeline. For program-flowlet style apps, this value must be "program-flowlet" - type: string - enum: ["program-flowlet"] - streamname: - description: name of the CDAP stream to ingest data into this app. Should come from the developer and Tosca model. - type: string - namespace: - description: the cdap namespace this is deployed into - type: string - jar_url: - description: the URL that the JAR you're deploying resides - type: string - artifact_name: - description: the name of the CDAP artifact to be added - type: string - artifact_ver: - description: the version of the artifact. Must be in X.Y.Z form - app_config: - description: the application config JSON - type: object - app_preferences: - description: the application preferences JSON - type: object - programs: - type: array - items: - $ref: '#/definitions/programs' - program_preferences: - type: array - items: - $ref: '#/definitions/programpref' - services: - type: array - items: - $ref: '#/definitions/service_endpoint' - - service_endpoint: - description: descirbes a service endpoint, including the service name, the method name, and the method type (GET, PUT, etc, most of the time will be GET) - type: object - properties: - service_name: - type: string - description: the name of the service - service_endpoint: - type: string - description: the name of the endpoint on the service - endpoint_method: - type: string - description: GET, POST, PUT, etc - - service_method: - description: a URL and HTTP method exposed via a CDAP service - type: object - properties: - url: - type: string - description: the fully qualified URL in CDAP for this service - method: - type: string - description: HTTP method you can perform on the URL, e.g., GET, PUT, etc - - programs: - description: the list of programs in this CDAP app - type: object - properties: - program_type: - description: must be one of flows, mapreduce, schedules, spark, workflows, workers, or services - type: string - program_id: - description: the name of the program - type: string - - returncode: - description: an httpreturncode - type: integer - - hydratordep: - description: represents a hydrator pipeline dependency. An equivelent to the following CURLs are formed with the below four params shown in CAPS "curl -v -w"\n" -X POST http://cdapurl:11015/v3/namespaces/setelsewhere/artifacts/ARTIFACT_NAME -H "Artifact-Extends:ARTIFACT_EXTENDS_HEADER" -H “Artifact-Version:ARTIFACT_VERSION_HEADER” --data-binary @(DOWNLOADED FROM ARTIFACT_URL)","curl -v -w"\n" -X PUT http://cdapurl:11015/v3/namespaces/setelsewhere/artifacts/ARTIFACT_NAME/versions/ARTIFACT_VERSION_HEADER/properties -d (DOWNLOADED FROM UI_PROPERTIES_URL)" - properties: - artifact_extends_header: - description: the value of the header that gets passed in for artifact-extends, e.g., "Artifact-Extends:system:cdap-data-pipeline[4.0.1,5.0.0)" - type: string - artifact_name: - description: the name of the artifact - type: string - artifact_version_header : - description: the value of the header that gets passed in for artifact-version, e.g., "Artifact-Version:1.0.0-SNAPSHOT" - type: string - artifact_url: - description: the URL of the artifact JAR - type: string - ui_properties_url: - description: the URL of the properties.json if the custom artifact has UI properties. This is optional. - type: string - required: ["artifact_extends_header", "artifact_name", "artifact_version_header", "artifact_url"] - - programpref: - description: the list of programs in this CDAP app - type: object - properties: - program_type: - description: must be one of flows, mapreduce, schedules, spark, workflows, workers, or services - type: string - program_id: - description: the name of the program - type: string - program_pref: - description: the preference JSON to set for this program - type: object - - info: - description: some broker information - type: object - properties: - managed cdap url: - description: the url of the CDAP cluster API this broker is managing - type: string - number of applications registered: - type: integer - uptime (s): - type: integer - cdap GUI port: - type: integer - description: The GUI port of the CDAP cluster this broker is managing. Mostly to help users of this API check their application in cdap. Note, will return UNKNOWN_CDAP_VERSION if it cannot be determined. - cdap cluster version: - type: string - description: the version of the CDAP cluster this broker is managing. Note, will return UKNOWN_CDAP_VERSION if it cannot be determined. - broker API version: - type: string - description: the API version of this running broker - - - - - diff --git a/docs/sections/apis/config_binding.rst b/docs/sections/apis/config_binding.rst deleted file mode 100644 index 51074455..00000000 --- a/docs/sections/apis/config_binding.rst +++ /dev/null @@ -1,113 +0,0 @@ -Config Binding Service 1.0.0 -============================ - -.. toctree:: - :maxdepth: 3 - - - - - -DEFAULT -~~~~~~~ - - - - -GET ``/service_component/{service_component_name}`` ---------------------------------------------------- - - - -Description -+++++++++++ - -.. raw:: html - - Binds the configuration for service_component_name and returns the bound configuration as a JSON - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - service_component_name | path | Yes | string | | | Service Component Name. service_component_name and service_component_name:rels must be keys in consul. - - -Request -+++++++ - - -Responses -+++++++++ - -**200** -^^^^^^^ - -OK; the bound config is returned as an object - - -.. _i_6cb44a56118e2966acccfb86f18d0570: - -**Response Schema:** - - - - -**Example:** - -.. code-block:: javascript - - {} - -**404** -^^^^^^^ - -there is no configuration in Consul for this component - - - - - - -GET ``/healthcheck`` --------------------- - - - -Description -+++++++++++ - -.. raw:: html - - This is the health check endpoint. If this returns a 200, the server is alive and consul can be reached. If not a 200, either dead, or no connection to consul - - -Request -+++++++ - - -Responses -+++++++++ - -**200** -^^^^^^^ - -Successful response - - -**503** -^^^^^^^ - -the config binding service cannot reach Consul - - - - - -Data Structures -~~~~~~~~~~~~~~~ - diff --git a/docs/sections/apis/config_binding.yaml b/docs/sections/apis/config_binding.yaml deleted file mode 100644 index 169f98c4..00000000 --- a/docs/sections/apis/config_binding.yaml +++ /dev/null @@ -1,50 +0,0 @@ -# ================================================================================ -# Copyright (c) 2017-2018 AT&T Intellectual Property. All rights reserved. -# ================================================================================ -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# ============LICENSE_END========================================================= -# -# ECOMP is a trademark and service mark of AT&T Intellectual Property. ---- -swagger: "2.0" -info: - version: "1.0.0" - title: "Config Binding Service" -paths: - /service_component/{service_component_name}: - parameters: - - name: "service_component_name" - in: "path" - description: "Service Component Name. service_component_name and service_component_name:rels must be keys 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 - /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 new file mode 100644 index 00000000..0515d301 --- /dev/null +++ b/docs/sections/apis/configbinding.rst @@ -0,0 +1,238 @@ +Config Binding Service 2.1.0 +============================ + +.. toctree:: + :maxdepth: 3 + + + + + +DEFAULT +~~~~~~~ + + + + +GET ``/service_component_all/{service_component_name}`` +------------------------------------------------------- + + + +Description ++++++++++++ + +.. raw:: html + + Binds the configuration for service_component_name and returns the bound configuration, policies, and any other keys that are in Consul + +Parameters +++++++++++ + +.. csv-table:: + :delim: | + :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 15, 10, 10, 10, 20, 30 + + service_component_name | path | Yes | string | | | Service Component Name. service_component_name must be a key in consul. + + +Request ++++++++ + + +Responses ++++++++++ + +**200** +^^^^^^^ + +OK; returns {config : ..., policies : ....., k : ...} for all other k in Consul + + +.. _i_4d863967ef9a9d9efdadd1b250c76bd6: + +**Response Schema:** + + + + +**Example:** + +.. code-block:: javascript + + {} + +**404** +^^^^^^^ + +there is no configuration in Consul for this component + + + + + + +GET ``/service_component/{service_component_name}`` +--------------------------------------------------- + + + +Description ++++++++++++ + +.. raw:: html + + Binds the configuration for service_component_name and returns the bound configuration as a JSON + +Parameters +++++++++++ + +.. csv-table:: + :delim: | + :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 15, 10, 10, 10, 20, 30 + + service_component_name | path | Yes | string | | | Service Component Name. service_component_name must be a key in consul. + + +Request ++++++++ + + +Responses ++++++++++ + +**200** +^^^^^^^ + +OK; the bound config is returned as an object + + +.. _i_4d863967ef9a9d9efdadd1b250c76bd6: + +**Response Schema:** + + + + +**Example:** + +.. code-block:: javascript + + {} + +**404** +^^^^^^^ + +there is no configuration in Consul for this component + + + + + + +GET ``/{key}/{service_component_name}`` +--------------------------------------- + + + +Description ++++++++++++ + +.. raw:: html + + this is an endpoint that fetches a generic service_component_name:key out of Consul. The idea is that we don't want to tie components to Consul directly in case we swap out the backend some day, so the CBS abstracts Consul from clients. The structuring and weird collision of this new API with the above is unfortunate but due to legacy concerns. + +Parameters +++++++++++ + +.. csv-table:: + :delim: | + :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 15, 10, 10, 10, 20, 30 + + key | path | Yes | string | | | this endpoint tries to pull service_component_name:key; key is the key after the colon + service_component_name | path | Yes | string | | | Service Component Name. + + +Request ++++++++ + + +Responses ++++++++++ + +**200** +^^^^^^^ + +OK; returns service_component_name:key + + +.. _i_4d863967ef9a9d9efdadd1b250c76bd6: + +**Response Schema:** + + + + +**Example:** + +.. code-block:: javascript + + {} + +**400** +^^^^^^^ + +bad request. Currently this is only returned on :policies, which is a complex object, and should be gotten through service_component_all + + +**404** +^^^^^^^ + +key does not exist + + + + + + +GET ``/healthcheck`` +-------------------- + + + +Description ++++++++++++ + +.. raw:: html + + This is the health check endpoint. If this returns a 200, the server is alive and consul can be reached. If not a 200, either dead, or no connection to consul + + +Request ++++++++ + + +Responses ++++++++++ + +**200** +^^^^^^^ + +Successful response + + +**503** +^^^^^^^ + +the config binding service cannot reach Consul + + + + + +Data Structures +~~~~~~~~~~~~~~~ + diff --git a/docs/sections/apis/configbinding.yaml b/docs/sections/apis/configbinding.yaml new file mode 100644 index 00000000..cfe09440 --- /dev/null +++ b/docs/sections/apis/configbinding.yaml @@ -0,0 +1,100 @@ +# ============LICENSE_START======================================================= +# Copyright (c) 2017-2018 AT&T Intellectual Property. All rights reserved. +# ================================================================================ +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# ============LICENSE_END========================================================= +# +# ECOMP is a trademark and service mark of AT&T Intellectual Property. + + +--- +swagger: "2.0" +info: + version: "2.1.0" + title: "Config Binding Service" +paths: + /service_component/{service_component_name}: + parameters: + - name: "service_component_name" + in: "path" + description: "Service Component Name. service_component_name must be a key in consul." + required: true + type: "string" + get: + description: "Binds the configuration for service_component_name and returns the bound configuration as a JSON" + operationId: "config_binding_service.controller.bind_config_for_scn" + responses: + 200: + description: OK; the bound config is returned as an object + schema: + type: object + 404: + description: there is no configuration in Consul for this component + + /service_component_all/{service_component_name}: + parameters: + - name: "service_component_name" + in: "path" + description: "Service Component Name. service_component_name must be a key in consul." + required: true + type: "string" + get: + description: "Binds the configuration for service_component_name and returns the bound configuration, policies, and any other keys that are in Consul" + operationId: "config_binding_service.controller.bind_all" + responses: + 200: + description: "OK; returns {config : ..., policies : ....., k : ...} for all other k in Consul" + schema: + type: object + 404: + description: there is no configuration in Consul for this component + + /{key}/{service_component_name}: + parameters: + - name: "key" + in: "path" + description: "this endpoint tries to pull service_component_name:key; key is the key after the colon" + required: true + type: "string" + - name: "service_component_name" + in: "path" + description: "Service Component Name." + required: true + type: "string" + get: + description: "this is an endpoint that fetches a generic service_component_name:key out of Consul. The idea is that we don't want to tie components to Consul directly in case we swap out the backend some day, so the CBS abstracts Consul from clients. The structuring and weird collision of this new API with the above is unfortunate but due to legacy concerns." + operationId: "config_binding_service.controller.get_key" + responses: + 200: + description: "OK; returns service_component_name:key" + schema: + type: object + 404: + description: "key does not exist" + schema: + type: string + 400: + description: "bad request. Currently this is only returned on :policies, which is a complex object, and should be gotten through service_component_all" + schema: + type: string + + /healthcheck: + get: + description: "This is the health check endpoint. If this returns a 200, the server is alive and consul can be reached. If not a 200, either dead, or no connection to consul" + operationId: "config_binding_service.controller.healthcheck" + parameters: [] + responses: + 200: + description: Successful response + 503: + description: the config binding service cannot reach Consul diff --git a/docs/sections/apis/deployment-handler-API.yaml b/docs/sections/apis/deployment-handler-API.yaml index 45505d21..887e3361 100644 --- a/docs/sections/apis/deployment-handler-API.yaml +++ b/docs/sections/apis/deployment-handler-API.yaml @@ -20,7 +20,7 @@ swagger: '2.0' info: - version: "4.1.0" + version: "4.2.0" title: "deployment-handler API" license: name: "Apache 2.0" @@ -486,11 +486,57 @@ definitions: 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 -> Policy object). In example: replace additionalProp1,2,3 with policy_id1,2,3 values" + description: | + dictionary of (policy_id -> DCAEPolicy object). + In example: replace additionalProp1,2,3 with policy_id1,2,3 values type: object + default: {} additionalProperties: $ref: "#/definitions/DCAEPolicy" + + removed_policies: + description: | + whether policy was removed from policy-engine. + dictionary of (policy_id -> true). + In example: replace additionalProp1,2,3 with policy_id1,2,3 values + type: object + default: {} + additionalProperties: + type: boolean + + errored_policies: + description: | + whether policy-engine returned an error on the policy. + dictionary of (policy_id -> true). + In example: replace additionalProp1,2,3 with policy_id1,2,3 values + type: object + default: {} + additionalProperties: + type: boolean + + errored_scopes: + description: > + on cartchup - list of policy scope_prefix values on wchich + the policy-engine experienced an error other than not-found data. + type: array + items: + type: string + + scope_prefixes: + description: > + on catchup - list of all scope_prefixes used by the policy-handler + to retrieve the policies from policy-engine. + type: array + items: + type: string diff --git a/docs/sections/apis/deploymenthandler.rst b/docs/sections/apis/deployment-handler.rst index 3b25f1ea..fc0b59dc 100644 --- a/docs/sections/apis/deploymenthandler.rst +++ b/docs/sections/apis/deployment-handler.rst @@ -1,4 +1,4 @@ -deployment-handler API 4.1.0 +deployment-handler API 4.2.0 ============================ .. toctree:: @@ -79,9 +79,9 @@ Type: :ref:`DCAEDeploymentResponse <d_6157bd3de5c8c7de78f2ab86397667e0>` { "links": { - "self": "somestring", + "self": "somestring", "status": "somestring" - }, + }, "requestId": "somestring" } @@ -99,7 +99,7 @@ Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` .. code-block:: javascript { - "message": "somestring", + "message": "somestring", "status": 1 } @@ -118,7 +118,7 @@ Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` .. code-block:: javascript { - "message": "somestring", + "message": "somestring", "status": 1 } @@ -137,7 +137,7 @@ Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` .. code-block:: javascript { - "message": "somestring", + "message": "somestring", "status": 1 } @@ -156,7 +156,7 @@ Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` .. code-block:: javascript { - "message": "somestring", + "message": "somestring", "status": 1 } @@ -213,11 +213,11 @@ Type: :ref:`DCAEDeploymentsListResponse <d_c51e57d9583f6119caf83dd017cf214c>` "deployments": [ { "href": "somestring" - }, + }, { "href": "somestring" } - ], + ], "requestId": "somestring" } @@ -236,7 +236,7 @@ Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` .. code-block:: javascript { - "message": "somestring", + "message": "somestring", "status": 1 } @@ -255,7 +255,7 @@ Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` .. code-block:: javascript { - "message": "somestring", + "message": "somestring", "status": 1 } @@ -274,7 +274,7 @@ Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` .. code-block:: javascript { - "message": "somestring", + "message": "somestring", "status": 1 } @@ -327,13 +327,13 @@ Type: :ref:`DCAEOperationStatusResponse <d_f0103f05736b04468a4f85fe90da2e16>` .. code-block:: javascript { - "error": "somestring", + "error": "somestring", "links": { - "self": "somestring", + "self": "somestring", "uninstall": "somestring" - }, - "operationType": "somestring", - "requestId": "somestring", + }, + "operationType": "somestring", + "requestId": "somestring", "status": "somestring" } @@ -350,7 +350,7 @@ Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` .. code-block:: javascript { - "message": "somestring", + "message": "somestring", "status": 1 } @@ -369,7 +369,7 @@ Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` .. code-block:: javascript { - "message": "somestring", + "message": "somestring", "status": 1 } @@ -388,7 +388,7 @@ Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` .. code-block:: javascript { - "message": "somestring", + "message": "somestring", "status": 1 } @@ -407,7 +407,7 @@ Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` .. code-block:: javascript { - "message": "somestring", + "message": "somestring", "status": 1 } @@ -457,13 +457,13 @@ Request for deploying a DCAE service. :header: "Name", "Required", "Type", "Format", "Properties", "Description" :widths: 20, 10, 15, 15, 30, 25 - inputs | No | :ref:`inputs <i_51dfb5d178ebacb6d6617c15cefffa86>` | | | Object containing inputs needed by the service blueprint to create an instance of the service. + inputs | No | :ref:`inputs <i_08ada55a389e24cd45beef83306fd08e>` | | | 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_51dfb5d178ebacb6d6617c15cefffa86: +.. _i_08ada55a389e24cd45beef83306fd08e: **Inputs schema:** @@ -477,7 +477,7 @@ Content of the object depends on the service being deployed. .. code-block:: javascript { - "inputs": {}, + "inputs": {}, "serviceTypeId": "somestring" } @@ -501,9 +501,9 @@ Type: :ref:`DCAEDeploymentResponse <d_6157bd3de5c8c7de78f2ab86397667e0>` { "links": { - "self": "somestring", + "self": "somestring", "status": "somestring" - }, + }, "requestId": "somestring" } @@ -521,7 +521,7 @@ Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` .. code-block:: javascript { - "message": "somestring", + "message": "somestring", "status": 1 } @@ -539,7 +539,7 @@ Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` .. code-block:: javascript { - "message": "somestring", + "message": "somestring", "status": 1 } @@ -558,7 +558,7 @@ Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` .. code-block:: javascript { - "message": "somestring", + "message": "somestring", "status": 1 } @@ -577,7 +577,7 @@ Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` .. code-block:: javascript { - "message": "somestring", + "message": "somestring", "status": 1 } @@ -596,7 +596,7 @@ Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` .. code-block:: javascript { - "message": "somestring", + "message": "somestring", "status": 1 } @@ -615,7 +615,7 @@ Type: :ref:`DCAEErrorResponse <d_74f3f4f847dfb6bd181fcae06ad880b4>` .. code-block:: javascript { - "message": "somestring", + "message": "somestring", "status": 1 } @@ -658,18 +658,51 @@ Responses Success -Type: :ref:`DispatcherInfo <d_01a325801d3165f9b15dbdaa15b94815>` +.. _i_2e7b26d45eaa7203222963d454a86a88: + +**Response Schema:** + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + apiVersion | No | string | | | version of API supported by this server + + links | No | :ref:`links <i_bcea41e897f5de95cd50fa873acb5f65>` | | | Links to API resources + + serverVersion | No | string | | | version of software running on this server + + +.. _i_bcea41e897f5de95cd50fa873acb5f65: + +**Links schema:** + + +Links to API resources + + +.. csv-table:: + :delim: | + :header: "Name", "Required", "Type", "Format", "Properties", "Description" + :widths: 20, 10, 15, 15, 30, 25 + + events | No | string | | | path for the events endpoint + + info | No | string | | | path for the server information endpoint + + **Example:** .. code-block:: javascript { - "apiVersion": "somestring", + "apiVersion": "somestring", "links": { - "events": "somestring", + "events": "somestring", "info": "somestring" - }, + }, "serverVersion": "somestring" } @@ -746,32 +779,84 @@ request to update policies on DCAE components. :header: "Name", "Required", "Type", "Format", "Properties", "Description" :widths: 20, 10, 15, 15, 30, 25 - latest_policies | Yes | :ref:`latest_policies <i_22fec92398d6fc407cf75f0b4c0f3614>` | | | dictionary of (policy_id -> Policy object). In example: replace additionalProp1,2,3 with policy_id1,2,3 values + catch_up | Yes | boolean | | | flag to indicate whether the request contains all the policies in PDP or not + errored_policies | No | :ref:`errored_policies <i_0e88fa72c5312eaae3990753181ce5fe>` | | | 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 + + errored_scopes | No | array of string | | | on cartchup - list of policy scope_prefix values on wchich the policy-engine experienced an error other than not-found data. + + latest_policies | Yes | :ref:`latest_policies <i_cbc40bad95bddbd536eeab0a92f483af>` | | | dictionary of (policy_id -> DCAEPolicy object). +In example: replace additionalProp1,2,3 with policy_id1,2,3 values + + removed_policies | Yes | :ref:`removed_policies <i_0ce52a29e44aa0cc7929fe7b555551bc>` | | | whether policy was removed from policy-engine. +dictionary of (policy_id -> true). +In example: replace additionalProp1,2,3 with policy_id1,2,3 values + + 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:** + -.. _i_22fec92398d6fc407cf75f0b4c0f3614: +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 -> Policy object). In example: replace additionalProp1,2,3 with policy_id1,2,3 values +dictionary of (policy_id -> DCAEPolicy object). +In example: replace additionalProp1,2,3 with policy_id1,2,3 values + Map of {"key":":ref:`DCAEPolicy <d_1e3e880a733b457b648bd8c99e6c859c>`"} +.. _i_0ce52a29e44aa0cc7929fe7b555551bc: + +**Removed_policies schema:** + + +whether policy was removed from policy-engine. +dictionary of (policy_id -> true). +In example: replace additionalProp1,2,3 with policy_id1,2,3 values + + +Map of {"key":"boolean"} + .. code-block:: javascript { + "catch_up": true, + "errored_policies": {}, + "errored_scopes": [ + "somestring", + "somestring" + ], "latest_policies": { "DCAEPolicy": { "policy_body": { - "config": {}, - "policyName": "somestring", + "config": {}, + "policyName": "somestring", "policyVersion": "somestring" - }, + }, "policy_id": "somestring" } - } + }, + "removed_policies": {}, + "scope_prefixes": [ + "somestring", + "somestring" + ] } Responses @@ -802,13 +887,13 @@ Request for deploying a DCAE service. :header: "Name", "Required", "Type", "Format", "Properties", "Description" :widths: 20, 10, 15, 15, 30, 25 - inputs | No | :ref:`inputs <i_51dfb5d178ebacb6d6617c15cefffa86>` | | | Object containing inputs needed by the service blueprint to create an instance of the service. + inputs | No | :ref:`inputs <i_08ada55a389e24cd45beef83306fd08e>` | | | 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_51dfb5d178ebacb6d6617c15cefffa86: +.. _i_08ada55a389e24cd45beef83306fd08e: **Inputs schema:** @@ -832,14 +917,15 @@ Response body for a PUT or DELETE to /dcae-deployments/{deploymentId} :header: "Name", "Required", "Type", "Format", "Properties", "Description" :widths: 20, 10, 15, 15, 30, 25 - links | No | :ref:`DCAEDeploymentResponse_links <d_e5951c399cff33430222aefe098fbbbb>` | | | + links | Yes | :ref:`links <i_4a894329f99280d2268e250444b59376>` | | | Links that the API client can access. + requestId | Yes | string | | | Unique identifier for the request -.. _d_e5951c399cff33430222aefe098fbbbb: +.. _i_4a894329f99280d2268e250444b59376: + +**Links schema:** -DCAEDeploymentResponse_links Model Structure --------------------------------------------- Links that the API client can access. @@ -866,14 +952,14 @@ Object providing a list of deployments :header: "Name", "Required", "Type", "Format", "Properties", "Description" :widths: 20, 10, 15, 15, 30, 25 - deployments | Yes | array of :ref:`DCAEDeploymentsListResponse_deployments <d_bf53389ec58f942852b6e44f2f35173c>` | | | + deployments | Yes | array of :ref:`deployments <i_98a80d81e7d1973d54db7713913d37e8>` | | | requestId | Yes | string | | | Unique identifier for the request -.. _d_bf53389ec58f942852b6e44f2f35173c: +.. _i_98a80d81e7d1973d54db7713913d37e8: + +**Deployments schema:** -DCAEDeploymentsListResponse_deployments Model Structure -------------------------------------------------------- .. csv-table:: :delim: | @@ -914,7 +1000,8 @@ Response body for a request for status of an installation or uninstallation oper error | No | string | | | If status is 'failed', this field will be present and contain additional information about the reason the operation failed. - links | No | :ref:`DCAEOperationStatusResponse_links <d_d0c8dc90669705fbfd08cca966a5fcae>` | | | + links | No | :ref:`links <i_2feace8c1d3584ec637edc0eb1b92699>` | | | If the operation succeeded, links that the client can follow to take further action. Note that a successful 'uninstall' operation removes the DCAE service instance completely, so there are no possible further actions, and no links. + operationType | Yes | string | | | Type of operation being reported on. ('install' or 'uninstall') requestId | Yes | string | | | A unique identifier assigned to the request. Useful for tracing a request through logs. @@ -923,10 +1010,10 @@ Response body for a request for status of an installation or uninstallation oper 'succeeded', and 'failed' -.. _d_d0c8dc90669705fbfd08cca966a5fcae: +.. _i_2feace8c1d3584ec637edc0eb1b92699: + +**Links schema:** -DCAEOperationStatusResponse_links Model Structure -------------------------------------------------- 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. @@ -967,11 +1054,11 @@ policy_body - the whole object received from policy-engine :header: "Name", "Required", "Type", "Format", "Properties", "Description" :widths: 20, 10, 15, 15, 30, 25 - config | Yes | :ref:`config <i_4926bbee050a2d1f47c3281f6c9095cf>` | | | the policy-config - the config data provided by policy owner + config | Yes | :ref:`config <i_ba9593ef6832fb8401f266e173acaa5c>` | | | the policy-config - the config data provided by policy owner policyName | Yes | string | | | unique policy name that contains the version and extension policyVersion | Yes | string | | | stringified int that is autoincremented by policy-engine -.. _i_4926bbee050a2d1f47c3281f6c9095cf: +.. _i_ba9593ef6832fb8401f266e173acaa5c: **Config schema:** @@ -992,50 +1079,57 @@ request to update policies on DCAE components. :header: "Name", "Required", "Type", "Format", "Properties", "Description" :widths: 20, 10, 15, 15, 30, 25 - latest_policies | Yes | :ref:`latest_policies <i_22fec92398d6fc407cf75f0b4c0f3614>` | | | dictionary of (policy_id -> Policy object). In example: replace additionalProp1,2,3 with policy_id1,2,3 values + catch_up | Yes | boolean | | | flag to indicate whether the request contains all the policies in PDP or not + errored_policies | No | :ref:`errored_policies <i_0e88fa72c5312eaae3990753181ce5fe>` | | | 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 -.. _i_22fec92398d6fc407cf75f0b4c0f3614: + errored_scopes | No | array of string | | | on cartchup - list of policy scope_prefix values on wchich the policy-engine experienced an error other than not-found data. -**Latest_policies schema:** + latest_policies | Yes | :ref:`latest_policies <i_cbc40bad95bddbd536eeab0a92f483af>` | | | dictionary of (policy_id -> DCAEPolicy object). +In example: replace additionalProp1,2,3 with policy_id1,2,3 values + removed_policies | Yes | :ref:`removed_policies <i_0ce52a29e44aa0cc7929fe7b555551bc>` | | | whether policy was removed from policy-engine. +dictionary of (policy_id -> true). +In example: replace additionalProp1,2,3 with policy_id1,2,3 values -dictionary of (policy_id -> Policy object). In example: replace additionalProp1,2,3 with policy_id1,2,3 values + 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. -Map of {"key":":ref:`DCAEPolicy <d_1e3e880a733b457b648bd8c99e6c859c>`"} +.. _i_0e88fa72c5312eaae3990753181ce5fe: +**Errored_policies schema:** -.. _d_01a325801d3165f9b15dbdaa15b94815: -DispatcherInfo Model Structure ------------------------------- +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 -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - apiVersion | No | string | | | version of API supported by this server +Map of {"key":"boolean"} - links | No | :ref:`DispatcherInfo_links <d_0a18e12425d91480a8516b17efe05340>` | | | - serverVersion | No | string | | | version of software running on this server +.. _i_cbc40bad95bddbd536eeab0a92f483af: +**Latest_policies schema:** -.. _d_0a18e12425d91480a8516b17efe05340: -DispatcherInfo_links Model Structure ------------------------------------- +dictionary of (policy_id -> DCAEPolicy object). +In example: replace additionalProp1,2,3 with policy_id1,2,3 values -Links to API resources +Map of {"key":":ref:`DCAEPolicy <d_1e3e880a733b457b648bd8c99e6c859c>`"} -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - events | No | string | | | path for the events endpoint - info | No | string | | | path for the server information endpoint +.. _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"} diff --git a/docs/sections/apis/inventory_api.rst b/docs/sections/apis/inventory.rst index 1dd3a297..edddff4d 100644 --- a/docs/sections/apis/inventory_api.rst +++ b/docs/sections/apis/inventory.rst @@ -87,104 +87,104 @@ Type: :ref:`InlineResponse200 <d_b1ccd4187d31690b8e704c0aa01b2c59>` { "items": [ { - "asdcResourceId": "somestring", - "asdcServiceId": "somestring", - "asdcServiceURL": "somestring", - "blueprintTemplate": "somestring", - "created": "2015-01-01T15:00:00.000Z", - "deactivated": "2015-01-01T15:00:00.000Z", - "owner": "somestring", + "asdcResourceId": "somestring", + "asdcServiceId": "somestring", + "asdcServiceURL": "somestring", + "blueprintTemplate": "somestring", + "created": "2015-01-01T15:00:00.000Z", + "deactivated": "2015-01-01T15:00:00.000Z", + "owner": "somestring", "selfLink": { - "params": {}, - "rel": "somestring", + "params": {}, + "rel": "somestring", "rels": [ - "somestring", + "somestring", "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", "uriBuilder": {} - }, + }, "serviceIds": [ - "somestring", + "somestring", "somestring" - ], + ], "serviceLocations": [ - "somestring", + "somestring", "somestring" - ], - "typeId": "somestring", - "typeName": "somestring", - "typeVersion": 1, + ], + "typeId": "somestring", + "typeName": "somestring", + "typeVersion": 1, "vnfTypes": [ - "somestring", + "somestring", "somestring" ] - }, + }, { - "asdcResourceId": "somestring", - "asdcServiceId": "somestring", - "asdcServiceURL": "somestring", - "blueprintTemplate": "somestring", - "created": "2015-01-01T15:00:00.000Z", - "deactivated": "2015-01-01T15:00:00.000Z", - "owner": "somestring", + "asdcResourceId": "somestring", + "asdcServiceId": "somestring", + "asdcServiceURL": "somestring", + "blueprintTemplate": "somestring", + "created": "2015-01-01T15:00:00.000Z", + "deactivated": "2015-01-01T15:00:00.000Z", + "owner": "somestring", "selfLink": { - "params": {}, - "rel": "somestring", + "params": {}, + "rel": "somestring", "rels": [ - "somestring", + "somestring", "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", "uriBuilder": {} - }, + }, "serviceIds": [ - "somestring", + "somestring", "somestring" - ], + ], "serviceLocations": [ - "somestring", + "somestring", "somestring" - ], - "typeId": "somestring", - "typeName": "somestring", - "typeVersion": 1, + ], + "typeId": "somestring", + "typeName": "somestring", + "typeVersion": 1, "vnfTypes": [ - "somestring", + "somestring", "somestring" ] } - ], + ], "links": { "nextLink": { - "params": {}, - "rel": "somestring", + "params": {}, + "rel": "somestring", "rels": [ - "somestring", + "somestring", "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", "uriBuilder": {} - }, + }, "previousLink": { - "params": {}, - "rel": "somestring", + "params": {}, + "rel": "somestring", "rels": [ - "somestring", + "somestring", "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", "uriBuilder": {} } - }, + }, "totalCount": 1 } @@ -235,8 +235,8 @@ Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` .. code-block:: javascript { - "code": 1, - "message": "somestring", + "code": 1, + "message": "somestring", "type": "somestring" } @@ -253,8 +253,8 @@ Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` .. code-block:: javascript { - "code": 1, - "message": "somestring", + "code": 1, + "message": "somestring", "type": "somestring" } @@ -271,8 +271,8 @@ Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` .. code-block:: javascript { - "code": 1, - "message": "somestring", + "code": 1, + "message": "somestring", "type": "somestring" } @@ -323,38 +323,38 @@ Type: :ref:`DCAEServiceType <d_b0cb5f12dbde8c0c42487c089983687e>` .. code-block:: javascript { - "asdcResourceId": "somestring", - "asdcServiceId": "somestring", - "asdcServiceURL": "somestring", - "blueprintTemplate": "somestring", - "created": "2015-01-01T15:00:00.000Z", - "deactivated": "2015-01-01T15:00:00.000Z", - "owner": "somestring", + "asdcResourceId": "somestring", + "asdcServiceId": "somestring", + "asdcServiceURL": "somestring", + "blueprintTemplate": "somestring", + "created": "2015-01-01T15:00:00.000Z", + "deactivated": "2015-01-01T15:00:00.000Z", + "owner": "somestring", "selfLink": { - "params": {}, - "rel": "somestring", + "params": {}, + "rel": "somestring", "rels": [ - "somestring", + "somestring", "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", "uriBuilder": {} - }, + }, "serviceIds": [ - "somestring", + "somestring", "somestring" - ], + ], "serviceLocations": [ - "somestring", + "somestring", "somestring" - ], - "typeId": "somestring", - "typeName": "somestring", - "typeVersion": 1, + ], + "typeId": "somestring", + "typeName": "somestring", + "typeVersion": 1, "vnfTypes": [ - "somestring", + "somestring", "somestring" ] } @@ -372,38 +372,38 @@ Type: :ref:`DCAEServiceType <d_b0cb5f12dbde8c0c42487c089983687e>` .. code-block:: javascript { - "asdcResourceId": "somestring", - "asdcServiceId": "somestring", - "asdcServiceURL": "somestring", - "blueprintTemplate": "somestring", - "created": "2015-01-01T15:00:00.000Z", - "deactivated": "2015-01-01T15:00:00.000Z", - "owner": "somestring", + "asdcResourceId": "somestring", + "asdcServiceId": "somestring", + "asdcServiceURL": "somestring", + "blueprintTemplate": "somestring", + "created": "2015-01-01T15:00:00.000Z", + "deactivated": "2015-01-01T15:00:00.000Z", + "owner": "somestring", "selfLink": { - "params": {}, - "rel": "somestring", + "params": {}, + "rel": "somestring", "rels": [ - "somestring", + "somestring", "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", "uriBuilder": {} - }, + }, "serviceIds": [ - "somestring", + "somestring", "somestring" - ], + ], "serviceLocations": [ - "somestring", + "somestring", "somestring" - ], - "typeId": "somestring", - "typeName": "somestring", - "typeVersion": 1, + ], + "typeId": "somestring", + "typeName": "somestring", + "typeVersion": 1, "vnfTypes": [ - "somestring", + "somestring", "somestring" ] } @@ -454,23 +454,23 @@ Body .. code-block:: javascript { - "asdcResourceId": "somestring", - "asdcServiceId": "somestring", - "asdcServiceURL": "somestring", - "blueprintTemplate": "somestring", - "owner": "somestring", + "asdcResourceId": "somestring", + "asdcServiceId": "somestring", + "asdcServiceURL": "somestring", + "blueprintTemplate": "somestring", + "owner": "somestring", "serviceIds": [ - "somestring", + "somestring", "somestring" - ], + ], "serviceLocations": [ - "somestring", + "somestring", "somestring" - ], - "typeName": "somestring", - "typeVersion": 1, + ], + "typeName": "somestring", + "typeVersion": 1, "vnfTypes": [ - "somestring", + "somestring", "somestring" ] } @@ -491,38 +491,38 @@ Type: :ref:`DCAEServiceType <d_b0cb5f12dbde8c0c42487c089983687e>` .. code-block:: javascript { - "asdcResourceId": "somestring", - "asdcServiceId": "somestring", - "asdcServiceURL": "somestring", - "blueprintTemplate": "somestring", - "created": "2015-01-01T15:00:00.000Z", - "deactivated": "2015-01-01T15:00:00.000Z", - "owner": "somestring", + "asdcResourceId": "somestring", + "asdcServiceId": "somestring", + "asdcServiceURL": "somestring", + "blueprintTemplate": "somestring", + "created": "2015-01-01T15:00:00.000Z", + "deactivated": "2015-01-01T15:00:00.000Z", + "owner": "somestring", "selfLink": { - "params": {}, - "rel": "somestring", + "params": {}, + "rel": "somestring", "rels": [ - "somestring", + "somestring", "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", "uriBuilder": {} - }, + }, "serviceIds": [ - "somestring", + "somestring", "somestring" - ], + ], "serviceLocations": [ - "somestring", + "somestring", "somestring" - ], - "typeId": "somestring", - "typeName": "somestring", - "typeVersion": 1, + ], + "typeId": "somestring", + "typeName": "somestring", + "typeVersion": 1, "vnfTypes": [ - "somestring", + "somestring", "somestring" ] } @@ -540,8 +540,8 @@ Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` .. code-block:: javascript { - "code": 1, - "message": "somestring", + "code": 1, + "message": "somestring", "type": "somestring" } @@ -558,8 +558,8 @@ Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` .. code-block:: javascript { - "code": 1, - "message": "somestring", + "code": 1, + "message": "somestring", "type": "somestring" } @@ -621,212 +621,212 @@ Type: :ref:`InlineResponse2001 <d_31bb361a8900a0bed20df49b94f1e33b>` { "components": [ { - "componentId": "somestring", + "componentId": "somestring", "componentLink": { - "params": {}, - "rel": "somestring", + "params": {}, + "rel": "somestring", "rels": [ - "somestring", + "somestring", "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", "uriBuilder": {} - }, - "componentSource": "DCAEController", - "componentType": "somestring", - "created": "2015-01-01T15:00:00.000Z", - "location": "somestring", - "modified": "2015-01-01T15:00:00.000Z", - "shareable": 1, + }, + "componentSource": "DCAEController", + "componentType": "somestring", + "created": "2015-01-01T15:00:00.000Z", + "location": "somestring", + "modified": "2015-01-01T15:00:00.000Z", + "shareable": 1, "status": "somestring" - }, + }, { - "componentId": "somestring", + "componentId": "somestring", "componentLink": { - "params": {}, - "rel": "somestring", + "params": {}, + "rel": "somestring", "rels": [ - "somestring", + "somestring", "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", "uriBuilder": {} - }, - "componentSource": "DCAEController", - "componentType": "somestring", - "created": "2015-01-01T15:00:00.000Z", - "location": "somestring", - "modified": "2015-01-01T15:00:00.000Z", - "shareable": 1, + }, + "componentSource": "DCAEController", + "componentType": "somestring", + "created": "2015-01-01T15:00:00.000Z", + "location": "somestring", + "modified": "2015-01-01T15:00:00.000Z", + "shareable": 1, "status": "somestring" } - ], - "created": "2015-01-01T15:00:00.000Z", - "deploymentRef": "somestring", - "modified": "2015-01-01T15:00:00.000Z", + ], + "created": "2015-01-01T15:00:00.000Z", + "deploymentRef": "somestring", + "modified": "2015-01-01T15:00:00.000Z", "selfLink": { - "params": {}, - "rel": "somestring", + "params": {}, + "rel": "somestring", "rels": [ - "somestring", + "somestring", "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", "uriBuilder": {} - }, - "serviceId": "somestring", + }, + "serviceId": "somestring", "typeLink": { - "params": {}, - "rel": "somestring", + "params": {}, + "rel": "somestring", "rels": [ - "somestring", + "somestring", "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", "uriBuilder": {} - }, - "vnfId": "somestring", + }, + "vnfId": "somestring", "vnfLink": { - "params": {}, - "rel": "somestring", + "params": {}, + "rel": "somestring", "rels": [ - "somestring", + "somestring", "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", "uriBuilder": {} - }, - "vnfLocation": "somestring", + }, + "vnfLocation": "somestring", "vnfType": "somestring" - }, + }, { "components": [ { - "componentId": "somestring", + "componentId": "somestring", "componentLink": { - "params": {}, - "rel": "somestring", + "params": {}, + "rel": "somestring", "rels": [ - "somestring", + "somestring", "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", "uriBuilder": {} - }, - "componentSource": "DCAEController", - "componentType": "somestring", - "created": "2015-01-01T15:00:00.000Z", - "location": "somestring", - "modified": "2015-01-01T15:00:00.000Z", - "shareable": 1, + }, + "componentSource": "DCAEController", + "componentType": "somestring", + "created": "2015-01-01T15:00:00.000Z", + "location": "somestring", + "modified": "2015-01-01T15:00:00.000Z", + "shareable": 1, "status": "somestring" - }, + }, { - "componentId": "somestring", + "componentId": "somestring", "componentLink": { - "params": {}, - "rel": "somestring", + "params": {}, + "rel": "somestring", "rels": [ - "somestring", + "somestring", "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", "uriBuilder": {} - }, - "componentSource": "DCAEController", - "componentType": "somestring", - "created": "2015-01-01T15:00:00.000Z", - "location": "somestring", - "modified": "2015-01-01T15:00:00.000Z", - "shareable": 1, + }, + "componentSource": "DCAEController", + "componentType": "somestring", + "created": "2015-01-01T15:00:00.000Z", + "location": "somestring", + "modified": "2015-01-01T15:00:00.000Z", + "shareable": 1, "status": "somestring" } - ], - "created": "2015-01-01T15:00:00.000Z", - "deploymentRef": "somestring", - "modified": "2015-01-01T15:00:00.000Z", + ], + "created": "2015-01-01T15:00:00.000Z", + "deploymentRef": "somestring", + "modified": "2015-01-01T15:00:00.000Z", "selfLink": { - "params": {}, - "rel": "somestring", + "params": {}, + "rel": "somestring", "rels": [ - "somestring", + "somestring", "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", "uriBuilder": {} - }, - "serviceId": "somestring", + }, + "serviceId": "somestring", "typeLink": { - "params": {}, - "rel": "somestring", + "params": {}, + "rel": "somestring", "rels": [ - "somestring", + "somestring", "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", "uriBuilder": {} - }, - "vnfId": "somestring", + }, + "vnfId": "somestring", "vnfLink": { - "params": {}, - "rel": "somestring", + "params": {}, + "rel": "somestring", "rels": [ - "somestring", + "somestring", "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", "uriBuilder": {} - }, - "vnfLocation": "somestring", + }, + "vnfLocation": "somestring", "vnfType": "somestring" } - ], + ], "links": { "nextLink": { - "params": {}, - "rel": "somestring", + "params": {}, + "rel": "somestring", "rels": [ - "somestring", + "somestring", "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", "uriBuilder": {} - }, + }, "previousLink": { - "params": {}, - "rel": "somestring", + "params": {}, + "rel": "somestring", "rels": [ - "somestring", + "somestring", "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", "uriBuilder": {} } - }, + }, "totalCount": 1 } @@ -843,8 +843,8 @@ Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` .. code-block:: javascript { - "code": 1, - "message": "somestring", + "code": 1, + "message": "somestring", "type": "somestring" } @@ -861,8 +861,8 @@ Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` .. code-block:: javascript { - "code": 1, - "message": "somestring", + "code": 1, + "message": "somestring", "type": "somestring" } @@ -913,38 +913,38 @@ Type: :ref:`DCAEServiceGroupByResults <d_a6dc4f986873bc126fc916189ffa5e91>` .. code-block:: javascript { - "propertyName": "somestring", + "propertyName": "somestring", "propertyValues": [ { - "count": 1, + "count": 1, "dcaeServiceQueryLink": { - "params": {}, - "rel": "somestring", + "params": {}, + "rel": "somestring", "rels": [ - "somestring", + "somestring", "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", "uriBuilder": {} - }, + }, "propertyValue": "somestring" - }, + }, { - "count": 1, + "count": 1, "dcaeServiceQueryLink": { - "params": {}, - "rel": "somestring", + "params": {}, + "rel": "somestring", "rels": [ - "somestring", + "somestring", "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", "uriBuilder": {} - }, + }, "propertyValue": "somestring" } ] @@ -1003,8 +1003,8 @@ Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` .. code-block:: javascript { - "code": 1, - "message": "somestring", + "code": 1, + "message": "somestring", "type": "somestring" } @@ -1057,92 +1057,92 @@ Type: :ref:`DCAEService <d_ae85cd292c2b4046e1ea1bbb02c7ea63>` { "components": [ { - "componentId": "somestring", + "componentId": "somestring", "componentLink": { - "params": {}, - "rel": "somestring", + "params": {}, + "rel": "somestring", "rels": [ - "somestring", + "somestring", "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", "uriBuilder": {} - }, - "componentSource": "DCAEController", - "componentType": "somestring", - "created": "2015-01-01T15:00:00.000Z", - "location": "somestring", - "modified": "2015-01-01T15:00:00.000Z", - "shareable": 1, + }, + "componentSource": "DCAEController", + "componentType": "somestring", + "created": "2015-01-01T15:00:00.000Z", + "location": "somestring", + "modified": "2015-01-01T15:00:00.000Z", + "shareable": 1, "status": "somestring" - }, + }, { - "componentId": "somestring", + "componentId": "somestring", "componentLink": { - "params": {}, - "rel": "somestring", + "params": {}, + "rel": "somestring", "rels": [ - "somestring", + "somestring", "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", "uriBuilder": {} - }, - "componentSource": "DCAEController", - "componentType": "somestring", - "created": "2015-01-01T15:00:00.000Z", - "location": "somestring", - "modified": "2015-01-01T15:00:00.000Z", - "shareable": 1, + }, + "componentSource": "DCAEController", + "componentType": "somestring", + "created": "2015-01-01T15:00:00.000Z", + "location": "somestring", + "modified": "2015-01-01T15:00:00.000Z", + "shareable": 1, "status": "somestring" } - ], - "created": "2015-01-01T15:00:00.000Z", - "deploymentRef": "somestring", - "modified": "2015-01-01T15:00:00.000Z", + ], + "created": "2015-01-01T15:00:00.000Z", + "deploymentRef": "somestring", + "modified": "2015-01-01T15:00:00.000Z", "selfLink": { - "params": {}, - "rel": "somestring", + "params": {}, + "rel": "somestring", "rels": [ - "somestring", + "somestring", "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", "uriBuilder": {} - }, - "serviceId": "somestring", + }, + "serviceId": "somestring", "typeLink": { - "params": {}, - "rel": "somestring", + "params": {}, + "rel": "somestring", "rels": [ - "somestring", + "somestring", "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", "uriBuilder": {} - }, - "vnfId": "somestring", + }, + "vnfId": "somestring", "vnfLink": { - "params": {}, - "rel": "somestring", + "params": {}, + "rel": "somestring", "rels": [ - "somestring", + "somestring", "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", "uriBuilder": {} - }, - "vnfLocation": "somestring", + }, + "vnfLocation": "somestring", "vnfType": "somestring" } @@ -1159,8 +1159,8 @@ Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` .. code-block:: javascript { - "code": 1, - "message": "somestring", + "code": 1, + "message": "somestring", "type": "somestring" } @@ -1177,8 +1177,8 @@ Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` .. code-block:: javascript { - "code": 1, - "message": "somestring", + "code": 1, + "message": "somestring", "type": "somestring" } @@ -1195,8 +1195,8 @@ Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` .. code-block:: javascript { - "code": 1, - "message": "somestring", + "code": 1, + "message": "somestring", "type": "somestring" } @@ -1254,22 +1254,22 @@ Body { "components": [ { - "componentId": "somestring", - "componentSource": "DCAEController", - "componentType": "somestring", + "componentId": "somestring", + "componentSource": "DCAEController", + "componentType": "somestring", "shareable": 1 - }, + }, { - "componentId": "somestring", - "componentSource": "DCAEController", - "componentType": "somestring", + "componentId": "somestring", + "componentSource": "DCAEController", + "componentType": "somestring", "shareable": 1 } - ], - "deploymentRef": "somestring", - "typeId": "somestring", - "vnfId": "somestring", - "vnfLocation": "somestring", + ], + "deploymentRef": "somestring", + "typeId": "somestring", + "vnfId": "somestring", + "vnfLocation": "somestring", "vnfType": "somestring" } @@ -1291,92 +1291,92 @@ Type: :ref:`DCAEService <d_ae85cd292c2b4046e1ea1bbb02c7ea63>` { "components": [ { - "componentId": "somestring", + "componentId": "somestring", "componentLink": { - "params": {}, - "rel": "somestring", + "params": {}, + "rel": "somestring", "rels": [ - "somestring", + "somestring", "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", "uriBuilder": {} - }, - "componentSource": "DCAEController", - "componentType": "somestring", - "created": "2015-01-01T15:00:00.000Z", - "location": "somestring", - "modified": "2015-01-01T15:00:00.000Z", - "shareable": 1, + }, + "componentSource": "DCAEController", + "componentType": "somestring", + "created": "2015-01-01T15:00:00.000Z", + "location": "somestring", + "modified": "2015-01-01T15:00:00.000Z", + "shareable": 1, "status": "somestring" - }, + }, { - "componentId": "somestring", + "componentId": "somestring", "componentLink": { - "params": {}, - "rel": "somestring", + "params": {}, + "rel": "somestring", "rels": [ - "somestring", + "somestring", "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", "uriBuilder": {} - }, - "componentSource": "DCAEController", - "componentType": "somestring", - "created": "2015-01-01T15:00:00.000Z", - "location": "somestring", - "modified": "2015-01-01T15:00:00.000Z", - "shareable": 1, + }, + "componentSource": "DCAEController", + "componentType": "somestring", + "created": "2015-01-01T15:00:00.000Z", + "location": "somestring", + "modified": "2015-01-01T15:00:00.000Z", + "shareable": 1, "status": "somestring" } - ], - "created": "2015-01-01T15:00:00.000Z", - "deploymentRef": "somestring", - "modified": "2015-01-01T15:00:00.000Z", + ], + "created": "2015-01-01T15:00:00.000Z", + "deploymentRef": "somestring", + "modified": "2015-01-01T15:00:00.000Z", "selfLink": { - "params": {}, - "rel": "somestring", + "params": {}, + "rel": "somestring", "rels": [ - "somestring", + "somestring", "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", "uriBuilder": {} - }, - "serviceId": "somestring", + }, + "serviceId": "somestring", "typeLink": { - "params": {}, - "rel": "somestring", + "params": {}, + "rel": "somestring", "rels": [ - "somestring", + "somestring", "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", "uriBuilder": {} - }, - "vnfId": "somestring", + }, + "vnfId": "somestring", "vnfLink": { - "params": {}, - "rel": "somestring", + "params": {}, + "rel": "somestring", "rels": [ - "somestring", + "somestring", "somestring" - ], - "title": "somestring", - "type": "somestring", - "uri": "somestring", + ], + "title": "somestring", + "type": "somestring", + "uri": "somestring", "uriBuilder": {} - }, - "vnfLocation": "somestring", + }, + "vnfLocation": "somestring", "vnfType": "somestring" } @@ -1393,8 +1393,8 @@ Type: :ref:`ApiResponseMessage <d_8a94f348f7df00259702f8d9b7d2ea84>` .. code-block:: javascript { - "code": 1, - "message": "somestring", + "code": 1, + "message": "somestring", "type": "somestring" } @@ -1618,7 +1618,7 @@ Link Model Structure :header: "Name", "Required", "Type", "Format", "Properties", "Description" :widths: 20, 10, 15, 15, 30, 25 - params | No | :ref:`params <i_adf17ca32891d8ece6efd40541d227f2>` | | | + params | No | :ref:`params <i_f76783e4d75c137d1fc68696fcfdb72c>` | | | rel | No | string | | | rels | No | array of string | | | title | No | string | | | @@ -1626,7 +1626,7 @@ Link Model Structure uri | No | string | uri | | uriBuilder | No | :ref:`UriBuilder <d_a7b6b5c694147ea9dcfb5a5a6cbef017>` | | | -.. _i_adf17ca32891d8ece6efd40541d227f2: +.. _i_f76783e4d75c137d1fc68696fcfdb72c: **Params schema:** diff --git a/docs/sections/apis/inventory_api.yaml b/docs/sections/apis/swagger_inventory.yaml index 068f2216..068f2216 100644 --- a/docs/sections/apis/inventory_api.yaml +++ b/docs/sections/apis/swagger_inventory.yaml diff --git a/docs/sections/apis/ves.yaml b/docs/sections/apis/swagger_vescollector.yaml index 6acae21e..6acae21e 100644 --- a/docs/sections/apis/ves.yaml +++ b/docs/sections/apis/swagger_vescollector.yaml diff --git a/docs/sections/apis/ves.rst b/docs/sections/apis/ves.rst index 4fb338f8..d03cd513 100644 --- a/docs/sections/apis/ves.rst +++ b/docs/sections/apis/ves.rst @@ -99,7 +99,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 @@ -1063,7 +1063,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 @@ -1997,7 +1997,7 @@ Security :widths: 15, 45 :ref:`basicAuth <securities_basicAuth>`, "" - + Data Structures ~~~~~~~~~~~~~~~ @@ -2011,9 +2011,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_f598222d7a83ca9c3538556b263682d1: @@ -2025,7 +2025,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: @@ -2039,8 +2039,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: @@ -2054,10 +2054,10 @@ command from an event collector toward an event source :header: "Name", "Required", "Type", "Format", "Properties", "Description" :widths: 20, 10, 15, 15, 30, 25 - commandType | Yes | string | | {'enum': ['heartbeatIntervalChange', 'measurementIntervalChange', 'provideThrottlingState', 'throttlingSpecification']} | - eventDomainThrottleSpecification | No | :ref:`eventDomainThrottleSpecification <d_4089a4a9ee684770c6f37a588a577589>` | | | - heartbeatInterval | No | integer | | | - measurementInterval | No | integer | | | + commandType | Yes | string | | {'enum': ['heartbeatIntervalChange', 'measurementIntervalChange', 'provideThrottlingState', 'throttlingSpecification']} | + eventDomainThrottleSpecification | No | :ref:`eventDomainThrottleSpecification <d_4089a4a9ee684770c6f37a588a577589>` | | | + heartbeatInterval | No | integer | | | + measurementInterval | No | integer | | | .. _d_2dc9a27be1410f60241c5f63c636bb7e: @@ -2075,7 +2075,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 @@ -2100,10 +2100,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: @@ -2196,23 +2196,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 @@ -2228,17 +2228,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: @@ -2290,8 +2290,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: @@ -2305,8 +2305,8 @@ 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: @@ -2320,13 +2320,13 @@ disk usage of an identified virtual machine in gigabytes and/or gigabytes per se :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: @@ -2447,11 +2447,11 @@ meta-information about an instance of a jsonObject along with the actual object :header: "Name", "Required", "Type", "Format", "Properties", "Description" :widths: 20, 10, 15, 15, 30, 25 - objectInstance | Yes | :ref:`objectInstance <i_c0493c6178d712e91e73c63587e27067>` | | | an instance conforming to the jsonObject schema + objectInstance | Yes | :ref:`objectInstance <i_4cf8290bf745cd386f0a55ec865aafd5>` | | | an instance conforming to the jsonObject schema objectInstanceEpochMicrosec | No | number | | | the unix time aka epoch time associated with this objectInstance--as microseconds elapsed since 1 Jan 1970 not including leap seconds objectKeys | No | array of :ref:`key <d_a217491e9c44487ec7bbd9ce3ac9dddb>` | | | an ordered set of keys that identifies this particular instance of jsonObject -.. _i_c0493c6178d712e91e73c63587e27067: +.. _i_4cf8290bf745cd386f0a55ec865aafd5: **Objectinstance schema:** @@ -2488,9 +2488,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: @@ -2565,7 +2565,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 @@ -2604,7 +2604,7 @@ 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: @@ -2661,7 +2661,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: @@ -2704,24 +2704,24 @@ syslogFields Model Structure sysLog fields .. csv-table:: - :delim: ; + :delim: | :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 delimited by a pipe | symbol, for example: 'name1=value1|name2=value2|' - 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 - syslogFieldsVersion ; Yes ; number ; ; ; version of the syslogFields block - syslogMsg ; Yes ; string ; ; ; syslog message - syslogPri ; No ; integer ; ; ; 0-192 combined severity and facility - syslogProc ; No ; string ; ; ; identifies the application that originated the message - syslogProcId ; No ; number ; ; ; a change in the value of this field indicates a discontinuity in syslog reporting - syslogSData ; No ; string ; ; ; syslog structured data consisting of a structured data Id followed by a set of key value pairs - syslogSdId ; No ; string ; ; ; 0-32 char in format name@number for example ourSDID@32473 - syslogSev ; No ; string ; ; {'enum': ['Alert', 'Critical', 'Debug', 'Emergency', 'Error', 'Info', 'Notice', 'Warning']} , numerical Code for severity derived from syslogPri as remaider of syslogPri / 8 - syslogTag ; Yes ; string ; ; ; msgId indicating the type of message such as TCPOUT or TCPIN, NILVALUE should be used when no other value can be provided - syslogVer ; No ; number ; ; ; IANA assigned version of the syslog protocol specification - typically 1 + additionalFields | No | string | | | additional syslog fields if needed provided as name=value delimited by a pipe | symbol, for example: 'name1=value1|name2=value2|' + 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 + syslogFieldsVersion | Yes | number | | | version of the syslogFields block + syslogMsg | Yes | string | | | syslog message + syslogPri | No | integer | | | 0-192 combined severity and facility + syslogProc | No | string | | | identifies the application that originated the message + syslogProcId | No | number | | | a change in the value of this field indicates a discontinuity in syslog reporting + syslogSData | No | string | | | syslog structured data consisting of a structured data Id followed by a set of key value pairs + syslogSdId | No | string | | | 0-32 char in format name@number for example ourSDID@32473 + syslogSev | No | string | | {'enum': ['Alert', 'Critical', 'Debug', 'Emergency', 'Error', 'Info', 'Notice', 'Warning']} | numerical Code for severity derived from syslogPri as remaider of syslogPri / 8 + syslogTag | Yes | string | | | msgId indicating the type of message such as TCPOUT or TCPIN; NILVALUE should be used when no other value can be provided + syslogVer | No | number | | | IANA assigned version of the syslog protocol specification - typically 1 .. _d_bd95ac8a5536a5bb5e6a0de7e64b9f20: @@ -2827,8 +2827,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 + |