docs: improve accuracy for self-hosted OpenAPI spec #10318
Merged
Conversation
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
chris-olszewski
approved these changes
Apr 11, 2025
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.
Description
The self-hosted OpenAPI spec is generated from the Vercel Remote Cache spec. However, that there can be spots where the Vercel Remote cache spec has information that the self-hosted spec doesn't need.
This PR introduces some light pre-processing so that we can make the self-hosted spec better for OSS-only users. See https://github.com/vercel/turborepo/pull/10318/files#diff-03cadc255ad9d43cf46b7ed6185da0eba06ef11294de0f9a784274a1863b6aa0R1 for more.
Testing Instructions
👀
https://turbo-site-git-shew-240ef.vercel.sh/api/remote-cache-spec now doesn't have
examplesfields, since the Vercel Remote Cache spec has examples specific to Vercel.This also removes the erroneous example string from https://turbo-site-git-shew-240ef.vercel.sh/docs/openapi/artifacts/download-artifact.