redocly.github.io

{
  "name": "list_api_operations",
  "kind": "answer",
  "impl": "imperative",
  "description": "List the operations of the API documented on this page, with their method, path and documentation URL. Optionally filter by a keyword.",
  "inputSchema": {
    "type": "object",
    "properties": {
      "query": {
        "type": "string",
        "description": "Keyword to filter by summary, path or method"
      },
      "limit": {
        "type": "integer",
        "description": "Maximum number of operations, 100 by default"
      }
    },
    "additionalProperties": false
  },
  "page": "/redoc"
}

{
  "name": "get_api_operation",
  "kind": "answer",
  "impl": "imperative",
  "description": "Return the full reference for one operation of the API on this page: parameters, request body, responses and examples. Identify it by method and path, or by its documentation URL.",
  "inputSchema": {
    "type": "object",
    "properties": {
      "method": {
        "type": "string",
        "description": "HTTP method, for example GET"
      },
      "path": {
        "type": "string",
        "description": "Operation path, for example /museum-hours"
      },
      "url": {
        "type": "string",
        "description": "Documentation URL of the operation"
      }
    },
    "additionalProperties": false
  },
  "page": "/redoc"
}

{
  "name": "get_api_authentication",
  "kind": "answer",
  "impl": "imperative",
  "description": "Return the servers and authentication schemes of the API on this page: scheme types, OAuth flows and scopes. Credentials are never included.",
  "inputSchema": {
    "type": "object",
    "properties": {},
    "additionalProperties": false
  },
  "page": "/redoc"
}