aboutsummaryrefslogtreecommitdiffstats
path: root/docs/api/swagger
diff options
context:
space:
mode:
authorChenfei Gao <cgao@research.att.com>2019-10-10 15:24:11 -0400
committerChenfei Gao <cgao@research.att.com>2019-10-10 15:24:23 -0400
commit9c1190429134e9ff0d4b57a2a4eb8d459ed3acd6 (patch)
tree6fadc476b1cce23b98cd986d945b61e8d52dedff /docs/api/swagger
parentd3e39036e883385f1308d378ebe5e1179bfbc932 (diff)
Update api documentation to reflect addition of new policy creation endpoint
Issue-ID: POLICY-2157 Change-Id: Iebdf6f27c47b8bfae375845a01ab7dbea225c5a9 Signed-off-by: Chenfei Gao <cgao@research.att.com>
Diffstat (limited to 'docs/api/swagger')
-rw-r--r--docs/api/swagger/policy-api.json78
1 files changed, 77 insertions, 1 deletions
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" : "",