这是indexloc提供的服务，不要输入任何密码
Skip to content

docs: add response header to OpenAPI spec #10327

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 14, 2025
Merged

docs: add response header to OpenAPI spec #10327

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fc4d4d1
docs: add response header to OpenAPI spec
anthonyshew Apr 14, 2025
5c3d142
WIP da843
anthonyshew Apr 14, 2025
2909cad
Update docs/site/scripts/generate-docs.mjs
anthonyshew Apr 14, 2025
c8e05b3
Update generate-docs.mjs
anthonyshew Apr 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions docs/site/scripts/generate-docs.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,36 @@ function removeBillingRelated403Responses(spec) {
return spec;
}

/* Add x-artifact-tag header to artifact download endpoint response */
function addArtifactTagHeader(spec) {
// Target only the specific /v8/artifacts/{hash} endpoint
const artifactEndpoint = "/v8/artifacts/{hash}";

if (spec.paths?.[artifactEndpoint]) {
// Get the GET method for this endpoint
const getMethod = spec.paths[artifactEndpoint]?.get;

if (getMethod?.responses?.["200"]) {
const response = getMethod.responses["200"];

// Add headers to the response if they don't exist
if (!response.headers) {
response.headers = {};
}

// Add the x-artifact-tag header
response.headers["x-artifact-tag"] = {
schema: {
type: "string",
},
description: "The signature of the artifact found",
};
}
}

return spec;
}

const updateServerDescription = (spec) => {
if (spec.servers && spec.servers.length > 0) {
const serverIndex = spec.servers.findIndex(
Expand All @@ -100,6 +130,7 @@ const thing = await fetch("https://turbo.build/api/remote-cache-spec")
.then((res) => res.json())
.then((json) => removeExamples(json))
.then((json) => removeBillingRelated403Responses(json))
.then((json) => addArtifactTagHeader(json))
.then((json) => updateServerDescription(json));

writeFileSync("./.openapi.json", JSON.stringify(thing, null, 2));
Expand Down
Loading