Skip to main content

OpenAPI

kapa provides an integration to pull OpenAPI references.

Schema requirements

kapa only requires a url to a hosted OpenAPI schema in either JSON or YAML format. Both OpenAPI 2.x and 3.x are supported. Blob urls like the following are not supported:

blob:https://clerk.com/05c96426-79cc-42f3-8940-aa4c9dcc243f

If no hosted version of the schema is available users can also upload OpenAPI schema files through the File Upload source type. However, the downside of the File Upload is that it can not automatically refresh.