Update redirects to reflect new permanent default #1276
Closed
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
- Remove all 'permanent: true' entries from docs.yml as it's now the default - Update redirect documentation to specify default is now true (308 permanent) - Update parameter descriptions to match user requirements: - source: incoming request path pattern - destination: path you want to route to - permanent: true by default, uses 308 (permanent/cached) or 307 (temporary/not cached) - Add example of temporary redirect with permanent: false Related to fern-api/fern-platform#4141 Co-Authored-By: [email protected] <[email protected]>
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
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.
Update redirects to reflect new permanent default
Summary
This PR updates the fern-api/docs repository to align with the redirect behavior change in fern-platform#4141, which makes redirects permanent by default.
Changes made:
permanent: truefromfern/docs.ymlsince it's now the default behaviorfern/snippets/redirects.mdxto reflect:permanentis nowtrue(308 permanent/cached) instead offalse(307 temporary/not cached)source: "The incoming request path pattern"destination: "The path you want to route to"permanent: Explains true/false behavior with new defaultpermanent: falseReview & Testing Checklist for Human
permanentflag (PR description says it "ignores" the flag, but this PR documents it as configurable - need to verify intended behavior)permanent: truecould unintentionally change redirect behaviorpermanent: truelines in the diff to ensure only the intended lines were removedredirects.mdxto ensure it clearly explains the new default and status code implicationsTest Plan
permanentspecified use 308 status code (permanent)permanent: falseuse 307 status code (temporary)Notes