{
  "opencollection": "1.0.0",
  "info": {
    "name": "WSO2 API Manager - Admin Advanced Policy (Collection) Advanced Policy (Collection) API Documents API",
    "version": "v4"
  },
  "items": [
    {
      "info": {
        "name": "API Documents",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get a List of Documents of an API\n",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://apis.wso2.com/api/am/admin/v4/apis/:apiId/documents",
            "headers": [
              {
                "name": "X-WSO2-Tenant",
                "value": ""
              },
              {
                "name": "If-None-Match",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "apiId",
                "value": "",
                "type": "path",
                "description": "**API ID** consisting of the **UUID** of the API.\n"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum size of resource array to return.\n"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Starting point within the complete list of items qualified.\n"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "resource_owner_password_credentials",
              "accessTokenUrl": "https://localhost:9443/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "This operation can be used to retrive a list of documents belonging to an API by providing the id of the API.\n\n`X-WSO2-Tenant` header can be used to retrive documents of an API that belongs to a different tenant domain. If not specified super tenant will be used. If Authorization header is present in the request, the user's tenant associated with the access token will be used.\n\n**NOTE:**\n* This operation does not require an Authorization header by default. But in order to see a restricted API's "
        },
        {
          "info": {
            "name": "Get a Document of an API\n",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://apis.wso2.com/api/am/admin/v4/apis/:apiId/documents/:documentId",
            "headers": [
              {
                "name": "X-WSO2-Tenant",
                "value": ""
              },
              {
                "name": "If-None-Match",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "apiId",
                "value": "",
                "type": "path",
                "description": "**API ID** consisting of the **UUID** of the API.\n"
              },
              {
                "name": "documentId",
                "value": "",
                "type": "path",
                "description": "Document Identifier\n"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "resource_owner_password_credentials",
              "accessTokenUrl": "https://localhost:9443/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "This operation can be used to retrieve a particular document's metadata associated with an API.\n\n`X-WSO2-Tenant` header can be used to retrive a document of an API that belongs to a different tenant domain. If not specified super tenant will be used. If Authorization header is present in the request, the user's tenant associated with the access token will be used.\n\n**NOTE:**\n* This operation does not require an Authorization header by default. But in order to see a restricted API's document, you"
        },
        {
          "info": {
            "name": "Get the Content of an API Document\n",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://apis.wso2.com/api/am/admin/v4/apis/:apiId/documents/:documentId/content",
            "headers": [
              {
                "name": "X-WSO2-Tenant",
                "value": ""
              },
              {
                "name": "If-None-Match",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "apiId",
                "value": "",
                "type": "path",
                "description": "**API ID** consisting of the **UUID** of the API.\n"
              },
              {
                "name": "documentId",
                "value": "",
                "type": "path",
                "description": "Document Identifier\n"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "resource_owner_password_credentials",
              "accessTokenUrl": "https://localhost:9443/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "This operation can be used to retrive the content of an API's document.\n\nThe document can be of 3 types. In each cases responses are different.\n\n1. **Inline type**:\n   The content of the document will be retrieved in `text/plain` content type\n2. **FILE type**:\n   The file will be downloaded with the related content type (eg. `application/pdf`)\n3. **URL type**:\n    The client will recieve the URL of the document as the Location header with the response with - `303 See Other`\n\n`X-WSO2-Tenant` head"
        }
      ]
    }
  ],
  "bundled": true
}