diff options
author | Lusheng Ji <lji@research.att.com> | 2018-03-27 23:24:33 -0400 |
---|---|---|
committer | Lusheng Ji <lji@research.att.com> | 2018-03-27 23:25:41 -0400 |
commit | b2a561b84b926ef109809539b9e283e95032c083 (patch) | |
tree | cf15dc96d20ba09b5a80419cd5f29201230499fb /docs/sections/apis/deployment-handler-API.yaml | |
parent | 13de8870c542c1cd87d24f1bdde5878c82276c8b (diff) |
Add documentation
Issue-ID: DCAEGEN2-206
Change-Id: I73de95e98e4cd545dcc29b0fcecf84530c23e2aa
Signed-off-by: Lusheng Ji <lji@research.att.com>
Diffstat (limited to 'docs/sections/apis/deployment-handler-API.yaml')
-rw-r--r-- | docs/sections/apis/deployment-handler-API.yaml | 50 |
1 files changed, 48 insertions, 2 deletions
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 |