Document new PAP REST APIs
[policy/parent.git] / docs / pap / swagger / groups-batch-pap.json
similarity index 87%
rename from docs/pap/swagger/group-pap.json
rename to docs/pap/swagger/groups-batch-pap.json
index 1298fff..8a1899e 100644 (file)
@@ -2,19 +2,19 @@
   "swagger" : "2.0",
   "basePath" : "/",
   "tags" : [ {
-    "name" : "PdpGroupDeploy"
+    "name" : "PdpGroupUpdate"
   } ],
   "schemes" : [ "http", "https" ],
-  "consumes" : [ "application/json" ],
-  "produces" : [ "application/json" ],
+  "consumes" : [ "application/json", "application/yaml" ],
+  "produces" : [ "application/json", "application/yaml" ],
   "paths" : {
-    "/policy/pap/v1/pdps" : {
+    "/policy/pap/v1/pdps/groups/batch" : {
       "post" : {
-        "tags" : [ "PdpGroupDeploy" ],
-        "summary" : "Deploy or update PDP Groups",
-        "description" : "Deploys or updates a PDP Group, returning optional error details",
-        "operationId" : "deployGroup",
-        "produces" : [ "application/json" ],
+        "tags" : [ "PdpGroupUpdate" ],
+        "summary" : "Create or update PDP Groups",
+        "description" : "Create or update one or more PDP Groups, returning optional error details",
+        "operationId" : "createOrUpdateGroups",
+        "produces" : [ "application/json", "application/yaml" ],
         "parameters" : [ {
           "name" : "X-ONAP-RequestID",
           "in" : "header",
@@ -54,7 +54,7 @@
               }
             },
             "schema" : {
-              "$ref" : "#/definitions/PdpGroupDeployResponse"
+              "$ref" : "#/definitions/PdpGroupUpdateResponse"
             }
           },
           "401" : {
     }
   },
   "definitions" : {
+    "PdpGroupUpdateResponse" : {
+      "type" : "object",
+      "properties" : {
+        "errorDetails" : {
+          "type" : "string"
+        }
+      }
+    },
     "Pdp" : {
       "type" : "object",
       "properties" : {
           "type" : "string"
         }
       }
-    },
-    "PdpGroupDeployResponse" : {
-      "type" : "object",
-      "properties" : {
-        "errorDetails" : {
-          "type" : "string"
-        }
-      }
-    },
-    "ToscaPolicyIdentifierOptVersion" : {
-      "type" : "object",
-      "properties" : {
-        "name" : {
-          "type" : "string"
-        },
-        "version" : {
-          "type" : "string"
-        }
-      }
     }
   }
-}
+}
\ No newline at end of file