Swagger · Schema

OpenAPI Operation Object

Schema for an OpenAPI Operation Object describing a single API operation on a path.

API DesignDocumentationOpen-SourceOpenAPIRESTStandardSwagger

Properties

Name Type Description
tags array List of tags for organizing operations in API documentation.
summary string A short summary of what the operation does. Should use Title Case.
description string A detailed description of the operation. CommonMark markdown supported.
externalDocs object Additional external documentation for this operation.
operationId string Unique identifier for the operation, used for code generation.
parameters array List of parameters applicable to this operation.
requestBody object
responses object Map of HTTP status codes to response objects.
deprecated boolean Marks the operation as deprecated.
security array Security requirements for this operation (overrides global security).
View JSON Schema on GitHub

JSON Schema

openapi-operation-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/swagger/json-schema/openapi-operation-schema.json",
  "title": "OpenAPI Operation Object",
  "description": "Schema for an OpenAPI Operation Object describing a single API operation on a path.",
  "type": "object",
  "properties": {
    "tags": {
      "type": "array",
      "items": { "type": "string" },
      "description": "List of tags for organizing operations in API documentation."
    },
    "summary": {
      "type": "string",
      "description": "A short summary of what the operation does. Should use Title Case."
    },
    "description": {
      "type": "string",
      "description": "A detailed description of the operation. CommonMark markdown supported."
    },
    "externalDocs": {
      "type": "object",
      "description": "Additional external documentation for this operation."
    },
    "operationId": {
      "type": "string",
      "description": "Unique identifier for the operation, used for code generation."
    },
    "parameters": {
      "type": "array",
      "description": "List of parameters applicable to this operation.",
      "items": {
        "$ref": "#/$defs/Parameter"
      }
    },
    "requestBody": {
      "$ref": "#/$defs/RequestBody"
    },
    "responses": {
      "type": "object",
      "description": "Map of HTTP status codes to response objects.",
      "additionalProperties": {
        "$ref": "#/$defs/Response"
      }
    },
    "deprecated": {
      "type": "boolean",
      "description": "Marks the operation as deprecated."
    },
    "security": {
      "type": "array",
      "description": "Security requirements for this operation (overrides global security)."
    }
  },
  "required": ["responses"],
  "$defs": {
    "Parameter": {
      "type": "object",
      "description": "An OpenAPI parameter definition.",
      "required": ["name", "in"],
      "properties": {
        "name": { "type": "string" },
        "in": {
          "type": "string",
          "enum": ["query", "header", "path", "cookie"]
        },
        "description": { "type": "string" },
        "required": { "type": "boolean" },
        "deprecated": { "type": "boolean" },
        "schema": { "type": "object" }
      }
    },
    "RequestBody": {
      "type": "object",
      "description": "The request body of an operation.",
      "required": ["content"],
      "properties": {
        "description": { "type": "string" },
        "content": {
          "type": "object",
          "description": "Map of media types to media type objects."
        },
        "required": { "type": "boolean", "default": false }
      }
    },
    "Response": {
      "type": "object",
      "description": "A response object for a specific HTTP status code.",
      "required": ["description"],
      "properties": {
        "description": { "type": "string" },
        "headers": { "type": "object" },
        "content": { "type": "object" },
        "links": { "type": "object" }
      }
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/openapi-operation"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.