Managing API operations
Learn how to mark an OpenAPI API operation as experimental, deprecated or hide it from your documentation.
Last updated
Was this helpful?
Learn how to mark an OpenAPI API operation as experimental, deprecated or hide it from your documentation.
Last updated
Was this helpful?
It’s common to have operations that are not fully stable yet or that need to be phased out. GitBook supports several OpenAPI extensions to help you manage these scenarios.
Use x-stability to communicate that an endpoint is unstable or in progress. It helps users avoid non-production-ready endpoints. Supported values: experimental, alpha, beta.
To mark an operation as deprecated, add the deprecated: true attribute:
Optionally specify when support ends by including x-deprecated-sunset:
To hide an operation from your API reference, add x-internal: true or x-gitbook-ignore: true attribute.
We’re currently improving how you build API documentation in GitBook. This page covers features that are being gradually rolled out. If you don’t see them yet, hang tight—they’re on the way!