diff options
author | Jim Hahn <jrh3@att.com> | 2019-05-29 15:41:48 -0400 |
---|---|---|
committer | Jim Hahn <jrh3@att.com> | 2019-05-30 09:08:43 -0400 |
commit | d5cc948b2c25b5e444705ba133b3d619474e1bc6 (patch) | |
tree | 57c245c0873fb84f684cb9022ce1ab4071e745a1 /docs/pap/swagger | |
parent | d8d3191510be75033894d41439dc92ba250eeda5 (diff) |
Add documentation for PAP
Included updates per Ram.
Change-Id: Ib09c9b7e39aab566ebd3eae813fde6bc3e2fabd7
Issue-ID: POLICY-1681
Signed-off-by: Jim Hahn <jrh3@att.com>
Diffstat (limited to 'docs/pap/swagger')
-rw-r--r-- | docs/pap/swagger/group-delete-pap.json | 94 | ||||
-rw-r--r-- | docs/pap/swagger/group-pap.json | 226 | ||||
-rw-r--r-- | docs/pap/swagger/group-query-pap.json | 210 | ||||
-rw-r--r-- | docs/pap/swagger/health-check-pap.json | 71 | ||||
-rw-r--r-- | docs/pap/swagger/policy-deploy-pap.json | 118 | ||||
-rw-r--r-- | docs/pap/swagger/policy-undeploy-pap.json | 166 | ||||
-rw-r--r-- | docs/pap/swagger/state-change-pap.json | 101 | ||||
-rw-r--r-- | docs/pap/swagger/statistics-pap.json | 91 |
8 files changed, 1077 insertions, 0 deletions
diff --git a/docs/pap/swagger/group-delete-pap.json b/docs/pap/swagger/group-delete-pap.json new file mode 100644 index 00000000..e670b5db --- /dev/null +++ b/docs/pap/swagger/group-delete-pap.json @@ -0,0 +1,94 @@ +{ + "swagger" : "2.0", + "basePath" : "/", + "tags" : [ { + "name" : "PdpGroupDelete" + } ], + "schemes" : [ "http", "https" ], + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "paths" : { + "/policy/pap/v1/pdps/groups/{name}" : { + "delete" : { + "tags" : [ "PdpGroupDelete" ], + "summary" : "Delete PDP Group", + "description" : "Deletes a PDP Group, returning optional error details", + "operationId" : "deleteGroup", + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "X-ONAP-RequestID", + "in" : "header", + "description" : "RequestID for http transaction", + "required" : false, + "type" : "string", + "format" : "uuid" + }, { + "name" : "name", + "in" : "path", + "description" : "PDP Group Name", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "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/PdpGroupDeleteResponse" + } + }, + "401" : { + "description" : "Authentication Error" + }, + "403" : { + "description" : "Authorization Error" + }, + "500" : { + "description" : "Internal Server Error" + } + }, + "security" : [ { + "basicAuth" : [ ] + } ], + "x-interface info" : { + "api-version" : "1.0.0", + "last-mod-release" : "Dublin" + } + } + } + }, + "securityDefinitions" : { + "basicAuth" : { + "description" : "", + "type" : "basic" + } + }, + "definitions" : { + "PdpGroupDeleteResponse" : { + "type" : "object", + "properties" : { + "errorDetails" : { + "type" : "string" + } + } + } + } +} diff --git a/docs/pap/swagger/group-pap.json b/docs/pap/swagger/group-pap.json new file mode 100644 index 00000000..1298fffa --- /dev/null +++ b/docs/pap/swagger/group-pap.json @@ -0,0 +1,226 @@ +{ + "swagger" : "2.0", + "basePath" : "/", + "tags" : [ { + "name" : "PdpGroupDeploy" + } ], + "schemes" : [ "http", "https" ], + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "paths" : { + "/policy/pap/v1/pdps" : { + "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" ], + "parameters" : [ { + "name" : "X-ONAP-RequestID", + "in" : "header", + "description" : "RequestID for http transaction", + "required" : false, + "type" : "string", + "format" : "uuid" + }, { + "in" : "body", + "name" : "body", + "description" : "List of PDP Group Configuration", + "required" : true, + "schema" : { + "$ref" : "#/definitions/PdpGroups" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "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/PdpGroupDeployResponse" + } + }, + "401" : { + "description" : "Authentication Error" + }, + "403" : { + "description" : "Authorization Error" + }, + "500" : { + "description" : "Internal Server Error" + } + }, + "security" : [ { + "basicAuth" : [ ] + } ], + "x-interface info" : { + "api-version" : "1.0.0", + "last-mod-release" : "Dublin" + } + } + } + }, + "securityDefinitions" : { + "basicAuth" : { + "description" : "", + "type" : "basic" + } + }, + "definitions" : { + "Pdp" : { + "type" : "object", + "properties" : { + "instanceId" : { + "type" : "string" + }, + "pdpState" : { + "type" : "string", + "enum" : [ "PASSIVE", "SAFE", "TEST", "ACTIVE", "TERMINATED" ] + }, + "healthy" : { + "type" : "string", + "enum" : [ "HEALTHY", "NOT_HEALTHY", "TEST_IN_PROGRESS", "UNKNOWN" ] + }, + "message" : { + "type" : "string" + } + } + }, + "PdpGroup" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string" + }, + "description" : { + "type" : "string" + }, + "pdpGroupState" : { + "type" : "string", + "enum" : [ "PASSIVE", "SAFE", "TEST", "ACTIVE", "TERMINATED" ] + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "pdpSubgroups" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/PdpSubGroup" + } + } + } + }, + "PdpGroups" : { + "type" : "object", + "properties" : { + "groups" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/PdpGroup" + } + } + } + }, + "PdpSubGroup" : { + "type" : "object", + "properties" : { + "pdpType" : { + "type" : "string" + }, + "supportedPolicyTypes" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ToscaPolicyTypeIdentifier" + } + }, + "policies" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ToscaPolicyIdentifier" + } + }, + "currentInstanceCount" : { + "type" : "integer", + "format" : "int32" + }, + "desiredInstanceCount" : { + "type" : "integer", + "format" : "int32" + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "pdpInstances" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/Pdp" + } + } + } + }, + "ToscaPolicyIdentifier" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "ToscaPolicyTypeIdentifier" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "PdpGroupDeployResponse" : { + "type" : "object", + "properties" : { + "errorDetails" : { + "type" : "string" + } + } + }, + "ToscaPolicyIdentifierOptVersion" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + } + } +} diff --git a/docs/pap/swagger/group-query-pap.json b/docs/pap/swagger/group-query-pap.json new file mode 100644 index 00000000..959ecc3c --- /dev/null +++ b/docs/pap/swagger/group-query-pap.json @@ -0,0 +1,210 @@ +{ + "swagger" : "2.0", + "basePath" : "/", + "tags" : [ { + "name" : "PdpGroupQuery" + } ], + "schemes" : [ "http", "https" ], + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "paths" : { + "/policy/pap/v1/pdps" : { + "get" : { + "tags" : [ "PdpGroupQuery" ], + "summary" : "Query details of all PDP groups", + "description" : "Queries details of all PDP groups, returning all group details", + "operationId" : "queryGroupDetails", + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "X-ONAP-RequestID", + "in" : "header", + "description" : "RequestID for http transaction", + "required" : false, + "type" : "string", + "format" : "uuid" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "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/PdpGroups" + } + }, + "401" : { + "description" : "Authentication Error" + }, + "403" : { + "description" : "Authorization Error" + }, + "500" : { + "description" : "Internal Server Error" + } + }, + "security" : [ { + "basicAuth" : [ ] + } ], + "x-interface info" : { + "api-version" : "1.0.0", + "last-mod-release" : "Dublin" + } + } + } + }, + "securityDefinitions" : { + "basicAuth" : { + "description" : "", + "type" : "basic" + } + }, + "definitions" : { + "Pdp" : { + "type" : "object", + "properties" : { + "instanceId" : { + "type" : "string" + }, + "pdpState" : { + "type" : "string", + "enum" : [ "PASSIVE", "SAFE", "TEST", "ACTIVE", "TERMINATED" ] + }, + "healthy" : { + "type" : "string", + "enum" : [ "HEALTHY", "NOT_HEALTHY", "TEST_IN_PROGRESS", "UNKNOWN" ] + }, + "message" : { + "type" : "string" + } + } + }, + "PdpGroup" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string" + }, + "description" : { + "type" : "string" + }, + "pdpGroupState" : { + "type" : "string", + "enum" : [ "PASSIVE", "SAFE", "TEST", "ACTIVE", "TERMINATED" ] + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "pdpSubgroups" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/PdpSubGroup" + } + } + } + }, + "PdpGroups" : { + "type" : "object", + "properties" : { + "groups" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/PdpGroup" + } + } + } + }, + "PdpSubGroup" : { + "type" : "object", + "properties" : { + "pdpType" : { + "type" : "string" + }, + "supportedPolicyTypes" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ToscaPolicyTypeIdentifier" + } + }, + "policies" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ToscaPolicyIdentifier" + } + }, + "currentInstanceCount" : { + "type" : "integer", + "format" : "int32" + }, + "desiredInstanceCount" : { + "type" : "integer", + "format" : "int32" + }, + "properties" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } + }, + "pdpInstances" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/Pdp" + } + } + } + }, + "ToscaPolicyIdentifier" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "ToscaPolicyTypeIdentifier" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + }, + "ToscaPolicyIdentifierOptVersion" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + } + } +} diff --git a/docs/pap/swagger/health-check-pap.json b/docs/pap/swagger/health-check-pap.json new file mode 100644 index 00000000..3bf87e22 --- /dev/null +++ b/docs/pap/swagger/health-check-pap.json @@ -0,0 +1,71 @@ +{ + "swagger" : "2.0", + "basePath" : "/", + "tags" : [ { + "name" : "HealthCheck" + } ], + "schemes" : [ "http", "https" ], + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "paths" : { + "/policy/pap/v1/healthcheck" : { + "get" : { + "tags" : [ "HealthCheck" ], + "summary" : "Perform healthcheck", + "description" : "Returns healthy status of the Policy Administration component", + "operationId" : "healthcheck", + "produces" : [ "application/json" ], + "parameters" : [ ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/HealthCheckReport" + } + }, + "401" : { + "description" : "Authentication Error" + }, + "403" : { + "description" : "Authorization Error" + }, + "500" : { + "description" : "Internal Server Error" + } + }, + "security" : [ { + "basicAuth" : [ ] + } ] + } + } + }, + "securityDefinitions" : { + "basicAuth" : { + "description" : "", + "type" : "basic" + } + }, + "definitions" : { + "HealthCheckReport" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string" + }, + "url" : { + "type" : "string" + }, + "healthy" : { + "type" : "boolean" + }, + "code" : { + "type" : "integer", + "format" : "int32" + }, + "message" : { + "type" : "string" + } + } + } + } +} diff --git a/docs/pap/swagger/policy-deploy-pap.json b/docs/pap/swagger/policy-deploy-pap.json new file mode 100644 index 00000000..a6d49346 --- /dev/null +++ b/docs/pap/swagger/policy-deploy-pap.json @@ -0,0 +1,118 @@ +{ + "swagger" : "2.0", + "basePath" : "/", + "tags" : [ { + "name" : "PdpPolicyDeploy" + } ], + "schemes" : [ "http", "https" ], + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "paths" : { + "/policy/pap/v1/pdps/policies" : { + "post" : { + "tags" : [ "PdpPolicyDeploy" ], + "summary" : "Deploy or update PDP Policies", + "description" : "Deploys or updates PDP Policies, returning optional error details", + "operationId" : "deployPolicies", + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "X-ONAP-RequestID", + "in" : "header", + "description" : "RequestID for http transaction", + "required" : false, + "type" : "string", + "format" : "uuid" + }, { + "in" : "body", + "name" : "body", + "description" : "PDP Policies; only the name is required", + "required" : true, + "schema" : { + "$ref" : "#/definitions/PdpDeployPolicies" + } + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "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/PdpGroupDeployResponse" + } + }, + "401" : { + "description" : "Authentication Error" + }, + "403" : { + "description" : "Authorization Error" + }, + "500" : { + "description" : "Internal Server Error" + } + }, + "security" : [ { + "basicAuth" : [ ] + } ], + "x-interface info" : { + "api-version" : "1.0.0", + "last-mod-release" : "Dublin" + } + } + } + }, + "securityDefinitions" : { + "basicAuth" : { + "description" : "", + "type" : "basic" + } + }, + "definitions" : { + "PdpGroupDeployResponse" : { + "type" : "object", + "properties" : { + "errorDetails" : { + "type" : "string" + } + } + }, + "PdpDeployPolicies" : { + "type" : "object", + "properties" : { + "policies" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/ToscaPolicyIdentifierOptVersion" + } + } + } + }, + "ToscaPolicyIdentifierOptVersion" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + } + } + } +} diff --git a/docs/pap/swagger/policy-undeploy-pap.json b/docs/pap/swagger/policy-undeploy-pap.json new file mode 100644 index 00000000..4235b04e --- /dev/null +++ b/docs/pap/swagger/policy-undeploy-pap.json @@ -0,0 +1,166 @@ +{ + "swagger" : "2.0", + "basePath" : "/", + "tags" : [ { + "name" : "PdpPolicyUndeploy" + } ], + "schemes" : [ "http", "https" ], + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "paths" : { + "/policy/pap/v1/pdps/policies/{name}" : { + "delete" : { + "tags" : [ "PdpPolicyUndeploy" ], + "summary" : "Undeploy a PDP Policy from PDPs", + "description" : "Undeploys the latest version of a policy from the PDPs, returning optional error details", + "operationId" : "deletePolicy", + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "X-ONAP-RequestID", + "in" : "header", + "description" : "RequestID for http transaction", + "required" : false, + "type" : "string", + "format" : "uuid" + }, { + "name" : "name", + "in" : "path", + "description" : "PDP Policy Name", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "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/PdpGroupDeleteResponse" + } + }, + "401" : { + "description" : "Authentication Error" + }, + "403" : { + "description" : "Authorization Error" + }, + "500" : { + "description" : "Internal Server Error" + } + }, + "security" : [ { + "basicAuth" : [ ] + } ], + "x-interface info" : { + "api-version" : "1.0.0", + "last-mod-release" : "Dublin" + } + } + }, + "/policy/pap/v1/pdps/policies/{name}/versions/{version}" : { + "delete" : { + "tags" : [ "PdpPolicyUndeploy" ], + "summary" : "Undeploy version of a PDP Policy from PDPs", + "description" : "Undeploys a specific version of a policy from the PDPs, returning optional error details", + "operationId" : "deletePolicyVersion", + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "X-ONAP-RequestID", + "in" : "header", + "description" : "RequestID for http transaction", + "required" : false, + "type" : "string", + "format" : "uuid" + }, { + "name" : "name", + "in" : "path", + "description" : "PDP Policy Name", + "required" : true, + "type" : "string" + }, { + "name" : "version", + "in" : "path", + "description" : "PDP Policy Version", + "required" : true, + "type" : "string" + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "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/PdpGroupDeleteResponse" + } + }, + "401" : { + "description" : "Authentication Error" + }, + "403" : { + "description" : "Authorization Error" + }, + "500" : { + "description" : "Internal Server Error" + } + }, + "security" : [ { + "basicAuth" : [ ] + } ], + "x-interface info" : { + "api-version" : "1.0.0", + "last-mod-release" : "Dublin" + } + } + } + }, + "securityDefinitions" : { + "basicAuth" : { + "description" : "", + "type" : "basic" + } + }, + "definitions" : { + "PdpGroupDeleteResponse" : { + "type" : "object", + "properties" : { + "errorDetails" : { + "type" : "string" + } + } + } + } +} diff --git a/docs/pap/swagger/state-change-pap.json b/docs/pap/swagger/state-change-pap.json new file mode 100644 index 00000000..16ef6360 --- /dev/null +++ b/docs/pap/swagger/state-change-pap.json @@ -0,0 +1,101 @@ +{ + "swagger" : "2.0", + "basePath" : "/", + "tags" : [ { + "name" : "PdpGroupStateChange" + } ], + "schemes" : [ "http", "https" ], + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "paths" : { + "/policy/pap/v1/pdps/groups/{name}" : { + "put" : { + "tags" : [ "PdpGroupStateChange" ], + "summary" : "Change state of a PDP Group", + "description" : "Changes state of PDP Group, returning optional error details", + "operationId" : "changeGroupState", + "produces" : [ "application/json" ], + "parameters" : [ { + "name" : "X-ONAP-RequestID", + "in" : "header", + "description" : "RequestID for http transaction", + "required" : false, + "type" : "string", + "format" : "uuid" + }, { + "name" : "name", + "in" : "path", + "description" : "PDP Group Name", + "required" : true, + "type" : "string" + }, { + "name" : "state", + "in" : "query", + "description" : "PDP Group State", + "required" : true, + "type" : "string", + "enum" : [ "PASSIVE", "SAFE", "TEST", "ACTIVE", "TERMINATED" ] + } ], + "responses" : { + "200" : { + "description" : "successful operation", + "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/PdpGroupStateChangeResponse" + } + }, + "401" : { + "description" : "Authentication Error" + }, + "403" : { + "description" : "Authorization Error" + }, + "500" : { + "description" : "Internal Server Error" + } + }, + "security" : [ { + "basicAuth" : [ ] + } ], + "x-interface info" : { + "api-version" : "1.0.0", + "last-mod-release" : "Dublin" + } + } + } + }, + "securityDefinitions" : { + "basicAuth" : { + "description" : "", + "type" : "basic" + } + }, + "definitions" : { + "PdpGroupStateChangeResponse" : { + "type" : "object", + "properties" : { + "errorDetails" : { + "type" : "string" + } + } + } + } +} diff --git a/docs/pap/swagger/statistics-pap.json b/docs/pap/swagger/statistics-pap.json new file mode 100644 index 00000000..390fe1a0 --- /dev/null +++ b/docs/pap/swagger/statistics-pap.json @@ -0,0 +1,91 @@ +{ + "swagger" : "2.0", + "basePath" : "/", + "tags" : [ { + "name" : "Statistics" + } ], + "schemes" : [ "http", "https" ], + "consumes" : [ "application/json" ], + "produces" : [ "application/json" ], + "paths" : { + "/policy/pap/v1/statistics" : { + "get" : { + "tags" : [ "Statistics" ], + "summary" : "Fetch current statistics", + "description" : "Returns current statistics of the Policy Administration component", + "operationId" : "statistics", + "produces" : [ "application/json" ], + "parameters" : [ ], + "responses" : { + "200" : { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/StatisticsReport" + } + }, + "401" : { + "description" : "Authentication Error" + }, + "403" : { + "description" : "Authorization Error" + }, + "500" : { + "description" : "Internal Server Error" + } + }, + "security" : [ { + "basicAuth" : [ ] + } ] + } + } + }, + "securityDefinitions" : { + "basicAuth" : { + "description" : "", + "type" : "basic" + } + }, + "definitions" : { + "StatisticsReport" : { + "type" : "object", + "properties" : { + "code" : { + "type" : "integer", + "format" : "int32" + }, + "totalPdpCount" : { + "type" : "integer", + "format" : "int64" + }, + "totalPdpGroupCount" : { + "type" : "integer", + "format" : "int64" + }, + "totalPolicyDeployCount" : { + "type" : "integer", + "format" : "int64" + }, + "policyDeploySuccessCount" : { + "type" : "integer", + "format" : "int64" + }, + "policyDeployFailureCount" : { + "type" : "integer", + "format" : "int64" + }, + "totalPolicyDownloadCount" : { + "type" : "integer", + "format" : "int64" + }, + "policyDownloadSuccessCount" : { + "type" : "integer", + "format" : "int64" + }, + "policyDownloadFailureCount" : { + "type" : "integer", + "format" : "int64" + } + } + } + } +} |