diff options
author | lapentafd <francesco.lapenta@est.tech> | 2023-04-06 11:22:37 +0100 |
---|---|---|
committer | lapentafd <francesco.lapenta@est.tech> | 2023-04-06 14:09:29 +0100 |
commit | fa9ddbfc8ae98ac96b69847c42302e4a384c63f6 (patch) | |
tree | bb9a8b24ec9c7fdc2097aff728fcc805416e2497 /docs/pap | |
parent | 104926d3e3dd1ec55426f398a9442fb5394b1a90 (diff) |
Update ACM rest api page
Unused file cleanup.
Updated docs/clamp/acm/api-protocol/acm-rest-apis.rst
Issue-ID: POLICY-4603
Change-Id: Ie8dd6989139f09b69f95bb42604b1ca8aa596d3c
Signed-off-by: lapentafd <francesco.lapenta@est.tech>
Diffstat (limited to 'docs/pap')
-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 | 150 | ||||
-rw-r--r-- | docs/pap/swagger/group-delete-pap.json | 94 | ||||
-rw-r--r-- | docs/pap/swagger/group-query-pap.json | 210 | ||||
-rw-r--r-- | docs/pap/swagger/groups-batch-pap.json | 215 | ||||
-rw-r--r-- | docs/pap/swagger/health-check-pap.json | 71 | ||||
-rw-r--r-- | docs/pap/swagger/pdp-statistics-pap.json | 455 | ||||
-rw-r--r-- | docs/pap/swagger/policy-audit-pap.json | 489 | ||||
-rw-r--r-- | docs/pap/swagger/policy-deploy-pap.json | 118 | ||||
-rw-r--r-- | docs/pap/swagger/policy-status-pap.json | 411 | ||||
-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 |
14 files changed, 0 insertions, 2994 deletions
diff --git a/docs/pap/swagger/consolidated-healthcheck-pap.json b/docs/pap/swagger/consolidated-healthcheck-pap.json deleted file mode 100644 index 2044bc8a..00000000 --- a/docs/pap/swagger/consolidated-healthcheck-pap.json +++ /dev/null @@ -1,101 +0,0 @@ -{ - "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 deleted file mode 100644 index 09280c7b..00000000 --- a/docs/pap/swagger/deployed-policy-pap.json +++ /dev/null @@ -1,322 +0,0 @@ -{ - "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 deleted file mode 100644 index 768dae99..00000000 --- a/docs/pap/swagger/deployments-batch-pap.json +++ /dev/null @@ -1,150 +0,0 @@ -{ - "swagger" : "2.0", - "basePath" : "/", - "tags" : [ { - "name" : "Deployments Update" - } ], - "schemes" : [ "http", "https" ], - "consumes" : [ "application/json", "application/yaml" ], - "produces" : [ "application/json", "application/yaml" ], - "paths" : { - "/policy/pap/v1/pdps/deployments/batch" : { - "post" : { - "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", - "produces" : [ "application/json", "application/yaml" ], - "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 Deployments", - "required" : true, - "schema" : { - "$ref" : "#/definitions/DeploymentGroups" - } - } ], - "responses" : { - "202" : { - "description" : "operation accepted", - "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" : { - "ToscaPolicyIdentifier" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string" - }, - "version" : { - "type" : "string" - } - } - }, - "PdpGroupDeployResponse" : { - "type" : "object", - "properties" : { - "errorDetails" : { - "type" : "string" - } - } - }, - "DeploymentGroup" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string" - }, - "deploymentSubgroups" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/DeploymentSubGroup" - } - } - } - }, - "DeploymentGroups" : { - "type" : "object", - "properties" : { - "groups" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/DeploymentGroup" - } - } - } - }, - "DeploymentSubGroup" : { - "type" : "object", - "properties" : { - "pdpType" : { - "type" : "string" - }, - "action" : { - "type" : "string", - "enum" : [ "POST", "DELETE", "PATCH" ] - }, - "policies" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/ToscaPolicyIdentifier" - } - } - } - } - } -} diff --git a/docs/pap/swagger/group-delete-pap.json b/docs/pap/swagger/group-delete-pap.json deleted file mode 100644 index 4b5c217c..00000000 --- a/docs/pap/swagger/group-delete-pap.json +++ /dev/null @@ -1,94 +0,0 @@ -{ - "swagger" : "2.0", - "basePath" : "/", - "tags" : [ { - "name" : "PdpGroup Delete" - } ], - "schemes" : [ "http", "https" ], - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "paths" : { - "/policy/pap/v1/pdps/groups/{name}" : { - "delete" : { - "tags" : [ "PdpGroup Delete" ], - "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-query-pap.json b/docs/pap/swagger/group-query-pap.json deleted file mode 100644 index b31515c8..00000000 --- a/docs/pap/swagger/group-query-pap.json +++ /dev/null @@ -1,210 +0,0 @@ -{ - "swagger" : "2.0", - "basePath" : "/", - "tags" : [ { - "name" : "PdpGroup Query" - } ], - "schemes" : [ "http", "https" ], - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "paths" : { - "/policy/pap/v1/pdps" : { - "get" : { - "tags" : [ "PdpGroup Query" ], - "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/groups-batch-pap.json b/docs/pap/swagger/groups-batch-pap.json deleted file mode 100644 index 2d02e998..00000000 --- a/docs/pap/swagger/groups-batch-pap.json +++ /dev/null @@ -1,215 +0,0 @@ -{ - "swagger" : "2.0", - "basePath" : "/", - "tags" : [ { - "name" : "PdpGroup Create/Update" - } ], - "schemes" : [ "http", "https" ], - "consumes" : [ "application/json", "application/yaml" ], - "produces" : [ "application/json", "application/yaml" ], - "paths" : { - "/policy/pap/v1/pdps/groups/batch" : { - "post" : { - "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", - "produces" : [ "application/json", "application/yaml" ], - "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/PdpGroupUpdateResponse" - } - }, - "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" : { - "PdpGroupUpdateResponse" : { - "type" : "object", - "properties" : { - "errorDetails" : { - "type" : "string" - } - } - }, - "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" - } - } - } - } -}
\ No newline at end of file diff --git a/docs/pap/swagger/health-check-pap.json b/docs/pap/swagger/health-check-pap.json deleted file mode 100644 index 3bf87e22..00000000 --- a/docs/pap/swagger/health-check-pap.json +++ /dev/null @@ -1,71 +0,0 @@ -{ - "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/pdp-statistics-pap.json b/docs/pap/swagger/pdp-statistics-pap.json deleted file mode 100644 index c2c7b4ce..00000000 --- a/docs/pap/swagger/pdp-statistics-pap.json +++ /dev/null @@ -1,455 +0,0 @@ -{ - "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" - }, - { - "name": "recordCount", - "in": "query", - "description": "Record count between 1-100", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "startTime", - "in": "query", - "description": "Start time in epoch timestamp", - "required": false, - "type": "integer", - "format": "int64" - }, - { - "name": "endTime", - "in": "query", - "description": "End time in epoch timestamp", - "required": false, - "type": "integer", - "format": "int64" - } - ], - "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" - }, - { - "name": "recordCount", - "in": "query", - "description": "Record count between 1-100", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "startTime", - "in": "query", - "description": "Start time in epoch timestamp", - "required": false, - "type": "integer", - "format": "int64" - }, - { - "name": "endTime", - "in": "query", - "description": "End time in epoch timestamp", - "required": false, - "type": "integer", - "format": "int64" - } - ], - "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" - }, - { - "name": "recordCount", - "in": "query", - "description": "Record count between 1-100", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "startTime", - "in": "query", - "description": "Start time in epoch timestamp", - "required": false, - "type": "integer", - "format": "int64" - }, - { - "name": "endTime", - "in": "query", - "description": "End time in epoch timestamp", - "required": false, - "type": "integer", - "format": "int64" - } - ], - "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 between 1-100", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "startTime", - "in": "query", - "description": "Start time in epoch timestamp", - "required": false, - "type": "integer", - "format": "int64" - }, - { - "name": "endTime", - "in": "query", - "description": "End time in epoch timestamp", - "required": false, - "type": "integer", - "format": "int64" - } - ], - "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-audit-pap.json b/docs/pap/swagger/policy-audit-pap.json deleted file mode 100644 index 1fd92311..00000000 --- a/docs/pap/swagger/policy-audit-pap.json +++ /dev/null @@ -1,489 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "The APIs listed here are used to fetch audit information for various actions taken on policies.", - "version": "v1" - }, - "basePath": "/", - "tags": [ - { - "name": "Policy Audit" - } - ], - "schemes": [ - "http", - "https" - ], - "consumes": [ - "application/json", - "application/yaml" - ], - "produces": [ - "application/json", - "application/yaml" - ], - "paths": { - "/policy/pap/v1/policies/audit": { - "get": { - "tags": [ - "Policy Audit" - ], - "summary": "Queries audit information for all the policies", - "description": "Queries audit information for all the policies, returning audit information for all the policies in the database", - "operationId": "getAllAuditRecords", - "produces": [ - "application/json", - "application/yaml" - ], - "parameters": [ - { - "name": "X-ONAP-RequestID", - "in": "header", - "description": "RequestID for http transaction", - "required": false, - "type": "string", - "format": "uuid" - }, - { - "name": "recordCount", - "in": "query", - "description": "Record count between 1-100", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "startTime", - "in": "query", - "description": "Start time in epoch timestamp", - "required": false, - "type": "integer", - "format": "int64" - }, - { - "name": "endTime", - "in": "query", - "description": "End time in epoch timestamp", - "required": false, - "type": "integer", - "format": "int64" - } - ], - "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/PolicyAudit" - } - } - }, - "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/audit/{pdpGroupName}": { - "get": { - "tags": [ - "Policy Audit" - ], - "summary": "Queries audit information for all the policies in a PdpGroup", - "description": "Queries audit information for all the policies in a PdpGroup, returning audit information for all the policies belonging to the PdpGroup", - "operationId": "getAuditRecordsByGroup", - "produces": [ - "application/json", - "application/yaml" - ], - "parameters": [ - { - "name": "X-ONAP-RequestID", - "in": "header", - "description": "RequestID for http transaction", - "required": false, - "type": "string", - "format": "uuid" - }, - { - "name": "recordCount", - "in": "query", - "description": "Record count between 1-100", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "startTime", - "in": "query", - "description": "Start time in epoch timestamp", - "required": false, - "type": "integer", - "format": "int64" - }, - { - "name": "endTime", - "in": "query", - "description": "End time in epoch timestamp", - "required": false, - "type": "integer", - "format": "int64" - }, - { - "name": "pdpGroupName", - "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": "array", - "items": { - "$ref": "#/definitions/PolicyAudit" - } - } - }, - "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/audit/{policyName}/{policyVersion}": { - "get": { - "tags": [ - "Policy Audit" - ], - "summary": "Queries audit information for a specific version of a policy", - "description": "Queries audit information for a specific version of a policy, returning audit information for the policy", - "operationId": "getAuditRecordsOfPolicy", - "produces": [ - "application/json", - "application/yaml" - ], - "parameters": [ - { - "name": "X-ONAP-RequestID", - "in": "header", - "description": "RequestID for http transaction", - "required": false, - "type": "string", - "format": "uuid" - }, - { - "name": "recordCount", - "in": "query", - "description": "Record count between 1-100", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "startTime", - "in": "query", - "description": "Start time in epoch timestamp", - "required": false, - "type": "integer", - "format": "int64" - }, - { - "name": "endTime", - "in": "query", - "description": "End time in epoch timestamp", - "required": false, - "type": "integer", - "format": "int64" - }, - { - "name": "policyName", - "in": "path", - "description": "Policy Name", - "required": true, - "type": "string" - }, - { - "name": "policyVersion", - "in": "path", - "description": "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/PolicyAudit" - } - }, - "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/audit/{pdpGroupName}/{policyName}/{policyVersion}": { - "get": { - "tags": [ - "Policy Audit" - ], - "summary": "Queries audit information for a specific version of a policy in a PdpGroup", - "description": "Queries audit information for a specific version of a policy in a PdpGroup, returning audit information for the policy belonging to the PdpGroup", - "operationId": "getAuditRecordsOfPolicy_1", - "produces": [ - "application/json", - "application/yaml" - ], - "parameters": [ - { - "name": "X-ONAP-RequestID", - "in": "header", - "description": "RequestID for http transaction", - "required": false, - "type": "string", - "format": "uuid" - }, - { - "name": "recordCount", - "in": "query", - "description": "Record count between 1-100", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "startTime", - "in": "query", - "description": "Start time in epoch timestamp", - "required": false, - "type": "integer", - "format": "int64" - }, - { - "name": "endTime", - "in": "query", - "description": "End time in epoch timestamp", - "required": false, - "type": "integer", - "format": "int64" - }, - { - "name": "pdpGroupName", - "in": "path", - "description": "PDP Group Name", - "required": true, - "type": "string" - }, - { - "name": "policyName", - "in": "path", - "description": "Policy Name", - "required": true, - "type": "string" - }, - { - "name": "policyVersion", - "in": "path", - "description": "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/PolicyAudit" - } - }, - "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": { - "PolicyAudit": { - "type": "object", - "properties": { - "pdpGroup": { - "type": "string" - }, - "pdpType": { - "type": "string" - }, - "policy": { - "$ref": "#/definitions/ToscaConceptIdentifier" - }, - "action": { - "type": "string" - }, - "timestamp": { - "type": "string" - }, - "user": { - "type": "string" - } - } - }, - "ToscaConceptIdentifier": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "version": { - "type": "string" - } - } - } - } -} diff --git a/docs/pap/swagger/policy-deploy-pap.json b/docs/pap/swagger/policy-deploy-pap.json deleted file mode 100644 index d003af85..00000000 --- a/docs/pap/swagger/policy-deploy-pap.json +++ /dev/null @@ -1,118 +0,0 @@ -{ - "swagger" : "2.0", - "basePath" : "/", - "tags" : [ { - "name" : "Deploy Policy" - } ], - "schemes" : [ "http", "https" ], - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "paths" : { - "/policy/pap/v1/pdps/policies" : { - "post" : { - "tags" : [ "Deploy Policy" ], - "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" : { - "202" : { - "description" : "operation accepted", - "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-status-pap.json b/docs/pap/swagger/policy-status-pap.json deleted file mode 100644 index db60220c..00000000 --- a/docs/pap/swagger/policy-status-pap.json +++ /dev/null @@ -1,411 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "The APIs listed here are used to fetch status of policies in PdpGroups", - "version": "v1" - }, - "basePath": "/", - "tags": [ - { - "name": "Policy Status" - } - ], - "schemes": [ - "http", - "https" - ], - "consumes": [ - "application/json", - "application/yaml" - ], - "produces": [ - "application/json", - "application/yaml" - ], - "paths": { - "/policy/pap/v1/policies/status": { - "get": { - "tags": [ - "Policy Status" - ], - "summary": "Queries status of policies in all PdpGroups", - "description": "Queries status of policies in all PdpGroups, returning status of policies in all the PDPs belonging to all PdpGroups", - "operationId": "queryAllPolicies", - "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/PdpPolicyStatus" - } - } - }, - "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": "Honolulu" - } - } - }, - "/policy/pap/v1/policies/status/{pdpGroupName}": { - "get": { - "tags": [ - "Policy Status" - ], - "summary": "Queries status of policies in a specific PdpGroup", - "description": "Queries status of policies in a specific PdpGroup, returning status of policies in all the PDPs belonging to the PdpGroup", - "operationId": "queryAllPoliciesInPdpGroup", - "produces": [ - "application/json", - "application/yaml" - ], - "parameters": [ - { - "name": "pdpGroupName", - "in": "path", - "description": "Name of the PdpGroup", - "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/PdpPolicyStatus" - } - } - }, - "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": "Honolulu" - } - } - }, - "/policy/pap/v1/policies/status/{pdpGroupName}/{policyName}": { - "get": { - "tags": [ - "Policy Status" - ], - "summary": "Queries status of all versions of a specific policy in a specific PdpGroup", - "description": "Queries status of all versions of a specific policy in a specific PdpGroup, returning status of all versions of the policy in the PDPs belonging to the PdpGroup", - "operationId": "queryAllVersionPolicy", - "produces": [ - "application/json", - "application/yaml" - ], - "parameters": [ - { - "name": "pdpGroupName", - "in": "path", - "description": "Name of the PdpGroup", - "required": true, - "type": "string" - }, - { - "name": "policyName", - "in": "path", - "description": "Name of the 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", - "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/PdpPolicyStatus" - } - } - }, - "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": "Honolulu" - } - } - }, - "/policy/pap/v1/policies/status/{pdpGroupName}/{policyName}/{policyVersion}": { - "get": { - "tags": [ - "Policy Status" - ], - "summary": "Queries status of a specific version of a specific policy in a specific PdpGroup", - "description": "Queries status of a specific version of a specific policy in a specific PdpGroup, returning status of the policy in the PDPs belonging to the PdpGroup", - "operationId": "querySpecificVersionPolicy", - "produces": [ - "application/json", - "application/yaml" - ], - "parameters": [ - { - "name": "pdpGroupName", - "in": "path", - "description": "Name of the PdpGroup", - "required": true, - "type": "string" - }, - { - "name": "policyName", - "in": "path", - "description": "Name of the Policy", - "required": true, - "type": "string" - }, - { - "name": "policyVersion", - "in": "path", - "description": "Version of the 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", - "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/PdpPolicyStatus" - } - } - }, - "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": "Honolulu" - } - } - } - }, - "securityDefinitions": { - "basicAuth": { - "description": "", - "type": "basic" - } - }, - "definitions": { - "PdpPolicyStatus": { - "type": "object", - "properties": { - "pdpGroup": { - "type": "string" - }, - "pdpType": { - "type": "string" - }, - "pdpId": { - "type": "string" - }, - "policy": { - "$ref": "#/definitions/ToscaConceptIdentifier" - }, - "policyType": { - "$ref": "#/definitions/ToscaConceptIdentifier" - }, - "deploy": { - "type": "boolean" - }, - "state": { - "type": "string" - } - } - }, - "ToscaConceptIdentifier": { - "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 deleted file mode 100644 index de793668..00000000 --- a/docs/pap/swagger/policy-undeploy-pap.json +++ /dev/null @@ -1,166 +0,0 @@ -{ - "swagger" : "2.0", - "basePath" : "/", - "tags" : [ { - "name" : "Undeploy Policy" - } ], - "schemes" : [ "http", "https" ], - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "paths" : { - "/policy/pap/v1/pdps/policies/{name}" : { - "delete" : { - "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", - "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" : { - "202" : { - "description" : "operation accepted", - "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" : [ "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", - "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" : { - "202" : { - "description" : "operation accepted", - "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 deleted file mode 100644 index d5ca9a08..00000000 --- a/docs/pap/swagger/state-change-pap.json +++ /dev/null @@ -1,101 +0,0 @@ -{ - "swagger" : "2.0", - "basePath" : "/", - "tags" : [ { - "name" : "PdpGroup State Change" - } ], - "schemes" : [ "http", "https" ], - "consumes" : [ "application/json" ], - "produces" : [ "application/json" ], - "paths" : { - "/policy/pap/v1/pdps/groups/{name}" : { - "put" : { - "tags" : [ "PdpGroup State Change" ], - "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 deleted file mode 100644 index 390fe1a0..00000000 --- a/docs/pap/swagger/statistics-pap.json +++ /dev/null @@ -1,91 +0,0 @@ -{ - "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" - } - } - } - } -} |