[OpenAPI] Add Platform API to SDK spec generation#112
Merged
chris-freeman-glean merged 7 commits intoJun 17, 2026
Merged
Conversation
Include Platform in the merged Speakeasy source and preserve stable SDK metadata, traceability, and streaming coverage before downstream SDK generation.
Keep the Platform SDK restore PR focused on source configuration and tests while leaving generated spec artifacts to the transform automation.
…form-api-sdk-generation-open-api-main
travis-hoover-glean
approved these changes
Jun 17, 2026
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
Prepare
open-apito transform the Platform API once it is published byopenapi-redoclyautomation from the clean shared-schema Platform bundle.This PR:
x-glean-sdkto Speakeasy metadata conversion.scio/openapi/shared/platform_entities.yamlproducing canonical names such asPersonReference,Person, andDocumentSpec.text/event-streampreservation.Generated spec artifacts are intentionally excluded from this manual PR. This PR also intentionally does not add
generated_specs/platform.yamlto.speakeasy/workflow.yaml; that activation belongs in a follow-up PR after automation has created the generated Platform spec.Context
Old Platform SDK generation PRs are stale/closed:
askscio/scio#237884,askscio/openapi-redocly#15, andgleanwork/open-api#102.The active metadata-driven path comes from
askscio/scio#238861andgleanwork/open-api#104: Platform SDK names live inscioasx-glean-sdkandopen-apiderives Speakeasy metadata from that source contract.The shared Platform entity schema work in
sciois the prerequisite that avoids downstream Redocly suffix interpretation.open-apishould transform the clean published component names, not maintain endpoint-specific mappings for names likePerson-2orDocumentSpec-2.Expected Order
openapi-redoclypublishsource_specs/platform.yamlinto this repo..github/workflows/transform.ymlgenerate and commitgenerated_specs/platform.yamlfrom the published source spec.generated_specs/platform.yamlto.speakeasy/workflow.yamland adds Platform merged-spec smoke coverage..speakeasy/workflow.lockandoverlayed_specs/glean-merged-spec.yaml; proceed to SDK generation only after the Platform-inclusiveglean-api-specssource is available.Validation
pnpm exec vitest run tests/source-spec-transformer.test.js tests/post_transform_smoke.test.js: 2 files, 50 tests passed.OPEN_API_COMMIT_SHA=$(git rev-parse HEAD) pnpm run transform:source_specswith the current non-Platform source specs.speakeasy run -s glean-api-specs --skip-upload-spec; merge and validation completed with warnings only.src/source-spec-transformer.jsandtests/source-spec-transformer.test.js.Out of Scope
generated_specs/platform.yamlexists onmain.