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", "application/yaml" ],
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", "application/yaml" ],
74 "produces" : [ "application/json", "application/yaml" ],
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" : "Not Acceptable Version"
131 "description" : "Internal Server Error"
137 "x-interface info" : {
138 "api-version" : "1.0.0",
139 "last-mod-release" : "Dublin"
143 "/policy/api/v1/policytypes/{policyTypeId}" : {
145 "tags" : [ "PolicyType" ],
146 "summary" : "Retrieve all available versions of a policy type",
147 "description" : "Returns a list of all available versions for the specified policy type",
148 "operationId" : "getAllVersionsOfPolicyType",
149 "produces" : [ "application/json", "application/yaml" ],
151 "name" : "policyTypeId",
153 "description" : "ID of policy type",
157 "name" : "X-ONAP-RequestID",
159 "description" : "RequestID for http transaction",
166 "description" : "successful operation; All versions of specified policy type will be returned.",
170 "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
174 "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"
176 "X-LatestVersion" : {
178 "description" : "Used only to communicate an API's latest version"
180 "X-ONAP-RequestID" : {
183 "description" : "Used to track REST transactions for logging purpose"
187 "$ref" : "#/definitions/ToscaServiceTemplate"
191 "description" : "Authentication Error"
194 "description" : "Authorization Error"
197 "description" : "Resource Not Found"
200 "description" : "Internal Server Error"
206 "x-interface info" : {
207 "api-version" : "1.0.0",
208 "last-mod-release" : "Dublin"
212 "/policy/api/v1/policytypes/{policyTypeId}/versions/{versionId}" : {
214 "tags" : [ "PolicyType" ],
215 "summary" : "Retrieve one particular version of a policy type",
216 "description" : "Returns a particular version for the specified policy type",
217 "operationId" : "getSpecificVersionOfPolicyType",
218 "produces" : [ "application/json", "application/yaml" ],
220 "name" : "policyTypeId",
222 "description" : "ID of policy type",
226 "name" : "versionId",
228 "description" : "Version of policy type",
232 "name" : "X-ONAP-RequestID",
234 "description" : "RequestID for http transaction",
241 "description" : "successful operation; One specified version of specified policy type will be returned.",
245 "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
249 "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"
251 "X-LatestVersion" : {
253 "description" : "Used only to communicate an API's latest version"
255 "X-ONAP-RequestID" : {
258 "description" : "Used to track REST transactions for logging purpose"
262 "$ref" : "#/definitions/ToscaServiceTemplate"
266 "description" : "Authentication Error"
269 "description" : "Authorization Error"
272 "description" : "Resource Not Found"
275 "description" : "Internal Server Error"
281 "x-interface info" : {
282 "api-version" : "1.0.0",
283 "last-mod-release" : "Dublin"
287 "tags" : [ "PolicyType" ],
288 "summary" : "Delete one version of a policy type",
289 "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.",
290 "operationId" : "deleteSpecificVersionOfPolicyType",
291 "produces" : [ "application/json", "application/yaml" ],
293 "name" : "policyTypeId",
295 "description" : "ID of policy type",
299 "name" : "versionId",
301 "description" : "Version of policy type",
305 "name" : "X-ONAP-RequestID",
307 "description" : "RequestID for http transaction",
314 "description" : "successful operation; Newly deleted policy type will be returned.",
318 "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
322 "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"
324 "X-LatestVersion" : {
326 "description" : "Used only to communicate an API's latest version"
328 "X-ONAP-RequestID" : {
331 "description" : "Used to track REST transactions for logging purpose"
335 "$ref" : "#/definitions/ToscaServiceTemplate"
339 "description" : "Authentication Error"
342 "description" : "Authorization Error"
345 "description" : "Resource Not Found"
348 "description" : "Delete Conflict, Rule Violation"
351 "description" : "Internal Server Error"
357 "x-interface info" : {
358 "api-version" : "1.0.0",
359 "last-mod-release" : "Dublin"
363 "/policy/api/v1/policytypes/{policyTypeId}/versions/latest" : {
365 "tags" : [ "PolicyType" ],
366 "summary" : "Retrieve latest version of a policy type",
367 "description" : "Returns latest version for the specified policy type",
368 "operationId" : "getLatestVersionOfPolicyType",
369 "produces" : [ "application/json", "application/yaml" ],
371 "name" : "policyTypeId",
373 "description" : "ID of policy type",
377 "name" : "X-ONAP-RequestID",
379 "description" : "RequestID for http transaction",
386 "description" : "successful operation; Latest version of specified policy type will be returned.",
390 "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
394 "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"
396 "X-LatestVersion" : {
398 "description" : "Used only to communicate an API's latest version"
400 "X-ONAP-RequestID" : {
403 "description" : "Used to track REST transactions for logging purpose"
407 "$ref" : "#/definitions/ToscaServiceTemplate"
411 "description" : "Authentication Error"
414 "description" : "Authorization Error"
417 "description" : "Resource Not Found"
420 "description" : "Internal Server Error"
426 "x-interface info" : {
427 "api-version" : "1.0.0",
428 "last-mod-release" : "Dublin"
433 "securityDefinitions" : {
440 "ToscaConstraint" : {
455 "greater_or_equal" : {
480 "additionalProperties" : {
490 "$ref" : "#/definitions/ToscaConstraint"
495 "additionalProperties" : {
496 "$ref" : "#/definitions/ToscaProperty"
501 "ToscaEntrySchema" : {
519 "$ref" : "#/definitions/ToscaConstraint"
524 "ToscaPolicyType" : {
538 "additionalProperties" : {
547 "additionalProperties" : {
548 "$ref" : "#/definitions/ToscaProperty"
553 "ToscaPolicyTypeIdentifier" : {
587 "enum" : [ "SUPPORTED", "UNSUPPORTED", "EXPERIMENTAL", "DEPRECATED" ]
592 "$ref" : "#/definitions/ToscaConstraint"
596 "$ref" : "#/definitions/ToscaEntrySchema"
600 "ToscaServiceTemplate" : {
614 "additionalProperties" : {
621 "tosca_definitions_version" : {
624 "topology_template" : {
625 "$ref" : "#/definitions/ToscaTopologyTemplate"
631 "additionalProperties" : {
632 "$ref" : "#/definitions/ToscaPolicyType"
640 "additionalProperties" : {
641 "$ref" : "#/definitions/ToscaDataType"
647 "ToscaTopologyTemplate" : {
657 "additionalProperties" : {
658 "$ref" : "#/definitions/ToscaPolicy"