Update ACM rest api page

[policy/parent.git] / docs / pap / swagger / policy-status-pap.json

diff --git a/docs/pap/swagger/policy-status-pap.json b/docs/pap/swagger/policy-status-pap.json
deleted file mode 100644 (file)
index db60220..0000000
--- 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"
-        }
-      }
-    }
-  }
-}