Contributing
Updating Dittofeed's API Docs
We maintain a copy of the OpenAPI spec for the production API in the docs package - packages/docs/open-api.json
. The following page describes how to update this file.
This schema is used to generate the API reference docs.
Updating packages/docs/open-api.json
Run the following command to copy the OpenAPI / Swagger spec to the docs package:
Note this command assumes you have jq installed, which formats the JSON output from the API server.
Adding New Endpoints to the Docs
Run the following command to add new endpoints to the docs:
Then add the new endpoints to the mint.json file.
mint.json
Running the Docs Locally
cd into docs directory
Run the mintlify dev server.