-deployment-handler API 4.1.0
+deployment-handler API 4.2.0
============================
.. toctree::
{
"links": {
- "self": "somestring",
+ "self": "somestring",
"status": "somestring"
- },
+ },
"requestId": "somestring"
}
.. code-block:: javascript
{
- "message": "somestring",
+ "message": "somestring",
"status": 1
}
.. code-block:: javascript
{
- "message": "somestring",
+ "message": "somestring",
"status": 1
}
.. code-block:: javascript
{
- "message": "somestring",
+ "message": "somestring",
"status": 1
}
.. code-block:: javascript
{
- "message": "somestring",
+ "message": "somestring",
"status": 1
}
"deployments": [
{
"href": "somestring"
- },
+ },
{
"href": "somestring"
}
- ],
+ ],
"requestId": "somestring"
}
.. code-block:: javascript
{
- "message": "somestring",
+ "message": "somestring",
"status": 1
}
.. code-block:: javascript
{
- "message": "somestring",
+ "message": "somestring",
"status": 1
}
.. code-block:: javascript
{
- "message": "somestring",
+ "message": "somestring",
"status": 1
}
.. code-block:: javascript
{
- "error": "somestring",
+ "error": "somestring",
"links": {
- "self": "somestring",
+ "self": "somestring",
"uninstall": "somestring"
- },
- "operationType": "somestring",
- "requestId": "somestring",
+ },
+ "operationType": "somestring",
+ "requestId": "somestring",
"status": "somestring"
}
.. code-block:: javascript
{
- "message": "somestring",
+ "message": "somestring",
"status": 1
}
.. code-block:: javascript
{
- "message": "somestring",
+ "message": "somestring",
"status": 1
}
.. code-block:: javascript
{
- "message": "somestring",
+ "message": "somestring",
"status": 1
}
.. code-block:: javascript
{
- "message": "somestring",
+ "message": "somestring",
"status": 1
}
: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:**
.. code-block:: javascript
{
- "inputs": {},
+ "inputs": {},
"serviceTypeId": "somestring"
}
{
"links": {
- "self": "somestring",
+ "self": "somestring",
"status": "somestring"
- },
+ },
"requestId": "somestring"
}
.. code-block:: javascript
{
- "message": "somestring",
+ "message": "somestring",
"status": 1
}
.. code-block:: javascript
{
- "message": "somestring",
+ "message": "somestring",
"status": 1
}
.. code-block:: javascript
{
- "message": "somestring",
+ "message": "somestring",
"status": 1
}
.. code-block:: javascript
{
- "message": "somestring",
+ "message": "somestring",
"status": 1
}
.. code-block:: javascript
{
- "message": "somestring",
+ "message": "somestring",
"status": 1
}
.. code-block:: javascript
{
- "message": "somestring",
+ "message": "somestring",
"status": 1
}
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"
}
: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
: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:**
: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.
: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: |
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.
'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.
: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:**
: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"}
Code Review / dcaegen2.git / blobdiff