Retire the duplicate Machines API spec - #2509
Merged
Merged
Conversation
The spec was a real file at two paths. api/machines/openapi.json is the one docs.json builds the reference from; machines-api/openapi.json was kept only because the redirect added in 2496 never fires, Mintlify resolving a path with a file extension as an asset before it consults the redirect table. This was gated on Lillian proxying docs.machines.dev/openapi.json to the new path, which has now landed. That URL answers 200 with Vercel and Fly proxy headers rather than from the old machines-api-docs app, so external consumers reach the spec without touching /machines-api/. Removes the file and the redirect entry that could never fire. Keeps /machines-api to /api/machines, which has no extension and works.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
This branch was successfully deployed
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
1 participant
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.
Closes superfly/docs-tracking#311.
The Machines API spec was a real file at two paths in this repository:
#2496 moved it and added a redirect from the old path. That redirect has never worked: it was the only entry whose source has a file extension, and Mintlify resolves a path that looks like a file as an asset before consulting the redirect table. The old URL 404d for about three minutes until
0471e524put the file back.Two copies of a 157KB generated document in one repository is a drift risk, and it is about to matter, because machines-meta#86 is building a workflow to push the freshly generated spec in. Whichever path that workflow writes, the other goes stale with nothing to announce it.
This was gated on Lillian's proxy, which has now landed.
docs.machines.dev/openapi.jsonanswers 200 carryingx-vercel-cache,x-vercel-id,via: 1.1 fly.ioand afly-request-id, so it is a Fly edge proxying to Mintlify rather than the oldmachines-api-docsapp serving its own copy. External consumers reach the spec without touching/machines-api/, which is the condition #311 was waiting on.What changes. The file goes, and so does the redirect entry that could never fire.
/machines-apito/api/machinesstays, since it has no extension and works today.What breaks.
docs.fly.io/machines-api/openapi.jsonwill 404 rather than falling through to the redirect, for the same asset-resolution reason. That path has existed for two days, since the cutover, and nothing insuperfly/docs,superfly/ui-exorsuperfly/landinglinks to it. The published URL that consumers actually use isdocs.machines.dev/openapi.json, which is unaffected, andlanding/pages/llms.txtpoints there.