OpenAPI Operation Inventory
Extract a bounded agent planning inventory of methods, templates, parameters, media types, response codes, and effective security declarations from OpenAPI 3.1.x. Reports lint coverage and unresolved references; does not call endpoints or resolve schemas.
api-assurance · Operation ID: openapi-operation-inventory
Choose this operation when
- Plan which API operations and authentication schemes an agent needs
- Audit operation coverage before client generation
Outside this profile
- Discovering live endpoint availability
- Resolving referenced parameters or testing credentials
Exact release references
Static JSON contract · Markdown reference · Fixed example response
Complete input schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"document": {
"$ref": "#/$defs/__schema0"
}
},
"required": [
"document"
],
"additionalProperties": false,
"$defs": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
]
}
}
}
Complete output-envelope schema
{
"type": "object",
"required": [
"operation",
"version",
"result",
"provenance"
],
"properties": {
"operation": {
"const": "openapi-operation-inventory",
"type": "string"
},
"version": {
"const": "0.29.0",
"type": "string"
},
"result": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"profile": {
"type": "string",
"const": "openapi-3.1-operation-inventory-v1"
},
"operations": {
"maxItems": 200,
"type": "array",
"items": {
"type": "object",
"properties": {
"method": {
"type": "string",
"enum": [
"get",
"put",
"post",
"delete",
"options",
"head",
"patch",
"trace"
]
},
"path": {
"type": "string"
},
"operationId": {
"type": [
"string",
"null"
]
},
"summary": {
"type": "string"
},
"parameters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"required": {
"type": "boolean"
},
"hasReference": {
"type": "boolean"
}
},
"required": [
"name",
"location",
"required",
"hasReference"
],
"additionalProperties": false
}
},
"requestMediaTypes": {
"type": "array",
"items": {
"type": "string"
}
},
"responseCodes": {
"type": "array",
"items": {
"type": "string"
}
},
"securitySchemes": {
"type": "array",
"items": {
"type": "string"
}
},
"anonymousAllowed": {
"type": "boolean"
},
"securitySource": {
"type": "string",
"enum": [
"operation",
"document",
"absent"
]
}
},
"required": [
"method",
"path",
"operationId",
"summary",
"parameters",
"requestMediaTypes",
"responseCodes",
"securitySchemes",
"anonymousAllowed",
"securitySource"
],
"additionalProperties": false
}
},
"findings": {
"maxItems": 200,
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"severity": {
"type": "string",
"enum": [
"error",
"warning",
"unsupported"
]
},
"path": {
"type": "string"
},
"message": {
"type": "string"
},
"suggestion": {
"type": "string"
}
},
"required": [
"code",
"severity",
"path",
"message",
"suggestion"
],
"additionalProperties": false
}
},
"findingCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"truncated": {
"type": "boolean"
}
},
"required": [
"profile",
"operations",
"findings",
"findingCount",
"truncated"
],
"additionalProperties": false
},
"provenance": {
"type": "object",
"required": [
"inputSha256",
"outputSha256",
"deterministic",
"externalRequests"
],
"properties": {
"inputSha256": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"outputSha256": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"deterministic": {
"const": true
},
"externalRequests": {
"const": 0
}
}
}
},
"additionalProperties": false
}
Fixed example
One accepted fixed example, not a custom-input trial. No operation runs when this static page is requested.
Example input
{
"document": {
"openapi": "3.1.0",
"info": {
"title": "Orders",
"version": "1.0.0"
},
"paths": {
"/orders/{id}": {
"get": {
"operationId": "getOrder",
"summary": "Read one order",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 1
}
}
],
"responses": {
"200": {
"description": "Order"
}
}
}
}
}
}
}
Example response
{
"operation": "openapi-operation-inventory",
"version": "0.29.0",
"result": {
"profile": "openapi-3.1-operation-inventory-v1",
"operations": [
{
"method": "get",
"path": "/orders/{id}",
"operationId": "getOrder",
"summary": "Read one order",
"parameters": [
{
"name": "id",
"location": "path",
"required": true,
"hasReference": false
}
],
"requestMediaTypes": [],
"responseCodes": [
"200"
],
"securitySchemes": [],
"anonymousAllowed": true,
"securitySource": "absent"
}
],
"findings": [],
"findingCount": 0,
"truncated": false
},
"provenance": {
"inputSha256": "36ca6a850c156b929adea6a02d38f21cd8a9b62818414af00e4207e5d5912c42",
"outputSha256": "4b89429d94aa232b3f033c4f56e436e180e8f5b2260005c47845ca678f47e922",
"deterministic": true,
"externalRequests": 0
}
}
Bounds and precision
JavaScript IEEE-754 numbers; use strings for large integer IDs/exact decimals where the schema accepts strings. No lossless numeric parsing.
{
"global": {
"requestBytes": 131072,
"responseBytes": 524288,
"jsonDepth": 32,
"jsonNodes": 20000,
"requestsPerMinute": 60,
"paidAttemptsPerMinute": 20,
"idempotencyHours": 24
},
"operation": {
"inputBytes": 110000,
"jsonNodes": 10000,
"depth": 24,
"paths": 100,
"operations": 200,
"effectiveParameters": 100,
"findings": 200,
"outputBytes": 450000,
"jsonPointerCharacters": 4096
}
}
Complete schemas, descriptions and cross-field validation may impose additional limits.
Proposed price and protocol definitions
{
"unit": "one successful operation call",
"proposedNominalUsd": "0.01",
"sixDecimalTokenBaseUnits": "10000",
"subscription": false,
"includesPayerWalletOrNetworkFees": false,
"liveQuoteVerified": false,
"condition": "Actual SDK challenge is authoritative only within the caller's explicit authorization; configured six-decimal token peg is an operator assertion, not a conversion guarantee."
}
Protocol definitions: x402, mpp. MPP uses Tempo charge. Paid MCP execution is unsupported. All runtime readiness is not evaluated in this build.
API path templates, not endpoints on this documentation host
{
"x402": "/v1/x402/openapi-operation-inventory",
"mpp": "/v1/mpp/openapi-operation-inventory"
}
Required headers
{
"Content-Type": "application/json",
"Idempotency-Key": "random 16–128 character operation identifier"
}
Actual SDK challenge amount, asset, network, recipient and wallet costs must pass independent authorization. Preserve identical key, body, protocol and credential on retries; on PAYMENT_UNCERTAIN stop and reconcile.
Execution profile and provider conditions
{
"deterministic": true,
"externalRequests": 0,
"maxExternalRequests": 0,
"resultSnapshotPersisted": false,
"fixedExampleIsIllustrativeSnapshot": false,
"requiresPayment": true,
"supportsMcpExecution": false
}
Deterministic supplied-input operation with no external requests or stored request/result bodies. Payment infrastructure retains payment metadata and hashes.
Failure handling
- HTTP 400: Malformed JSON, missing/invalid idempotency key, or payment identifier mismatch Correct the request before payment
- HTTP 402: Payment challenge or rejected payment Use official protocol SDK; inspect payment outcome before another payment
- HTTP 409: Idempotency conflict, duplicate proof, or PAYMENT_UNCERTAIN Keep original key, body, and proof; reconcile uncertainty with operator; never blindly repay
- HTTP 413: Input or generated output too large Reduce input; no payment attempted for validation failure
- HTTP 415: Unsupported media type or compression Send uncompressed application/json
- HTTP 422: Schema or service-specific semantic validation failure Correct input using returned error code; no payment attempted
- HTTP 429: Request/payment-attempt rate exceeded Wait for rate limit window; preserve existing payment identity
- HTTP 503: Payment configuration/provider/state unavailable, or live DNS preparation failed before settlement Check readiness; DNS preparation failures may retry the identical key/body/credential only; uncertainty requires reconciliation
Declared requirements
Before any paid call, refresh the live operation contract and POST the complete bounded budgeted plan to the separate API's /preflight. Unknown requirements block selection; compatible preflight is not permission to spend.