Glide API Documentation

These are the customer facing API docs for the Glide API.

We are using Mintlify to power this documentation, which is updated and maintained by editing the contents of this repository.

Start

To run the documentation locally, run setup once:

$ script/setup

Then start the documentation server:

$ script/start
✔ Local Mintlify instance is ready. Launching your site...
🌿 Your local preview is available at http://localhost:3000
🌿 Press Ctrl+C any time to stop the local preview.

Development

To update or make changes to the documentation, you can edit the various Markdown files directly.

Much of the endpoint documentation is auto-generated by Mintlify by reading in the swagger.json file. Please note that this swagger.json file is heavily edited from the version served by Glide. So replacing the swagger file with one from Glide will most likely be destructive to the documentation.

If you need to update the swagger.json file, please consider saving a copy as swagger.staging.json (for example) and then manually importing the changes you need.

Testing

Run the local test script to check for broken links in the documentation.

$ script/test
Checking for broken links...

api-reference/v2/stashing/introduction.mdx
  /api-reference/v2/tables/post-tables-rows

Publishing

Once changes are made and confirmed in your local environment, you can commit your changes to Github. This will automatically trigger a build of the documentation and deploy to the live environment at: https://glide.mintlify.app/

If the build fails with a Mintlify error that you are not an "editor", you will need to be added to our Mintlify team. @rwdaigle can do this for you.

Postman

We use Postman to deliver executable endpoints of the Glide API to the public (in addition to what's available in the documentation). The Postman collection should be kept up to date with the latest endpoints and documentation. Unfortunately, this is a manual process for now.

Please update the Postman collection in the Glide API v2 public collection (distinct from the Glide internal Postman collection) with any changes to the API.