OAS:OpenAPI Editor/Links

From Remain Software

Links

Add Global Link

Links help you describe how various values returned by one operation can be used as input for other operations. This way, links provide a known relationship and traversal mechanism between the operations.

To add a global link, select the Links tab, then the + button in the top-right of the editor.


Openapi links add global.png

Delete Global Link

To delete a global link, select the Links tab, then the Delete button within the link you want to delete.


Openapi links delete global.png

Update Global Link

A global link can be updated by directly changing the content of any of its input fields.


Openapi links update global.png

Add Parameter To Link

To add a parameter to a global link, select the Links tab, then the Add Parameter link in the top-right of the editor.


Openapi links add parameter.png

Delete Parameter From Link

To delete a parameter from a global link, click the red X delete button beside the parameter.


Openapi links delete parameter.png

Add Link To Response

A link is meant to be used by responses. A response can either use a new link or refer to an existing global one

To use a new link for a response, click the top-right menu within the response editor, then select New Link. A new link UI appears within the group Links at the bottom of the response.


Openapi links response link add.png

Add Link Reference To Response

A link is meant to be used by responses. A response can either use a new link or refer to an existing global one.

To refer to an existing global link within a response, click the top-right menu within the response editor, then select Refer to Global Link.

From the prompting dialog, select the link to refer to then hit Finish.


Openapi links response link refer dialog.png


A new link UI appears within the group Links at the bottom of the response contaning the newly added link reference.


Openapi links response link refer.png