OAS:OpenAPI Editor/Extensions

From Remain Software

Extensions

Extensions are custom properties that start with x-. They can be used to describe extra functionality that is not covered by the standard OpenAPI Specification.

Add Extension

An extension can be added to the following components:

  • Schema
  • Path
  • Operation

To add an extension to one of the components, first open the Component Details view then select the desired component (schema, path, or operation) from the editor. Click the addition button (the + sign) from the local toolbar. You're then prompted with a wizard where you can enter the name and type of the field. Then click Finish.


Add extension.png


The added extension will be displayed at the bottom of the view.


Added extension.png

Edit/Delete Extension

Edit delete extension.png