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/policies/{policyId}/versions/{policyVersion}": {
515 "summary": "Retrieve specific version of a specified policy",
516 "description": "Returns a particular version of specified policy",
517 "operationId": "getSpecificPolicy",
530 "description": "Name of policy",
535 "name": "policyVersion",
537 "description": "Version of policy",
542 "name": "X-ONAP-RequestID",
544 "description": "RequestID for http transaction",
552 "description": "Fetch mode for policies, BARE for bare policies (default), REFERENCED for fully referenced policies",
564 "description": "successful operation",
568 "description": "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
572 "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"
576 "description": "Used only to communicate an API's latest version"
578 "X-ONAP-RequestID": {
581 "description": "Used to track REST transactions for logging purpose"
585 "$ref": "#/definitions/ToscaServiceTemplate"
589 "description": "Authentication Error"
592 "description": "Authorization Error"
595 "description": "Resource Not Found"
598 "description": "Internal Server Error"
606 "x-interface info": {
607 "api-version": "1.0.0",
608 "last-mod-release": "Guilin"
615 "summary": "Delete a particular version of a policy",
616 "description": "Rule: the version that has been deployed in PDP group(s) cannot be deleted",
617 "operationId": "deleteSpecificPolicy",
630 "description": "ID of policy",
635 "name": "policyVersion",
637 "description": "Version of policy",
642 "name": "X-ONAP-RequestID",
644 "description": "RequestID for http transaction",
652 "description": "successful operation",
656 "description": "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
660 "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"
664 "description": "Used only to communicate an API's latest version"
666 "X-ONAP-RequestID": {
669 "description": "Used to track REST transactions for logging purpose"
673 "$ref": "#/definitions/ToscaServiceTemplate"
677 "description": "Authentication Error"
680 "description": "Authorization Error"
683 "description": "Resource Not Found"
686 "description": "Delete Conflict, Rule Violation"
689 "description": "Internal Server Error"
697 "x-interface info": {
698 "api-version": "1.0.0",
699 "last-mod-release": "Guilin"
703 "/policy/api/v1/policies" : {
708 "summary": "Retrieve all versions of available policies",
709 "description": "Returns all version of available policies",
710 "operationId": "getPolicies",
721 "name": "X-ONAP-RequestID",
723 "description": "RequestID for http transaction",
731 "description": "Fetch mode for policies, BARE for bare policies (default), REFERENCED for fully referenced policies",
743 "description": "successful operation",
747 "description": "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
751 "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"
755 "description": "Used only to communicate an API's latest version"
757 "X-ONAP-RequestID": {
760 "description": "Used to track REST transactions for logging purpose"
764 "$ref": "#/definitions/ToscaServiceTemplate"
768 "description": "Authentication Error"
771 "description": "Authorization Error"
774 "description": "Resource Not Found"
777 "description": "Internal Server Error"
785 "x-interface info": {
786 "api-version": "1.0.0",
787 "last-mod-release": "Guilin"
791 "tags" : [ "Policy" ],
792 "summary" : "Create one or more new policies",
793 "description" : "Create one or more new policies. Client should provide TOSCA body of the new policies",
794 "operationId" : "createPolicies",
795 "consumes" : [ "application/json", "application/yaml" ],
796 "produces" : [ "application/json", "application/yaml" ],
798 "name" : "X-ONAP-RequestID",
800 "description" : "RequestID for http transaction",
807 "description" : "Entity body of policies",
809 "type" : "ToscaServiceTemplate",
811 "$ref" : "#/definitions/ToscaServiceTemplate"
816 "description" : "successful operation; Newly created policies will be returned.",
820 "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
824 "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"
826 "X-LatestVersion" : {
828 "description" : "Used only to communicate an API's latest version"
830 "X-ONAP-RequestID" : {
833 "description" : "Used to track REST transactions for logging purpose"
837 "$ref" : "#/definitions/ToscaServiceTemplate"
841 "description" : "Invalid Body"
844 "description" : "Authentication Error"
847 "description" : "Authorization Error"
850 "description" : "Resource Not Found"
853 "description" : "Not Acceptable Version"
856 "description" : "Internal Server Error"
862 "x-interface info" : {
863 "api-version" : "1.0.0",
864 "last-mod-release" : "Frankfurt"
869 "securityDefinitions" : {
876 "ToscaConstraint" : {
891 "greater_or_equal" : {
916 "additionalProperties" : {
926 "$ref" : "#/definitions/ToscaConstraint"
931 "additionalProperties" : {
932 "$ref" : "#/definitions/ToscaProperty"
937 "ToscaEntrySchema" : {
955 "$ref" : "#/definitions/ToscaConstraint"
960 "ToscaPolicyType" : {
974 "additionalProperties" : {
983 "additionalProperties" : {
984 "$ref" : "#/definitions/ToscaProperty"
989 "ToscaPolicyTypeIdentifier" : {
1023 "enum" : [ "SUPPORTED", "UNSUPPORTED", "EXPERIMENTAL", "DEPRECATED" ]
1028 "$ref" : "#/definitions/ToscaConstraint"
1032 "$ref" : "#/definitions/ToscaEntrySchema"
1036 "ToscaServiceTemplate" : {
1050 "additionalProperties" : {
1057 "tosca_definitions_version" : {
1060 "topology_template" : {
1061 "$ref" : "#/definitions/ToscaTopologyTemplate"
1067 "additionalProperties" : {
1068 "$ref" : "#/definitions/ToscaPolicyType"
1076 "additionalProperties" : {
1077 "$ref" : "#/definitions/ToscaDataType"
1083 "ToscaTopologyTemplate" : {
1093 "additionalProperties" : {
1094 "$ref" : "#/definitions/ToscaPolicy"