summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChenfei Gao <cgao@research.att.com>2019-08-21 16:25:14 -0400
committerChenfei Gao <cgao@research.att.com>2019-08-21 16:25:22 -0400
commit8429713b4bfc09ecbafb593cd48daf670def660e (patch)
treee1a5c8b507523dd77a480c20fc057f3c160e6382
parent2f5f116faa66414da147618ba137e6efd394e166 (diff)
Update API swagger to reflect the most recent changes to deployed endpoints
Issue-ID: POLICY-1994 Change-Id: Iab2795ba9cf89cacf467cfa8156fc50685f81059 Signed-off-by: Chenfei Gao <cgao@research.att.com>
-rw-r--r--docs/api/swagger/guard-policy-api.json74
-rw-r--r--docs/api/swagger/operational-policy-api.json74
2 files changed, 146 insertions, 2 deletions
diff --git a/docs/api/swagger/guard-policy-api.json b/docs/api/swagger/guard-policy-api.json
index 866472ac..7bb6c99a 100644
--- a/docs/api/swagger/guard-policy-api.json
+++ b/docs/api/swagger/guard-policy-api.json
@@ -78,6 +78,78 @@
}
}
},
+ "/policy/api/v1/policytypes/onap.policies.controlloop.Guard/versions/1.0.0/policies/{policyId}/versions/deployed" : {
+ "get" : {
+ "tags" : [ "Legacy Guard Policy" ],
+ "summary" : "Retrieve deployed versions of a particular guard policy in pdp groups",
+ "description" : "Returns deployed versions of a specified guard policy in pdp groups",
+ "operationId" : "getDeployedVersionsOfGuardPolicy",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "policyId",
+ "in" : "path",
+ "description" : "ID of guard 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 guard 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" : "map",
+ "items" : {
+ "$ref" : "#/definitions/LegacyGuardPolicyOutput"
+ }
+ }
+ },
+ "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.Guard/versions/1.0.0/policies/{policyId}/versions/{policyVersion}" : {
"get" : {
"tags" : [ "Legacy Guard Policy" ],
@@ -402,4 +474,4 @@
}
}
}
-} \ No newline at end of file
+}
diff --git a/docs/api/swagger/operational-policy-api.json b/docs/api/swagger/operational-policy-api.json
index ad098f37..0306f737 100644
--- a/docs/api/swagger/operational-policy-api.json
+++ b/docs/api/swagger/operational-policy-api.json
@@ -75,6 +75,78 @@
}
}
},
+ "/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" ],
+ "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" ],
@@ -322,4 +394,4 @@
}
}
}
-} \ No newline at end of file
+}