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" ],
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" ],
89 "produces" : [ "application/json" ],
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" : "Internal Server Error"
164 "x-interface info" : {
165 "api-version" : "1.0.0",
166 "last-mod-release" : "Dublin"
170 "/policy/api/v1/policytypes/{policyTypeId}/versions/{policyTypeVersion}/policies/{policyId}" : {
172 "tags" : [ "Policy" ],
173 "summary" : "Retrieve all version details of a policy created for a particular policy type version",
174 "description" : "Returns a list of all version details of the specified policy",
175 "operationId" : "getAllVersionsOfPolicy",
176 "produces" : [ "application/json" ],
178 "name" : "policyTypeId",
180 "description" : "ID of policy type",
184 "name" : "policyTypeVersion",
186 "description" : "Version of policy type",
192 "description" : "ID of policy",
196 "name" : "X-ONAP-RequestID",
198 "description" : "RequestID for http transaction",
205 "description" : "successful operation; All versions of specified policy matching specified policy type will be returned.",
209 "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
213 "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"
215 "X-LatestVersion" : {
217 "description" : "Used only to communicate an API's latest version"
219 "X-ONAP-RequestID" : {
222 "description" : "Used to track REST transactions for logging purpose"
226 "$ref" : "#/definitions/ToscaServiceTemplate"
230 "description" : "Authentication Error"
233 "description" : "Authorization Error"
236 "description" : "Resource Not Found"
239 "description" : "Internal Server Error"
245 "x-interface info" : {
246 "api-version" : "1.0.0",
247 "last-mod-release" : "Dublin"
251 "/policy/api/v1/policytypes/{policyTypeId}/versions/{policyTypeVersion}/policies/{policyId}/versions/{policyVersion}" : {
253 "tags" : [ "Policy" ],
254 "summary" : "Retrieve one version of a policy created for a particular policy type version",
255 "description" : "Returns a particular version of specified policy created for the specified policy type version",
256 "operationId" : "getSpecificVersionOfPolicy",
257 "produces" : [ "application/json" ],
259 "name" : "policyTypeId",
261 "description" : "ID of policy type",
265 "name" : "policyTypeVersion",
267 "description" : "Version of policy type",
273 "description" : "ID of policy",
277 "name" : "policyVersion",
279 "description" : "Version of policy",
283 "name" : "X-ONAP-RequestID",
285 "description" : "RequestID for http transaction",
292 "description" : "successful operation; The specified policy matching specified policy type will be returned.",
296 "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
300 "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"
302 "X-LatestVersion" : {
304 "description" : "Used only to communicate an API's latest version"
306 "X-ONAP-RequestID" : {
309 "description" : "Used to track REST transactions for logging purpose"
313 "$ref" : "#/definitions/ToscaServiceTemplate"
317 "description" : "Authentication Error"
320 "description" : "Authorization Error"
323 "description" : "Resource Not Found"
326 "description" : "Internal Server Error"
332 "x-interface info" : {
333 "api-version" : "1.0.0",
334 "last-mod-release" : "Dublin"
338 "tags" : [ "Policy" ],
339 "summary" : "Delete a particular version of a policy",
340 "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",
341 "operationId" : "deleteSpecificVersionOfPolicy",
342 "produces" : [ "application/json" ],
344 "name" : "policyTypeId",
346 "description" : "PolicyType ID",
350 "name" : "policyTypeVersion",
352 "description" : "Version of policy type",
358 "description" : "ID of policy",
362 "name" : "policyVersion",
364 "description" : "Version of policy",
368 "name" : "X-ONAP-RequestID",
370 "description" : "RequestID for http transaction",
377 "description" : "successful operation; Newly deleted policy matching specified policy type will be returned.",
381 "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
385 "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"
387 "X-LatestVersion" : {
389 "description" : "Used only to communicate an API's latest version"
391 "X-ONAP-RequestID" : {
394 "description" : "Used to track REST transactions for logging purpose"
398 "$ref" : "#/definitions/ToscaServiceTemplate"
402 "description" : "Authentication Error"
405 "description" : "Authorization Error"
408 "description" : "Resource Not Found"
411 "description" : "Delete Conflict, Rule Violation"
414 "description" : "Internal Server Error"
420 "x-interface info" : {
421 "api-version" : "1.0.0",
422 "last-mod-release" : "Dublin"
426 "/policy/api/v1/policytypes/{policyTypeId}/versions/{policyTypeVersion}/policies/{policyId}/versions/latest" : {
428 "tags" : [ "Policy" ],
429 "summary" : "Retrieve the latest version of a particular policy",
430 "description" : "Returns the latest version of specified policy",
431 "operationId" : "getLatestVersionOfPolicy",
432 "produces" : [ "application/json" ],
434 "name" : "policyTypeId",
436 "description" : "ID of policy type",
440 "name" : "policyTypeVersion",
442 "description" : "Version of policy type",
448 "description" : "ID of policy",
452 "name" : "X-ONAP-RequestID",
454 "description" : "RequestID for http transaction",
461 "description" : "successful operation; Latest version of specified policy matching specified policy type will be returned.",
465 "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
469 "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"
471 "X-LatestVersion" : {
473 "description" : "Used only to communicate an API's latest version"
475 "X-ONAP-RequestID" : {
478 "description" : "Used to track REST transactions for logging purpose"
482 "$ref" : "#/definitions/ToscaServiceTemplate"
486 "description" : "Authentication Error"
489 "description" : "Authorization Error"
492 "description" : "Resource Not Found"
495 "description" : "Internal Server Error"
501 "x-interface info" : {
502 "api-version" : "1.0.0",
503 "last-mod-release" : "Dublin"
507 "/policy/api/v1/policytypes/{policyTypeId}/versions/{policyTypeVersion}/policies/{policyId}/versions/deployed" : {
509 "tags" : [ "Policy" ],
510 "summary" : "Retrieve deployed versions of a particular policy in pdp groups",
511 "description" : "Returns deployed versions of specified policy in pdp groups",
512 "operationId" : "getDeployedVersionsOfPolicy",
513 "produces" : [ "application/json" ],
515 "name" : "policyTypeId",
517 "description" : "ID of policy type",
521 "name" : "policyTypeVersion",
523 "description" : "Version of policy type",
529 "description" : "ID of policy",
533 "name" : "X-ONAP-RequestID",
535 "description" : "RequestID for http transaction",
542 "description" : "successful operation; Deployed versions of specified policy matching specified policy type will be returned.",
546 "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
550 "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"
552 "X-LatestVersion" : {
554 "description" : "Used only to communicate an API's latest version"
556 "X-ONAP-RequestID" : {
559 "description" : "Used to track REST transactions for logging purpose"
565 "$ref" : "#/definitions/ToscaPolicy"
570 "description" : "Authentication Error"
573 "description" : "Authorization Error"
576 "description" : "Resource Not Found"
579 "description" : "Internal Server Error"
585 "x-interface info" : {
586 "api-version" : "1.0.0",
587 "last-mod-release" : "Dublin"
592 "securityDefinitions" : {
599 "ToscaConstraint" : {
614 "greater_or_equal" : {
639 "additionalProperties" : {
649 "$ref" : "#/definitions/ToscaConstraint"
654 "additionalProperties" : {
655 "$ref" : "#/definitions/ToscaProperty"
660 "ToscaEntrySchema" : {
678 "$ref" : "#/definitions/ToscaConstraint"
683 "ToscaPolicyType" : {
697 "additionalProperties" : {
706 "additionalProperties" : {
707 "$ref" : "#/definitions/ToscaProperty"
712 "ToscaPolicyTypeIdentifier" : {
746 "enum" : [ "SUPPORTED", "UNSUPPORTED", "EXPERIMENTAL", "DEPRECATED" ]
751 "$ref" : "#/definitions/ToscaConstraint"
755 "$ref" : "#/definitions/ToscaEntrySchema"
759 "ToscaServiceTemplate" : {
773 "additionalProperties" : {
780 "tosca_definitions_version" : {
783 "topology_template" : {
784 "$ref" : "#/definitions/ToscaTopologyTemplate"
790 "additionalProperties" : {
791 "$ref" : "#/definitions/ToscaPolicyType"
799 "additionalProperties" : {
800 "$ref" : "#/definitions/ToscaDataType"
806 "ToscaTopologyTemplate" : {
816 "additionalProperties" : {
817 "$ref" : "#/definitions/ToscaPolicy"