Using the OpenAPI Document#

The OpenPlugin Manifest has a link to the OpenAPI document that describes your API.

If you have a large API with many operations, we suggest you create a small OpenAPI file with only the APIs you want to expose in your plugin.

We expect these fields to be present in the OpenAPI document: Info, Servers, Tags, Paths and Components.

Sample OpenAPI document:


We provide a utility to generate the OpenAPI document from the project level OpenAPI document. See: OpenPlugin Manifest