diff options
Diffstat (limited to 'docs/pap/swagger')
| -rw-r--r-- | docs/pap/swagger/consolidated-healthcheck-pap.json | 101 | ||||
| -rw-r--r-- | docs/pap/swagger/deployed-policy-pap.json | 322 | ||||
| -rw-r--r-- | docs/pap/swagger/deployments-batch-pap.json | 4 | ||||
| -rw-r--r-- | docs/pap/swagger/group-delete-pap.json | 4 | ||||
| -rw-r--r-- | docs/pap/swagger/group-query-pap.json | 4 | ||||
| -rw-r--r-- | docs/pap/swagger/groups-batch-pap.json | 4 | ||||
| -rw-r--r-- | docs/pap/swagger/pdp-statistics-pap.json | 368 | ||||
| -rw-r--r-- | docs/pap/swagger/policy-deploy-pap.json | 4 | ||||
| -rw-r--r-- | docs/pap/swagger/policy-undeploy-pap.json | 6 | ||||
| -rw-r--r-- | docs/pap/swagger/state-change-pap.json | 4 |
10 files changed, 806 insertions, 15 deletions
diff --git a/docs/pap/swagger/consolidated-healthcheck-pap.json b/docs/pap/swagger/consolidated-healthcheck-pap.json new file mode 100644 index 00000000..2044bc8a --- /dev/null +++ b/docs/pap/swagger/consolidated-healthcheck-pap.json @@ -0,0 +1,101 @@ +{ + "swagger": "2.0", + "basePath": "/", + "tags": [ + { + "name": "Consolidated Healthcheck" + } + ], + "schemes": [ + "http", + "https" + ], + "consumes": [ + "application/json", + "application/yaml" + ], + "produces": [ + "application/json", + "application/yaml" + ], + "paths": { + "/policy/pap/v1/components/healthcheck": { + "get": { + "tags": [ + "Consolidated Healthcheck" + ], + "summary": "Returns health status of all policy components, including PAP, API, Distribution, and PDPs", + "description": "Queries health status of all policy components, returning all policy components health status", + "operationId": "policyComponentsHealthCheck", + "produces": [ + "application/json", + "application/yaml" + ], + "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": { + "type": "object", + "additionalProperties": { + "type": "object" + } + } + }, + "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": "Frankfurt" + } + } + } + }, + "securityDefinitions": { + "basicAuth": { + "description": "", + "type": "basic" + } + } +}
\ No newline at end of file diff --git a/docs/pap/swagger/deployed-policy-pap.json b/docs/pap/swagger/deployed-policy-pap.json new file mode 100644 index 00000000..09280c7b --- /dev/null +++ b/docs/pap/swagger/deployed-policy-pap.json @@ -0,0 +1,322 @@ +{ + "swagger": "2.0", + "basePath": "/", + "tags": [ + { + "name": "Policy Deployment Status" + } + ], + "schemes": [ + "http", + "https" + ], + "consumes": [ + "application/json", + "application/yaml" + ], + "produces": [ + "application/json", + "application/yaml" + ], + "paths": { + "/policy/pap/v1/policies/deployed": { + "get": { + "tags": [ + "Policy Deployment Status" + ], + "summary": "Queries status of all deployed policies", + "description": "Queries status of all deployed policies, returning success and failure counts of the PDPs", + "operationId": "queryAllDeployedPolicies", + "produces": [ + "application/json", + "application/yaml" + ], + "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": { + "type": "array", + "items": { + "$ref": "#/definitions/PolicyStatus" + } + } + }, + "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/policies/deployed/{name}": { + "get": { + "tags": [ + "Policy Deployment Status" + ], + "summary": "Queries status of specific deployed policies", + "description": "Queries status of specific deployed policies, returning success and failure counts of the PDPs", + "operationId": "queryDeployedPolicies", + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Policy Id", + "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", + "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/PolicyStatus" + } + } + }, + "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/policies/deployed/{name}/{version}": { + "get": { + "tags": [ + "Policy Deployment Status" + ], + "summary": "Queries status of a specific deployed policy", + "description": "Queries status of a specific deployed policy, returning success and failure counts of the PDPs", + "operationId": "queryDeployedPolicy", + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Policy Id", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "description": "Policy Version", + "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", + "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/PolicyStatus" + } + }, + "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": { + "ToscaPolicyIdentifier": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string" + } + } + }, + "ToscaPolicyTypeIdentifier": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string" + } + } + }, + "PolicyStatus": { + "type": "object", + "properties": { + "policyTypeId": { + "type": "string" + }, + "policyTypeVersion": { + "type": "string" + }, + "policyId": { + "type": "string" + }, + "policyVersion": { + "type": "string" + }, + "successCount": { + "type": "integer", + "format": "int32" + }, + "failureCount": { + "type": "integer", + "format": "int32" + }, + "incompleteCount": { + "type": "integer", + "format": "int32" + }, + "policy": { + "$ref": "#/definitions/ToscaPolicyIdentifier" + }, + "policyType": { + "$ref": "#/definitions/ToscaPolicyTypeIdentifier" + } + } + } + } +}
\ No newline at end of file diff --git a/docs/pap/swagger/deployments-batch-pap.json b/docs/pap/swagger/deployments-batch-pap.json index 58289fb9..29d96941 100644 --- a/docs/pap/swagger/deployments-batch-pap.json +++ b/docs/pap/swagger/deployments-batch-pap.json @@ -2,7 +2,7 @@ "swagger" : "2.0", "basePath" : "/", "tags" : [ { - "name" : "DeploymentsUpdate" + "name" : "Deployments Update" } ], "schemes" : [ "http", "https" ], "consumes" : [ "application/json", "application/yaml" ], @@ -10,7 +10,7 @@ "paths" : { "/policy/pap/v1/pdps/deployments/batch" : { "post" : { - "tags" : [ "DeploymentsUpdate" ], + "tags" : [ "Deployments Update" ], "summary" : "Updates policy deployments within specific PDP groups", "description" : "Updates policy deployments within specific PDP groups, returning optional error details", "operationId" : "updateGroupPolicies", diff --git a/docs/pap/swagger/group-delete-pap.json b/docs/pap/swagger/group-delete-pap.json index e670b5db..4b5c217c 100644 --- a/docs/pap/swagger/group-delete-pap.json +++ b/docs/pap/swagger/group-delete-pap.json @@ -2,7 +2,7 @@ "swagger" : "2.0", "basePath" : "/", "tags" : [ { - "name" : "PdpGroupDelete" + "name" : "PdpGroup Delete" } ], "schemes" : [ "http", "https" ], "consumes" : [ "application/json" ], @@ -10,7 +10,7 @@ "paths" : { "/policy/pap/v1/pdps/groups/{name}" : { "delete" : { - "tags" : [ "PdpGroupDelete" ], + "tags" : [ "PdpGroup Delete" ], "summary" : "Delete PDP Group", "description" : "Deletes a PDP Group, returning optional error details", "operationId" : "deleteGroup", diff --git a/docs/pap/swagger/group-query-pap.json b/docs/pap/swagger/group-query-pap.json index 959ecc3c..b31515c8 100644 --- a/docs/pap/swagger/group-query-pap.json +++ b/docs/pap/swagger/group-query-pap.json @@ -2,7 +2,7 @@ "swagger" : "2.0", "basePath" : "/", "tags" : [ { - "name" : "PdpGroupQuery" + "name" : "PdpGroup Query" } ], "schemes" : [ "http", "https" ], "consumes" : [ "application/json" ], @@ -10,7 +10,7 @@ "paths" : { "/policy/pap/v1/pdps" : { "get" : { - "tags" : [ "PdpGroupQuery" ], + "tags" : [ "PdpGroup Query" ], "summary" : "Query details of all PDP groups", "description" : "Queries details of all PDP groups, returning all group details", "operationId" : "queryGroupDetails", diff --git a/docs/pap/swagger/groups-batch-pap.json b/docs/pap/swagger/groups-batch-pap.json index 8a1899e3..2d02e998 100644 --- a/docs/pap/swagger/groups-batch-pap.json +++ b/docs/pap/swagger/groups-batch-pap.json @@ -2,7 +2,7 @@ "swagger" : "2.0", "basePath" : "/", "tags" : [ { - "name" : "PdpGroupUpdate" + "name" : "PdpGroup Create/Update" } ], "schemes" : [ "http", "https" ], "consumes" : [ "application/json", "application/yaml" ], @@ -10,7 +10,7 @@ "paths" : { "/policy/pap/v1/pdps/groups/batch" : { "post" : { - "tags" : [ "PdpGroupUpdate" ], + "tags" : [ "PdpGroup Create/Update" ], "summary" : "Create or update PDP Groups", "description" : "Create or update one or more PDP Groups, returning optional error details", "operationId" : "createOrUpdateGroups", diff --git a/docs/pap/swagger/pdp-statistics-pap.json b/docs/pap/swagger/pdp-statistics-pap.json new file mode 100644 index 00000000..7b652adb --- /dev/null +++ b/docs/pap/swagger/pdp-statistics-pap.json @@ -0,0 +1,368 @@ +{ + "swagger": "2.0", + "basePath": "/", + "tags": [ + { + "name": "PDP Statistics" + } + ], + "schemes": [ + "http", + "https" + ], + "consumes": [ + "application/json", + "application/yaml" + ], + "produces": [ + "application/json", + "application/yaml" + ], + "paths": { + "/policy/pap/v1/pdps/statistics": { + "get": { + "tags": [ + "PDP Statistics" + ], + "summary": "Fetch statistics for all PDP Groups and subgroups in the system", + "description": "Returns for all PDP Groups and subgroups statistics of the Policy Administration component", + "operationId": "pdpStatistics", + "produces": [ + "application/json", + "application/yaml" + ], + "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": { + "type": "object", + "additionalProperties": { + "type": "object" + } + } + }, + "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/statistics/{group}": { + "get": { + "tags": [ + "PDP Statistics" + ], + "summary": "Fetch current statistics for given PDP Group", + "description": "Returns statistics for given PDP Group of the Policy Administration component", + "operationId": "pdpGroupStatistics", + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "name": "X-ONAP-RequestID", + "in": "header", + "description": "RequestID for http transaction", + "required": false, + "type": "string", + "format": "uuid" + }, + { + "name": "group", + "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": { + "type": "object", + "additionalProperties": { + "type": "object" + } + } + }, + "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/statistics/{group}/{type}": { + "get": { + "tags": [ + "PDP Statistics" + ], + "summary": "Fetch statistics for the specified subgroup", + "description": "Returns statistics for the specified subgroup of the Policy Administration component", + "operationId": "pdpSubGroupStatistics", + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "name": "X-ONAP-RequestID", + "in": "header", + "description": "RequestID for http transaction", + "required": false, + "type": "string", + "format": "uuid" + }, + { + "name": "group", + "in": "path", + "description": "PDP Group Name", + "required": true, + "type": "string" + }, + { + "name": "type", + "in": "path", + "description": "PDP SubGroup type", + "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": { + "type": "object", + "additionalProperties": { + "type": "object" + } + } + }, + "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/statistics/{group}/{type}/{pdp}": { + "get": { + "tags": [ + "PDP Statistics" + ], + "summary": "Fetch statistics for the specified pdp", + "description": "Returns statistics for the specified pdp of the Policy Administration component", + "operationId": "pdpInstanceStatistics", + "produces": [ + "application/json", + "application/yaml" + ], + "parameters": [ + { + "name": "X-ONAP-RequestID", + "in": "header", + "description": "RequestID for http transaction", + "required": false, + "type": "string", + "format": "uuid" + }, + { + "name": "group", + "in": "path", + "description": "PDP Group Name", + "required": true, + "type": "string" + }, + { + "name": "type", + "in": "path", + "description": "PDP SubGroup type", + "required": true, + "type": "string" + }, + { + "name": "pdp", + "in": "path", + "description": "PDP Instance name", + "required": true, + "type": "string" + }, + { + "name": "recordCount", + "in": "query", + "description": "Record Count", + "required": false, + "type": "integer", + "default": 0, + "format": "int32" + } + ], + "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": { + "type": "object", + "additionalProperties": { + "type": "object" + } + } + }, + "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" + } + } +}
\ No newline at end of file diff --git a/docs/pap/swagger/policy-deploy-pap.json b/docs/pap/swagger/policy-deploy-pap.json index a6d49346..0fc1a9e7 100644 --- a/docs/pap/swagger/policy-deploy-pap.json +++ b/docs/pap/swagger/policy-deploy-pap.json @@ -2,7 +2,7 @@ "swagger" : "2.0", "basePath" : "/", "tags" : [ { - "name" : "PdpPolicyDeploy" + "name" : "Deploy Policy" } ], "schemes" : [ "http", "https" ], "consumes" : [ "application/json" ], @@ -10,7 +10,7 @@ "paths" : { "/policy/pap/v1/pdps/policies" : { "post" : { - "tags" : [ "PdpPolicyDeploy" ], + "tags" : [ "Deploy Policy" ], "summary" : "Deploy or update PDP Policies", "description" : "Deploys or updates PDP Policies, returning optional error details", "operationId" : "deployPolicies", diff --git a/docs/pap/swagger/policy-undeploy-pap.json b/docs/pap/swagger/policy-undeploy-pap.json index 4235b04e..7ba66141 100644 --- a/docs/pap/swagger/policy-undeploy-pap.json +++ b/docs/pap/swagger/policy-undeploy-pap.json @@ -2,7 +2,7 @@ "swagger" : "2.0", "basePath" : "/", "tags" : [ { - "name" : "PdpPolicyUndeploy" + "name" : "Undeploy Policy" } ], "schemes" : [ "http", "https" ], "consumes" : [ "application/json" ], @@ -10,7 +10,7 @@ "paths" : { "/policy/pap/v1/pdps/policies/{name}" : { "delete" : { - "tags" : [ "PdpPolicyUndeploy" ], + "tags" : [ "Undeploy Policy" ], "summary" : "Undeploy a PDP Policy from PDPs", "description" : "Undeploys the latest version of a policy from the PDPs, returning optional error details", "operationId" : "deletePolicy", @@ -76,7 +76,7 @@ }, "/policy/pap/v1/pdps/policies/{name}/versions/{version}" : { "delete" : { - "tags" : [ "PdpPolicyUndeploy" ], + "tags" : [ "Undeploy Policy" ], "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", diff --git a/docs/pap/swagger/state-change-pap.json b/docs/pap/swagger/state-change-pap.json index 16ef6360..d5ca9a08 100644 --- a/docs/pap/swagger/state-change-pap.json +++ b/docs/pap/swagger/state-change-pap.json @@ -2,7 +2,7 @@ "swagger" : "2.0", "basePath" : "/", "tags" : [ { - "name" : "PdpGroupStateChange" + "name" : "PdpGroup State Change" } ], "schemes" : [ "http", "https" ], "consumes" : [ "application/json" ], @@ -10,7 +10,7 @@ "paths" : { "/policy/pap/v1/pdps/groups/{name}" : { "put" : { - "tags" : [ "PdpGroupStateChange" ], + "tags" : [ "PdpGroup State Change" ], "summary" : "Change state of a PDP Group", "description" : "Changes state of PDP Group, returning optional error details", "operationId" : "changeGroupState", |