aboutsummaryrefslogtreecommitdiffstats
path: root/deployment-handler-API.yaml
diff options
context:
space:
mode:
Diffstat (limited to 'deployment-handler-API.yaml')
-rw-r--r--deployment-handler-API.yaml39
1 files changed, 35 insertions, 4 deletions
diff --git a/deployment-handler-API.yaml b/deployment-handler-API.yaml
index eb1aed6..c4e9213 100644
--- a/deployment-handler-API.yaml
+++ b/deployment-handler-API.yaml
@@ -475,20 +475,51 @@ definitions:
properties:
catch_up:
- description: "flag to indicate whether the request contains all the policies in PDP or not"
+ description: flag to indicate whether the request contains all the policies in PDP or not
type: boolean
default: false
latest_policies:
- description: "dictionary of (policy_id -> DCAEPolicy object). 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: "dictionary of (policy_id -> DCAEPolicy object). In example: replace additionalProp1,2,3 with policy_id1,2,3 values"
+ 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:
- $ref: "#/definitions/DCAEPolicy"
+ 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