Important Note on Spelling:While our documentation now uses American English, the product itself, including UI, configuration fields, environment
variables, and APIs endpoints, retain British English spellings. When interacting with the product, please continue
using the British English spellings as they appear in the interface and API. (This means that for existing users nothing
has changed).
Example: The API endpoint
Example: The API endpoint
/api/portal/catalogue as shown throughout this page uses British spelling. In all other
instances, such as when describing or referring to this object in the documentation, we will use the
American spelling “catalog”.Documentation
Create Documentation
The Swagger or Blueprint should be base64 encoded and included in the
documentation field of the Request Body, as per the example below.
Support for API Blueprint is being deprecated. See Importing APIs for more details.