Mark deprecated API operations with deprecated: true - #17
Open
BPKelley wants to merge 1 commit into
Open
Conversation
Adds the OpenAPI `deprecated: true` field to all deprecated operations (Bot Users, Backends, Edges, Tunnels) so that Mintlify and other consumers can render deprecation indicators natively. Companion to ngrok/ngrok-docs#2070. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
BPKelley
marked this pull request as draft
May 18, 2026 22:42
BPKelley
marked this pull request as ready for review
July 20, 2026 18:14
Author
|
@copilot can you sync this PR with Main (pull the latest changes, since this PR is very stale) and let us know if anything has conflicts? Then if not, please run a code review. |
Synced check complete on |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
deprecated: trueto all 120 deprecated API operations inngrok.yamlContext
DOC-569: Deprecated API endpoints have no deprecation signal in page content — only the sidebar grouping, which AI agents and LLMs can't see. This causes tools like Claude to repeatedly suggest deprecated APIs.
Companion PR: ngrok/ngrok-docs#2070 (adds
<Warning>callouts in MDX — belt-and-suspenders approach while we confirm the OpenAPI approach renders well enough on its own).Test plan
ngrok-docs/docs.jsonopenapi field at localngrok.yaml, runpnpm run dev, and verify deprecated pages (e.g./docs/api-reference/botusers/create) show Mintlify's native deprecated label/docs/api-reference/apikeys/list) are unaffectedpython3 -c "import yaml; yaml.safe_load(open('ngrok.yaml'))"🤖 Generated with Claude Code