API Documentation error

Auth0 Fine-Grained Authorization
1

Hello,

Not sure if this is the correct place for this but I am seeing this error on the documentation site when navigating to Auth0 FGA API Explorer | Auth0 Fine-Grained Authorization (FGA) Docs

Unable to render this definition

The provided definition does not specify a valid version field.

Please indicate a valid Swagger or OpenAPI version field. Supported version fields are swagger: "2.0" and openapi: 3.0.x, openapi: 3.1.x, or openapi: 3.2.x (for example, openapi: 3.2.0).

3

Hi @Matthew.OSullivan

I am sorry for the delayed reply.

This is a documentation rendering issue with the FGA API Explorer, not a configuration problem with your application. The OpenAPI/Swagger definition file that powers the API Explorer is missing or has an invalid version field, preventing the documentation site from rendering the interactive API explorer. The OpenAPI definition file either does not include a version field in the openapi or swagger property, uses an unsupported format (e.g., openapi: 4.0.0 or swagger: 3.0.0), or is corrupted or incomplete, preventing the documentation renderer from parsing it correctly. This is a server-side issue with the Auth0 documentation infrastructure, not something you can fix in your application.

Recommended Next Steps:

  1. Report the issue to Auth0 Support: This is a documentation bug that requires investigation by the Auth0 docs or FGA team. You can report it through the Auth0 Community forum by posting a new topic describing the error and the URL where you encountered it, or contact Auth0 Support directly if you have a paid plan.
  2. Provide detailed information in your report: Include the exact URL where you encountered the error, the full error message, the browser and version you are using, a screenshot of the error if possible, and the time you encountered the error for server-side logs.
  3. Workaround — Access FGA documentation directly: While the API Explorer is unavailable, you can still access FGA documentation through the official FGA documentation site or the Auth0 FGA integration guide.
  4. Monitor for updates: Auth0's documentation team typically responds to bug reports within 24–48 hours. Monitor the community post or support ticket for updates on when the API Explorer will be restored.

We recommend reporting this issue to Auth0 Support so the documentation team can investigate and resolve it. In the meantime, you can access FGA documentation through the official FGA docs site.

Kind Regards,
Nik

4

Hi @Matthew.OSullivan!

Thanks for your report. We have since fixed the issue and the docs should be rendering again, but we forgot to update you back.

If you notice anything else amiss, please do let us know!