OpenAPI · Schema
OpenAPI Parameter Object
Describes a single operation parameter. A unique parameter is defined by a combination of a name and location.
DocumentationRESTSpecification
Properties
| Name | Type | Description |
|---|---|---|
| name | string | The name of the parameter. |
| in | string | The location of the parameter. |
| description | string | A brief description of the parameter. |
| required | boolean | Whether this parameter is mandatory. |
| deprecated | boolean | Whether the parameter is deprecated. |
| allowEmptyValue | boolean | Whether empty-valued parameters are allowed. |
| style | string | How the parameter value will be serialized. |
| explode | boolean | Whether parameter values of type array or object generate separate parameters. |
| allowReserved | boolean | Whether the parameter value allows reserved characters. |
| schema | object | The schema defining the type used for the parameter. |
| example | object | Example of the parameter value. |
| examples | object | Examples of the parameter value. |
| content | object | A map containing the representations for the parameter. |
JSON Schema
{
"$id": "openapi-parameter.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "OpenAPI Parameter Object",
"description": "Describes a single operation parameter. A unique parameter is defined by a combination of a name and location.",
"type": "object",
"required": [
"name",
"in"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the parameter."
},
"in": {
"type": "string",
"description": "The location of the parameter.",
"enum": [
"query",
"header",
"path",
"cookie"
]
},
"description": {
"type": "string",
"description": "A brief description of the parameter."
},
"required": {
"type": "boolean",
"description": "Whether this parameter is mandatory.",
"default": false
},
"deprecated": {
"type": "boolean",
"description": "Whether the parameter is deprecated.",
"default": false
},
"allowEmptyValue": {
"type": "boolean",
"description": "Whether empty-valued parameters are allowed.",
"default": false
},
"style": {
"type": "string",
"description": "How the parameter value will be serialized."
},
"explode": {
"type": "boolean",
"description": "Whether parameter values of type array or object generate separate parameters."
},
"allowReserved": {
"type": "boolean",
"description": "Whether the parameter value allows reserved characters.",
"default": false
},
"schema": {
"description": "The schema defining the type used for the parameter."
},
"example": {
"description": "Example of the parameter value."
},
"examples": {
"type": "object",
"description": "Examples of the parameter value.",
"additionalProperties": {
"$ref": "openapi-example.json"
}
},
"content": {
"type": "object",
"description": "A map containing the representations for the parameter.",
"maxProperties": 1,
"additionalProperties": {
"$ref": "openapi-media-type.json"
}
}
},
"patternProperties": {
"^x-": {}
},
"additionalProperties": false
}
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.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/openapi-parameter"
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 form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.