diff options
Diffstat (limited to 'deployment-handler-API.yaml')
| -rw-r--r-- | deployment-handler-API.yaml | 93 |
1 files changed, 91 insertions, 2 deletions
diff --git a/deployment-handler-API.yaml b/deployment-handler-API.yaml index 31395a5..b85a554 100644 --- a/deployment-handler-API.yaml +++ b/deployment-handler-API.yaml @@ -1,9 +1,26 @@ +# ================================================================================ +# 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: "4.1.0" + version: "4.3.0" title: "deployment-handler API" license: name: "Apache 2.0" @@ -120,6 +137,12 @@ paths: in: path type: string required: true + - name: cfy_tenant_name + description: | + Tenant Name in Cloudify. Optional, if not specified, "default_tenant" will be used. + in: path + type: string + required: false - name: body in: body @@ -241,6 +264,12 @@ paths: in: path type: string required: true + - name: cfy_tenant_name + description: | + Tenant Name in Cloudify. Optional, if not specified, "default_tenant" will be used. + in: path + type: string + required: false responses: @@ -287,6 +316,12 @@ paths: - application/json parameters: + - name: cfy_tenant_name + description: | + Tenant Name in Cloudify. Optional, if not specified, "default_tenant" will be used. + in: path + type: string + required: false - name: body in: body schema: @@ -305,6 +340,14 @@ paths: produces: - application/json + parameters: + - name: cfy_tenant_name + description: | + Tenant Name in Cloudify. Optional, if not specified, "default_tenant" will be used. + in: path + type: string + required: false + responses: 200: description: deployment-handler found components with or without policies in cloudify @@ -469,11 +512,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 |