7 "schemes" : [ "http", "https" ],
9 "/policy/api/v1/policytypes/{policyTypeId}/versions/{policyTypeVersion}/policies" : {
11 "tags" : [ "Policy" ],
12 "summary" : "Retrieve all versions of a policy created for a particular policy type version",
13 "description" : "Returns a list of all versions of specified policy created for the specified policy type version",
14 "operationId" : "getAllPolicies",
15 "produces" : [ "application/json", "application/yaml" ],
17 "name" : "policyTypeId",
19 "description" : "ID of policy type",
23 "name" : "policyTypeVersion",
25 "description" : "Version of policy type",
29 "name" : "X-ONAP-RequestID",
31 "description" : "RequestID for http transaction",
38 "description" : "successful operation; All policies matching specified policy type will be returned.",
42 "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
46 "description" : "Used only to communicate a PATCH version in a response for troubleshooting purposes only, and will not be provided by the client on request"
50 "description" : "Used only to communicate an API's latest version"
52 "X-ONAP-RequestID" : {
55 "description" : "Used to track REST transactions for logging purpose"
59 "$ref" : "#/definitions/ToscaServiceTemplate"
63 "description" : "Authentication Error"
66 "description" : "Authorization Error"
69 "description" : "Resource Not Found"
72 "description" : "Internal Server Error"
78 "x-interface info" : {
79 "api-version" : "1.0.0",
80 "last-mod-release" : "Dublin"
84 "tags" : [ "Policy" ],
85 "summary" : "Create a new policy for a policy type version",
86 "description" : "Create a new policy for a policy type. Client should provide TOSCA body of the new policy",
87 "operationId" : "createPolicy",
88 "consumes" : [ "application/json", "application/yaml" ],
89 "produces" : [ "application/json", "application/yaml" ],
91 "name" : "policyTypeId",
93 "description" : "ID of policy type",
97 "name" : "policyTypeVersion",
99 "description" : "Version of policy type",
103 "name" : "X-ONAP-RequestID",
105 "description" : "RequestID for http transaction",
112 "description" : "Entity body of policy",
114 "type" : "ToscaServiceTemplate",
116 "$ref" : "#/definitions/ToscaServiceTemplate"
121 "description" : "successful operation; Newly created policy matching specified policy type will be returned.",
125 "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
129 "description" : "Used only to communicate a PATCH version in a response for troubleshooting purposes only, and will not be provided by the client on request"
131 "X-LatestVersion" : {
133 "description" : "Used only to communicate an API's latest version"
135 "X-ONAP-RequestID" : {
138 "description" : "Used to track REST transactions for logging purpose"
142 "$ref" : "#/definitions/ToscaServiceTemplate"
146 "description" : "Invalid Body"
149 "description" : "Authentication Error"
152 "description" : "Authorization Error"
155 "description" : "Resource Not Found"
158 "description" : "Not Acceptable Version"
161 "description" : "Internal Server Error"
167 "x-interface info" : {
168 "api-version" : "1.0.0",
169 "last-mod-release" : "Dublin"
173 "/policy/api/v1/policytypes/{policyTypeId}/versions/{policyTypeVersion}/policies/{policyId}" : {
175 "tags" : [ "Policy" ],
176 "summary" : "Retrieve all version details of a policy created for a particular policy type version",
177 "description" : "Returns a list of all version details of the specified policy",
178 "operationId" : "getAllVersionsOfPolicy",
179 "produces" : [ "application/json", "application/yaml" ],
181 "name" : "policyTypeId",
183 "description" : "ID of policy type",
187 "name" : "policyTypeVersion",
189 "description" : "Version of policy type",
195 "description" : "ID of policy",
199 "name" : "X-ONAP-RequestID",
201 "description" : "RequestID for http transaction",
208 "description" : "successful operation; All versions of specified policy matching specified policy type will be returned.",
212 "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
216 "description" : "Used only to communicate a PATCH version in a response for troubleshooting purposes only, and will not be provided by the client on request"
218 "X-LatestVersion" : {
220 "description" : "Used only to communicate an API's latest version"
222 "X-ONAP-RequestID" : {
225 "description" : "Used to track REST transactions for logging purpose"
229 "$ref" : "#/definitions/ToscaServiceTemplate"
233 "description" : "Authentication Error"
236 "description" : "Authorization Error"
239 "description" : "Resource Not Found"
242 "description" : "Internal Server Error"
248 "x-interface info" : {
249 "api-version" : "1.0.0",
250 "last-mod-release" : "Dublin"
254 "/policy/api/v1/policytypes/{policyTypeId}/versions/{policyTypeVersion}/policies/{policyId}/versions/{policyVersion}" : {
256 "tags" : [ "Policy" ],
257 "summary" : "Retrieve one version of a policy created for a particular policy type version",
258 "description" : "Returns a particular version of specified policy created for the specified policy type version",
259 "operationId" : "getSpecificVersionOfPolicy",
260 "produces" : [ "application/json", "application/yaml" ],
262 "name" : "policyTypeId",
264 "description" : "ID of policy type",
268 "name" : "policyTypeVersion",
270 "description" : "Version of policy type",
276 "description" : "ID of policy",
280 "name" : "policyVersion",
282 "description" : "Version of policy",
286 "name" : "X-ONAP-RequestID",
288 "description" : "RequestID for http transaction",
295 "description" : "successful operation; The specified policy matching specified policy type will be returned.",
299 "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
303 "description" : "Used only to communicate a PATCH version in a response for troubleshooting purposes only, and will not be provided by the client on request"
305 "X-LatestVersion" : {
307 "description" : "Used only to communicate an API's latest version"
309 "X-ONAP-RequestID" : {
312 "description" : "Used to track REST transactions for logging purpose"
316 "$ref" : "#/definitions/ToscaServiceTemplate"
320 "description" : "Authentication Error"
323 "description" : "Authorization Error"
326 "description" : "Resource Not Found"
329 "description" : "Internal Server Error"
335 "x-interface info" : {
336 "api-version" : "1.0.0",
337 "last-mod-release" : "Dublin"
341 "tags" : [ "Policy" ],
342 "summary" : "Delete a particular version of a policy",
343 "description" : "Delete a particular version of a policy. It must follow one rule. Rule: the version that has been deployed in PDP group(s) cannot be deleted",
344 "operationId" : "deleteSpecificVersionOfPolicy",
345 "produces" : [ "application/json", "application/yaml" ],
347 "name" : "policyTypeId",
349 "description" : "PolicyType ID",
353 "name" : "policyTypeVersion",
355 "description" : "Version of policy type",
361 "description" : "ID of policy",
365 "name" : "policyVersion",
367 "description" : "Version of policy",
371 "name" : "X-ONAP-RequestID",
373 "description" : "RequestID for http transaction",
380 "description" : "successful operation; Newly deleted policy matching specified policy type will be returned.",
384 "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
388 "description" : "Used only to communicate a PATCH version in a response for troubleshooting purposes only, and will not be provided by the client on request"
390 "X-LatestVersion" : {
392 "description" : "Used only to communicate an API's latest version"
394 "X-ONAP-RequestID" : {
397 "description" : "Used to track REST transactions for logging purpose"
401 "$ref" : "#/definitions/ToscaServiceTemplate"
405 "description" : "Authentication Error"
408 "description" : "Authorization Error"
411 "description" : "Resource Not Found"
414 "description" : "Delete Conflict, Rule Violation"
417 "description" : "Internal Server Error"
423 "x-interface info" : {
424 "api-version" : "1.0.0",
425 "last-mod-release" : "Dublin"
429 "/policy/api/v1/policytypes/{policyTypeId}/versions/{policyTypeVersion}/policies/{policyId}/versions/latest" : {
431 "tags" : [ "Policy" ],
432 "summary" : "Retrieve the latest version of a particular policy",
433 "description" : "Returns the latest version of specified policy",
434 "operationId" : "getLatestVersionOfPolicy",
435 "produces" : [ "application/json", "application/yaml" ],
437 "name" : "policyTypeId",
439 "description" : "ID of policy type",
443 "name" : "policyTypeVersion",
445 "description" : "Version of policy type",
451 "description" : "ID of policy",
455 "name" : "X-ONAP-RequestID",
457 "description" : "RequestID for http transaction",
464 "description" : "successful operation; Latest version of specified policy matching specified policy type will be returned.",
468 "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
472 "description" : "Used only to communicate a PATCH version in a response for troubleshooting purposes only, and will not be provided by the client on request"
474 "X-LatestVersion" : {
476 "description" : "Used only to communicate an API's latest version"
478 "X-ONAP-RequestID" : {
481 "description" : "Used to track REST transactions for logging purpose"
485 "$ref" : "#/definitions/ToscaServiceTemplate"
489 "description" : "Authentication Error"
492 "description" : "Authorization Error"
495 "description" : "Resource Not Found"
498 "description" : "Internal Server Error"
504 "x-interface info" : {
505 "api-version" : "1.0.0",
506 "last-mod-release" : "Dublin"
510 "/policy/api/v1/policytypes/{policyTypeId}/versions/{policyTypeVersion}/policies/{policyId}/versions/deployed" : {
512 "tags" : [ "Policy" ],
513 "summary" : "Retrieve deployed versions of a particular policy in pdp groups",
514 "description" : "Returns deployed versions of specified policy in pdp groups",
515 "operationId" : "getDeployedVersionsOfPolicy",
516 "produces" : [ "application/json", "application/yaml" ],
518 "name" : "policyTypeId",
520 "description" : "ID of policy type",
524 "name" : "policyTypeVersion",
526 "description" : "Version of policy type",
532 "description" : "ID of policy",
536 "name" : "X-ONAP-RequestID",
538 "description" : "RequestID for http transaction",
545 "description" : "successful operation; Deployed versions of specified policy matching specified policy type will be returned.",
549 "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
553 "description" : "Used only to communicate a PATCH version in a response for troubleshooting purposes only, and will not be provided by the client on request"
555 "X-LatestVersion" : {
557 "description" : "Used only to communicate an API's latest version"
559 "X-ONAP-RequestID" : {
562 "description" : "Used to track REST transactions for logging purpose"
568 "$ref" : "#/definitions/ToscaPolicy"
573 "description" : "Authentication Error"
576 "description" : "Authorization Error"
579 "description" : "Resource Not Found"
582 "description" : "Internal Server Error"
588 "x-interface info" : {
589 "api-version" : "1.0.0",
590 "last-mod-release" : "Dublin"
594 "/policy/api/v1/policies" : {
596 "tags" : [ "Policy" ],
597 "summary" : "Create one or more new policies",
598 "description" : "Create one or more new policies. Client should provide TOSCA body of the new policies",
599 "operationId" : "createPolicies",
600 "consumes" : [ "application/json", "application/yaml" ],
601 "produces" : [ "application/json", "application/yaml" ],
603 "name" : "X-ONAP-RequestID",
605 "description" : "RequestID for http transaction",
612 "description" : "Entity body of policies",
614 "type" : "ToscaServiceTemplate",
616 "$ref" : "#/definitions/ToscaServiceTemplate"
621 "description" : "successful operation; Newly created policies will be returned.",
625 "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
629 "description" : "Used only to communicate a PATCH version in a response for troubleshooting purposes only, and will not be provided by the client on request"
631 "X-LatestVersion" : {
633 "description" : "Used only to communicate an API's latest version"
635 "X-ONAP-RequestID" : {
638 "description" : "Used to track REST transactions for logging purpose"
642 "$ref" : "#/definitions/ToscaServiceTemplate"
646 "description" : "Invalid Body"
649 "description" : "Authentication Error"
652 "description" : "Authorization Error"
655 "description" : "Resource Not Found"
658 "description" : "Not Acceptable Version"
661 "description" : "Internal Server Error"
667 "x-interface info" : {
668 "api-version" : "1.0.0",
669 "last-mod-release" : "Frankfurt"
674 "securityDefinitions" : {
681 "ToscaConstraint" : {
696 "greater_or_equal" : {
721 "additionalProperties" : {
731 "$ref" : "#/definitions/ToscaConstraint"
736 "additionalProperties" : {
737 "$ref" : "#/definitions/ToscaProperty"
742 "ToscaEntrySchema" : {
760 "$ref" : "#/definitions/ToscaConstraint"
765 "ToscaPolicyType" : {
779 "additionalProperties" : {
788 "additionalProperties" : {
789 "$ref" : "#/definitions/ToscaProperty"
794 "ToscaPolicyTypeIdentifier" : {
828 "enum" : [ "SUPPORTED", "UNSUPPORTED", "EXPERIMENTAL", "DEPRECATED" ]
833 "$ref" : "#/definitions/ToscaConstraint"
837 "$ref" : "#/definitions/ToscaEntrySchema"
841 "ToscaServiceTemplate" : {
855 "additionalProperties" : {
862 "tosca_definitions_version" : {
865 "topology_template" : {
866 "$ref" : "#/definitions/ToscaTopologyTemplate"
872 "additionalProperties" : {
873 "$ref" : "#/definitions/ToscaPolicyType"
881 "additionalProperties" : {
882 "$ref" : "#/definitions/ToscaDataType"
888 "ToscaTopologyTemplate" : {
898 "additionalProperties" : {
899 "$ref" : "#/definitions/ToscaPolicy"