The Gelato Import API is currently in Beta. Please let us know your feedback!
You can use this API to create new Swagger / Open API programmatically. This is useful if you say, want to update your API documentation each time your CI build passes, or in a Git
There is only a single resource in the API at the moment, Imports.
First, be sure that you have a Swagger definition available publicly on the internet somewhere (this could be an S3 link or similar).
Then, make a
POST request to the
/v1/imports/ endpoint. Include the
import_type you're looking for (
swagger), and a
file_location parameter which points to your publicly available file. You'll also need to include the ID of the Gelato API you'd like to import to (you can find this on the "APIs & Docs" tab in your Gelato Admin panel)
If everything goes correctly, you'll receive a response including a URL pointing to your brand new import . You can use this to check out the status of the import in progress (we process the imports in the background for you)
If you have any issues, please get in touch on email@example.com. Thanks!