OAS:OpenAPI Editor/Operations

From Remain Software

Operations

For each path, you define operations (HTTP methods) that can be used to access that path. OpenAPI 3.0 supports get, post, put, patch, delete, head, options, and trace. A single path can support multiple operations.

Add Operation

To add an operation, right-click a path then select New Operation.


Open api editor new operation.png


Fill in the operation wizard you're prompted with, then click Finish.


Open api editor new operation wz.png

Update Operation

Update Operation Using Menu

To edit an operation, right-click the operation you want to edit, then select Edit. You'll be prompted with a wizard where you can edit the operation

Open api editor edit operation.png


Update Operation Using Component Details View

Additionally, you can edit an operation by selecting it and editing it in the Component Details view. If this view is not yet opened, then you can find it by going to the main toolbar:

Windows -> Show View -> Other... then Remain API Studio.


Open api editor edit operation component details.png

Delete Operation

You can delete an operation by right-clicking it then selecting Delete from the popup menu.


Open api editor delete operation.png