Add x-glean-deprecated to Speakeasy deprecation format transformation#75
Merged
travis-hoover-glean merged 3 commits intomainfrom Dec 8, 2025
Merged
Conversation
Transform x-glean-deprecated annotations in OpenAPI specs to Speakeasy-
compatible deprecation format. This enables Speakeasy SDK generation to
properly handle deprecated operations, parameters, and schema properties.
The transformation:
- Adds `deprecated: true` to elements with x-glean-deprecated
- Generates `x-speakeasy-deprecation-message` with format:
"Deprecated on {introduced}, removal scheduled for {removal}: {message}"
- Preserves the original x-glean-deprecated annotation for internal tooling
rwjblue-glean
approved these changes
Dec 8, 2025
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
transformGleanDeprecatedfunction to convertx-glean-deprecatedannotations to Speakeasy-compatible deprecation formatDetails
This PR enables Speakeasy SDK generation to properly handle deprecated API elements by transforming Glean's internal deprecation annotations to the format Speakeasy expects.
Transformation Logic
For each element with
x-glean-deprecated, the transformer:deprecated: true(standard OpenAPI field)x-speakeasy-deprecation-messagewith the format:"Deprecated on {introduced}, removal scheduled for {removal}: {message}"x-glean-deprecatedannotation for internal toolingExample
Input:
Output:
Supported Deprecation Targets
The transformation handles
x-glean-deprecatedon:Test plan