Update info yaml in policy-parent

[policy/parent.git] / docs / api / swagger / operational-policy-api.json

diff --git a/docs/api/swagger/operational-policy-api.json b/docs/api/swagger/operational-policy-api.json
index ad098f3..90a0e51 100644 (file)
--- a/docs/api/swagger/operational-policy-api.json
+++ b/docs/api/swagger/operational-policy-api.json
@@ -12,7 +12,7 @@
         "summary" : "Retrieve the latest version of a particular operational policy",
         "description" : "Returns the latest version of the specified operational policy",
         "operationId" : "getLatestVersionOfOperationalPolicy",
-        "produces" : [ "application/json" ],
+        "produces" : [ "application/json", "application/yaml" ],
         "parameters" : [ {
           "name" : "policyId",
           "in" : "path",
@@ -75,13 +75,85 @@
         }
       }
     },
+    "/policy/api/v1/policytypes/onap.policies.controlloop.Operational/versions/1.0.0/policies/{policyId}/versions/deployed" : {
+      "get" : {
+        "tags" : [ "Legacy Opereational Policy" ],
+        "summary" : "Retrieve deployed versions of a particular operational policy in pdp groups",
+        "description" : "Returns deployed versions of a specified operational policy in pdp groups",
+        "operationId" : "getDeployedVersionsOfOperationalPolicy",
+        "produces" : [ "application/json", "application/yaml" ],
+        "parameters" : [ {
+          "name" : "policyId",
+          "in" : "path",
+          "description" : "ID of operational policy",
+          "required" : true,
+          "type" : "string"
+        }, {
+          "name" : "X-ONAP-RequestID",
+          "in" : "header",
+          "description" : "RequestID for http transaction",
+          "required" : false,
+          "type" : "string",
+          "format" : "uuid"
+        } ],
+        "responses" : {
+          "200" : {
+            "description" : "successful operation; Deployed versions of specified operational policy in PDP groups 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" : {
+              "type" : "array",
+              "items" : {
+                "$ref" : "#/definitions/LegacyOperationalPolicy"
+              }
+            }
+          },
+          "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" : "Dublin"
+        }
+      }
+    },
     "/policy/api/v1/policytypes/onap.policies.controlloop.Operational/versions/1.0.0/policies/{policyId}/versions/{policyVersion}" : {
       "get" : {
         "tags" : [ "Legacy Operational Policy" ],
         "summary" : "Retrieve one version of a particular operational policy",
         "description" : "Returns a particular version of a specified operational policy",
         "operationId" : "getSpecificVersionOfOperationalPolicy",
-        "produces" : [ "application/json" ],
+        "produces" : [ "application/json", "application/yaml" ],
         "parameters" : [ {
           "name" : "policyId",
           "in" : "path",
@@ -154,7 +226,7 @@
         "summary" : "Delete a particular version of a specified operational policy",
         "description" : "Delete a particular version of an operational policy. It must follow one rule. Rule: the version that has been deployed in PDP group(s) cannot be deleted",
         "operationId" : "deleteSpecificVersionOfOperationalPolicy",
-        "produces" : [ "application/json" ],
+        "produces" : [ "application/json", "application/yaml" ],
         "parameters" : [ {
           "name" : "policyId",
           "in" : "path",
@@ -232,8 +304,8 @@
         "summary" : "Create a new operational policy",
         "description" : "Create a new operational policy. Client should provide entity body of the new operational policy",
         "operationId" : "createOperationalPolicy",
-        "consumes" : [ "application/json" ],
-        "produces" : [ "application/json" ],
+        "consumes" : [ "application/json", "application/yaml" ],
+        "produces" : [ "application/json", "application/yaml" ],
         "parameters" : [ {
           "name" : "X-ONAP-RequestID",
           "in" : "header",
@@ -286,6 +358,9 @@
           "403" : {
             "description" : "Authorization Error"
           },
+          "406" : {
+            "description" : "Not Acceptable Version"
+          },
           "500" : {
             "description" : "Internal Server Error"
           }
@@ -322,4 +397,4 @@
       }
     }
   }
-}
\ No newline at end of file
+}