Update pap documents
[policy/parent.git] / docs / pap / swagger / group-delete-pap.json
1 {
2   "swagger" : "2.0",
3   "basePath" : "/",
4   "tags" : [ {
5     "name" : "PdpGroup Delete"
6   } ],
7   "schemes" : [ "http", "https" ],
8   "consumes" : [ "application/json" ],
9   "produces" : [ "application/json" ],
10   "paths" : {
11     "/policy/pap/v1/pdps/groups/{name}" : {
12       "delete" : {
13         "tags" : [ "PdpGroup Delete" ],
14         "summary" : "Delete PDP Group",
15         "description" : "Deletes a PDP Group, returning optional error details",
16         "operationId" : "deleteGroup",
17         "produces" : [ "application/json" ],
18         "parameters" : [ {
19           "name" : "X-ONAP-RequestID",
20           "in" : "header",
21           "description" : "RequestID for http transaction",
22           "required" : false,
23           "type" : "string",
24           "format" : "uuid"
25         }, {
26           "name" : "name",
27           "in" : "path",
28           "description" : "PDP Group Name",
29           "required" : true,
30           "type" : "string"
31         } ],
32         "responses" : {
33           "200" : {
34             "description" : "successful operation",
35             "headers" : {
36               "X-MinorVersion" : {
37                 "type" : "string",
38                 "description" : "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
39               },
40               "X-PatchVersion" : {
41                 "type" : "string",
42                 "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"
43               },
44               "X-LatestVersion" : {
45                 "type" : "string",
46                 "description" : "Used only to communicate an API's latest version"
47               },
48               "X-ONAP-RequestID" : {
49                 "type" : "string",
50                 "format" : "uuid",
51                 "description" : "Used to track REST transactions for logging purpose"
52               }
53             },
54             "schema" : {
55               "$ref" : "#/definitions/PdpGroupDeleteResponse"
56             }
57           },
58           "401" : {
59             "description" : "Authentication Error"
60           },
61           "403" : {
62             "description" : "Authorization Error"
63           },
64           "500" : {
65             "description" : "Internal Server Error"
66           }
67         },
68         "security" : [ {
69           "basicAuth" : [ ]
70         } ],
71         "x-interface info" : {
72           "api-version" : "1.0.0",
73           "last-mod-release" : "Dublin"
74         }
75       }
76     }
77   },
78   "securityDefinitions" : {
79     "basicAuth" : {
80       "description" : "",
81       "type" : "basic"
82     }
83   },
84   "definitions" : {
85     "PdpGroupDeleteResponse" : {
86       "type" : "object",
87       "properties" : {
88         "errorDetails" : {
89           "type" : "string"
90         }
91       }
92     }
93   }
94 }