OpenAPI Deprecation Builder
OpenAPI Deprecation Builder: Appends `deprecated: true` property to operation object and injects Sunset HTTP header documentation.
About this openapi deprecation builder
OpenAPI Deprecation Builder — browser-based utility.
How this tool works
Sets deprecated true on one selected operation and appends a fixed migration sentence to its description before serializing YAML. It does not add a Sunset header or identify a replacement endpoint.
- Contract Ingestion & Format Parsing: Reads OpenAPI YAML or JSON contracts, parsing the top-level info, servers, paths, and components blocks.
- Schema Dereferencing & Graph Resolution: Resolves internal and external $ref pointers using per-path visited sets to prevent false circular recursion alarms.
- Protocol Mapping & MCP Transformation: Maps HTTP operations, path parameters, and requestBodies into MCP tool declarations with JSON Schema input schemas.
- Validation & Export: Emits valid MCP manifests or client interfaces ready for Claude, Gemini, or ChatGPT integration.
Worked example
Scenario: An API architect marks an obsolete endpoint as deprecated in an OpenAPI 3.0 document.
Sample input:
Processing: Appends `deprecated: true` property to operation object and injects Sunset HTTP header documentation.
Illustrative output:
Limits and verification
Requires specifications to contain required OpenAPI root keys ('openapi', 'info', 'paths'). Handles deep schema recursion by truncating self-referential children with a safe guard marker. Flags invalid YAML indentation with line numbers.
Examples demonstrate an expected workflow; they do not prove every input or every branch of an external specification. Check important results with an independent source before using them for money, security, compliance, safety, or irreversible file changes.
Browser processing boundary
Tool input is processed by code running in the browser and is not intentionally sent to a CZOA processing API. The page can still request ordinary site assets, analytics, or advertising when those services are enabled. Browser extensions and managed-device software remain outside this tool's control.
Relevant references
These references govern or help explain the format, protocol, or calculation used here. Listing a reference does not claim certification or complete implementation of every optional feature.
Content owner: CZOA Tools · Last reviewed: 2026-09-15 · Review methodology
How to use it
- Enter, paste, or select your input data into the OpenAPI Deprecation Builder workspace controls.
- Review available parameter fields, units, formats, or options configured for your task.
- Click the action button or observe immediate live calculations rendered in your browser runtime.
- Inspect the resulting output and any diagnostic messages, then copy or download the result if needed.
Frequently asked questions
How does OpenAPI Deprecation Builder mark an operation?+
It selects a path and HTTP method, sets that operation deprecated to true, and appends a migration-before-removal notice to its description before emitting YAML.
What did the deprecation fixture verify?+
A GET operation at /pets was serialized with deprecated true and the replacement-before-removal notice.
Does it remove or redirect an API endpoint?+
No. It edits an OpenAPI description only; deployments, gateway routing, version negotiation, client notices, and runtime responses remain outside the tool.
What happens when the selected operation is absent?+
It throws Operation was not found in the OpenAPI document rather than silently marking a different operation.