Skip to content

fix: update how swaggerUI fetches initial documentation for v2#650

Merged
pleary merged 1 commit into
mainfrom
fix-swagger-ui-docs
Jul 20, 2026
Merged

fix: update how swaggerUI fetches initial documentation for v2#650
pleary merged 1 commit into
mainfrom
fix-swagger-ui-docs

Conversation

@pleary

@pleary pleary commented Jul 16, 2026

Copy link
Copy Markdown
Member
  • Changes the way swagger documentation is loaded from giving it a schema directly, to having it fetch the schema from a URL
    • This causes swaggerUI to automatically include the schema URL in the documentation, which is why this PR removes that bit of the V2 API description
  • Allows bots to access favicon.ico

@caseyhofford caseyhofford left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks good, thanks!

@jwidness

Copy link
Copy Markdown
Contributor

Can I ask a related question while you're looking at bot access to public docs -- the www doc pages (/pages/api+reference, /pages/developers, /pages/api+recommended+practices, /pages/api+deprecated) are still behind cloudflare, is that intentional?

@pleary

pleary commented Jul 16, 2026

Copy link
Copy Markdown
Member Author

We intentionally applied CloudFlare protections to just about everything, and have made exceptions for certain pages. It was not intentional to not make exceptions for these pages, it just hasn't been identified as a problem. Since those API reference pages are not likely to be vectors for abuse, they don't necessary need CloudFlare protections. But, is there a specific reason to remove them? CloudFlare allows different rules for different requestors, so if the consideration is indexing in search engines, it's not safe to assume search engine bots are hitting the same checks users are

@jwidness

Copy link
Copy Markdown
Contributor

Thanks for the response! I think as more and more people are coding with AI agents, it would be useful for those agents to be able to directly read the docs pages. I have had to repeatedly tell my agents not to hit those pages (because they get 403'd), and instead I manually feed in the relevant information. I suspect many people are unaware of these pages and their agents may be missing information that would help them stay compliant with recommendations.

@pleary
pleary merged commit 9551dc2 into main Jul 20, 2026
5 checks passed
@pleary
pleary deleted the fix-swagger-ui-docs branch July 20, 2026 20:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants