7 "schemes" : [ "http", "https" ],
9 "/policy/api/v1/policytypes" : {
11 "tags" : [ "PolicyType" ],
12 "summary" : "Retrieve existing policy types",
13 "description" : "Returns a list of existing policy types stored in Policy Framework",
14 "operationId" : "getAllPolicyTypes",
15 "produces" : [ "application/json" ],
17 "name" : "X-ONAP-RequestID",
19 "description" : "RequestID for http transaction",
26 "description" : "successful operation; All policy types will be returned.",
30 "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
34 "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"
38 "description" : "Used only to communicate an API's latest version"
40 "X-ONAP-RequestID" : {
43 "description" : "Used to track REST transactions for logging purpose"
47 "$ref" : "#/definitions/ToscaServiceTemplate"
51 "description" : "Authentication Error"
54 "description" : "Authorization Error"
57 "description" : "Internal Server Error"
63 "x-interface info" : {
64 "api-version" : "1.0.0",
65 "last-mod-release" : "Dublin"
69 "tags" : [ "PolicyType" ],
70 "summary" : "Create a new policy type",
71 "description" : "Create a new policy type. Client should provide TOSCA body of the new policy type",
72 "operationId" : "createPolicyType",
73 "consumes" : [ "application/json" ],
74 "produces" : [ "application/json" ],
78 "description" : "Entity body of policy type",
80 "type" : "ToscaServiceTemplate",
82 "$ref" : "#/definitions/ToscaServiceTemplate"
85 "name" : "X-ONAP-RequestID",
87 "description" : "RequestID for http transaction",
94 "description" : "successful operation; The newly created policy type will be returned.",
98 "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
102 "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"
104 "X-LatestVersion" : {
106 "description" : "Used only to communicate an API's latest version"
108 "X-ONAP-RequestID" : {
111 "description" : "Used to track REST transactions for logging purpose"
115 "$ref" : "#/definitions/ToscaServiceTemplate"
119 "description" : "Invalid Body"
122 "description" : "Authentication Error"
125 "description" : "Authorization Error"
128 "description" : "Internal Server Error"
134 "x-interface info" : {
135 "api-version" : "1.0.0",
136 "last-mod-release" : "Dublin"
140 "/policy/api/v1/policytypes/{policyTypeId}" : {
142 "tags" : [ "PolicyType" ],
143 "summary" : "Retrieve all available versions of a policy type",
144 "description" : "Returns a list of all available versions for the specified policy type",
145 "operationId" : "getAllVersionsOfPolicyType",
146 "produces" : [ "application/json" ],
148 "name" : "policyTypeId",
150 "description" : "ID of policy type",
154 "name" : "X-ONAP-RequestID",
156 "description" : "RequestID for http transaction",
163 "description" : "successful operation; All versions of specified policy type will be returned.",
167 "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
171 "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"
173 "X-LatestVersion" : {
175 "description" : "Used only to communicate an API's latest version"
177 "X-ONAP-RequestID" : {
180 "description" : "Used to track REST transactions for logging purpose"
184 "$ref" : "#/definitions/ToscaServiceTemplate"
188 "description" : "Authentication Error"
191 "description" : "Authorization Error"
194 "description" : "Resource Not Found"
197 "description" : "Internal Server Error"
203 "x-interface info" : {
204 "api-version" : "1.0.0",
205 "last-mod-release" : "Dublin"
209 "/policy/api/v1/policytypes/{policyTypeId}/versions/{versionId}" : {
211 "tags" : [ "PolicyType" ],
212 "summary" : "Retrieve one particular version of a policy type",
213 "description" : "Returns a particular version for the specified policy type",
214 "operationId" : "getSpecificVersionOfPolicyType",
215 "produces" : [ "application/json" ],
217 "name" : "policyTypeId",
219 "description" : "ID of policy type",
223 "name" : "versionId",
225 "description" : "Version of policy type",
229 "name" : "X-ONAP-RequestID",
231 "description" : "RequestID for http transaction",
238 "description" : "successful operation; One specified version of specified policy type will be returned.",
242 "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
246 "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"
248 "X-LatestVersion" : {
250 "description" : "Used only to communicate an API's latest version"
252 "X-ONAP-RequestID" : {
255 "description" : "Used to track REST transactions for logging purpose"
259 "$ref" : "#/definitions/ToscaServiceTemplate"
263 "description" : "Authentication Error"
266 "description" : "Authorization Error"
269 "description" : "Resource Not Found"
272 "description" : "Internal Server Error"
278 "x-interface info" : {
279 "api-version" : "1.0.0",
280 "last-mod-release" : "Dublin"
284 "tags" : [ "PolicyType" ],
285 "summary" : "Delete one version of a policy type",
286 "description" : "Delete one version of a policy type. It must follow two rules. Rule 1: pre-defined policy types cannot be deleted; Rule 2: policy types that are in use (parameterized by a TOSCA policy) cannot be deleted. The parameterizing TOSCA policies must be deleted first.",
287 "operationId" : "deleteSpecificVersionOfPolicyType",
288 "produces" : [ "application/json" ],
290 "name" : "policyTypeId",
292 "description" : "ID of policy type",
296 "name" : "versionId",
298 "description" : "Version of policy type",
302 "name" : "X-ONAP-RequestID",
304 "description" : "RequestID for http transaction",
311 "description" : "successful operation; Newly deleted policy type will be returned.",
315 "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
319 "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"
321 "X-LatestVersion" : {
323 "description" : "Used only to communicate an API's latest version"
325 "X-ONAP-RequestID" : {
328 "description" : "Used to track REST transactions for logging purpose"
332 "$ref" : "#/definitions/ToscaServiceTemplate"
336 "description" : "Authentication Error"
339 "description" : "Authorization Error"
342 "description" : "Resource Not Found"
345 "description" : "Delete Conflict, Rule Violation"
348 "description" : "Internal Server Error"
354 "x-interface info" : {
355 "api-version" : "1.0.0",
356 "last-mod-release" : "Dublin"
360 "/policy/api/v1/policytypes/{policyTypeId}/versions/latest" : {
362 "tags" : [ "PolicyType" ],
363 "summary" : "Retrieve latest version of a policy type",
364 "description" : "Returns latest version for the specified policy type",
365 "operationId" : "getLatestVersionOfPolicyType",
366 "produces" : [ "application/json" ],
368 "name" : "policyTypeId",
370 "description" : "ID of policy type",
374 "name" : "X-ONAP-RequestID",
376 "description" : "RequestID for http transaction",
383 "description" : "successful operation; Latest version of specified policy type will be returned.",
387 "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
391 "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"
393 "X-LatestVersion" : {
395 "description" : "Used only to communicate an API's latest version"
397 "X-ONAP-RequestID" : {
400 "description" : "Used to track REST transactions for logging purpose"
404 "$ref" : "#/definitions/ToscaServiceTemplate"
408 "description" : "Authentication Error"
411 "description" : "Authorization Error"
414 "description" : "Resource Not Found"
417 "description" : "Internal Server Error"
423 "x-interface info" : {
424 "api-version" : "1.0.0",
425 "last-mod-release" : "Dublin"
430 "securityDefinitions" : {
437 "ToscaConstraint" : {
452 "greater_or_equal" : {
477 "additionalProperties" : {
487 "$ref" : "#/definitions/ToscaConstraint"
492 "additionalProperties" : {
493 "$ref" : "#/definitions/ToscaProperty"
498 "ToscaEntrySchema" : {
516 "$ref" : "#/definitions/ToscaConstraint"
521 "ToscaPolicyType" : {
535 "additionalProperties" : {
544 "additionalProperties" : {
545 "$ref" : "#/definitions/ToscaProperty"
550 "ToscaPolicyTypeIdentifier" : {
584 "enum" : [ "SUPPORTED", "UNSUPPORTED", "EXPERIMENTAL", "DEPRECATED" ]
589 "$ref" : "#/definitions/ToscaConstraint"
593 "$ref" : "#/definitions/ToscaEntrySchema"
597 "ToscaServiceTemplate" : {
611 "additionalProperties" : {
618 "tosca_definitions_version" : {
621 "topology_template" : {
622 "$ref" : "#/definitions/ToscaTopologyTemplate"
628 "additionalProperties" : {
629 "$ref" : "#/definitions/ToscaPolicyType"
637 "additionalProperties" : {
638 "$ref" : "#/definitions/ToscaDataType"
644 "ToscaTopologyTemplate" : {
654 "additionalProperties" : {
655 "$ref" : "#/definitions/ToscaPolicy"