apidocs.grax.io Retirement

What's being done?

GRAX is retiring the GRAX API documentation hosted at apidocs.grax.io in favor of the newly available Scalar-powered GRAX API documentation at api.grax.com. The retired documentation will be removed on September 30, 2024.

Why is GRAX retiring support for this feature?

The GRAX application hosts a Scalar-powered API explorer (at /scalar) already for users who have a GRAX deployment available. This API explorer has seen good user adoption and is the primary source of API documentation for existing GRAX users. To make the experience consistent for users who may not have access to their GRAX application, we have chosen to unify our API documentation toolset and retire the old site.

How does this impact me?

The OpenAPI specification describing the GRAX API is shared between the documentation sites, so the contents of the documentation is not changing.

If you have used the public apidocs.grax.io site to explore the GRAX API, you will need to switch to api.grax.com for all future API exploration. This new site does not feature the integrated test/request functionality of the previous site, so interactive exploration should be done from the private Scalar pages on your own GRAX application.

Timing

GRAX will retire apidocs.grax.io on September 30, 2024, at which point the site will no longer be available.

How do I get more information?

If you have questions or need more information, please open a support ticket.