diff options
| -rw-r--r-- | docs/api/api.rst | 1 | ||||
| -rw-r--r-- | docs/api/swagger/policy-api.json | 78 |
2 files changed, 78 insertions, 1 deletions
diff --git a/docs/api/api.rst b/docs/api/api.rst index e08e6ba6..fc0f106f 100644 --- a/docs/api/api.rst +++ b/docs/api/api.rst @@ -64,6 +64,7 @@ well-formed TOSCA monitoring policies. :widths: 15,10 "vCPE.Monitoring.Tosca", `vCPE.policy.monitoring.input.tosca.yaml <https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/policies/vCPE.policy.monitoring.input.tosca.yaml>`_ `vCPE.policy.monitoring.input.tosca.json <https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/policies/vCPE.policy.monitoring.input.tosca.json>`_ + "vCPE.Optimization.Tosca", `vCPE.policies.optimization.input.tosca.yaml <https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/policies/vCPE.policies.optimization.input.tosca.yaml>`_ "vCPE.Operational.Legacy", `vCPE.policy.operational.input.json <https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/policies/vCPE.policy.operational.input.json>`_ "vDNS.Guard.FrequencyLimiting.Legacy", `vDNS.policy.guard.frequency.input.json <https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/policies/vDNS.policy.guard.frequency.input.json>`_ "vDNS.Guard.MinMax.Legacy", `vDNS.policy.guard.minmax.input.json <https://github.com/onap/policy-models/blob/master/models-examples/src/main/resources/policies/vDNS.policy.guard.minmax.input.json>`_ diff --git a/docs/api/swagger/policy-api.json b/docs/api/swagger/policy-api.json index 0037fd5d..17c5d505 100644 --- a/docs/api/swagger/policy-api.json +++ b/docs/api/swagger/policy-api.json @@ -587,8 +587,84 @@ "last-mod-release" : "Dublin" } } + }, + "/policy/api/v1/policies" : { + "post" : { + "tags" : [ "Policy" ], + "summary" : "Create one or more new policies", + "description" : "Create one or more new policies. Client should provide TOSCA body of the new policies", + "operationId" : "createPolicies", + "consumes" : [ "application/json", "application/yaml" ], + "produces" : [ "application/json", "application/yaml" ], + "parameters" : [ { + "name" : "X-ONAP-RequestID", + "in" : "header", + "description" : "RequestID for http transaction", + "required" : false, + "type" : "string", + "format" : "uuid" + }, { + "in" : "body", + "name" : "body", + "description" : "Entity body of policies", + "required" : true, + "type" : "ToscaServiceTemplate", + "schema" : { + "$ref" : "#/definitions/ToscaServiceTemplate" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation; Newly created policies will be returned.", + "headers" : { + "X-MinorVersion" : { + "type" : "string", + "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client" + }, + "X-PatchVersion" : { + "type" : "string", + "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" + }, + "X-LatestVersion" : { + "type" : "string", + "description" : "Used only to communicate an API's latest version" + }, + "X-ONAP-RequestID" : { + "type" : "string", + "format" : "uuid", + "description" : "Used to track REST transactions for logging purpose" + } + }, + "schema" : { + "$ref" : "#/definitions/ToscaServiceTemplate" + } + }, + "400" : { + "description" : "Invalid Body" + }, + "401" : { + "description" : "Authentication Error" + }, + "403" : { + "description" : "Authorization Error" + }, + "404" : { + "description" : "Resource Not Found" + }, + "500" : { + "description" : "Internal Server Error" + } + }, + "security" : [ { + "basicAuth" : [ ] + } ], + "x-interface info" : { + "api-version" : "1.0.0", + "last-mod-release" : "Frankfurt" + } + } } - }, + }, "securityDefinitions" : { "basicAuth" : { "description" : "", |