Thanks to visit codestin.com
Credit goes to github.com

Skip to content

📝 Update link to Swagger UI configuration docs#12264

Merged
alejsdev merged 4 commits into
fastapi:masterfrom
makisukurisu:patch-1
Oct 4, 2024
Merged

📝 Update link to Swagger UI configuration docs#12264
alejsdev merged 4 commits into
fastapi:masterfrom
makisukurisu:patch-1

Conversation

@makisukurisu

@makisukurisu makisukurisu commented Sep 25, 2024

Copy link
Copy Markdown
Contributor

I've noticed that the old link now leads to the "404 Not found" page on swagger.io, found the new link and updated it wherever possible (there appear to be only 4 languages that even have configure-swagger-ui.md page).

Even though it appears to be a problem that should be resolved on swagger.io side, I think that updating the link may be better.

P.S. I've created a bug report in the swagger.io-docs repo.
P.S.S. I still believe it's best to have the trailing slashes at the end of the link, because without them, users are getting 308 Permanent Redirect to other webpage, so adding a / will make life easier for both parties.

@github-actions github-actions Bot added the docs Documentation about how to use FastAPI label Sep 25, 2024
@github-actions

Copy link
Copy Markdown
Contributor

@makisukurisu makisukurisu marked this pull request as ready for review September 25, 2024 16:12

@Ryandaydev Ryandaydev left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No objection to the changes if it adds to consistency. However, I don't receive an error when using the original link. It seems to work fine for me.

@makisukurisu

makisukurisu commented Sep 29, 2024

Copy link
Copy Markdown
Contributor Author

@raccoonyy, indeed, as noted in the linked issue, they (swagger.io team) have resolved the redirection issue.

Thanks for your review, I'm absolutely OK if you decide to close the PR and decline the suggested changes as non-necessary.

*UPD, yes, indeed, sorry, I mentioned the wrong person, probably miss-clicked on the nick 😅

@raccoonyy

Copy link
Copy Markdown
Contributor

@makisukurisu I think I was mentioned in the wrong place. :)

@pjsully pjsully left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would suggest this change should be merged. If it works as well as without the trailing /, and also works if redirection for some reason isn't working, it seems like a better solution.

@alejsdev alejsdev changed the title Update link to Swagger UI Configuration Docs 📝 Update link to Swagger UI Configuration Docs Oct 4, 2024
@alejsdev alejsdev changed the title 📝 Update link to Swagger UI Configuration Docs 📝 Update link to Swagger UI configuration docs Oct 4, 2024
@alejsdev alejsdev merged commit 3f3a3dd into fastapi:master Oct 4, 2024
@alejsdev

alejsdev commented Oct 4, 2024

Copy link
Copy Markdown
Member

Thank you @makisukurisu

@makisukurisu makisukurisu deleted the patch-1 branch October 4, 2024 16:53
s-rigaud pushed a commit to s-rigaud/fastapi that referenced this pull request Jan 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation about how to use FastAPI

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants