Using Swagger UI
Last updated
Was this helpful?
Last updated
Was this helpful?
The Link11 WAAP API is available in . This tool provides design documentation, and can also be used to submit API calls directly to your planet.
By default, the API is available in Swagger UI at:
{your planet name}/api/v4.0/openapi.
Using Swagger UI will require the user to be logged into the planet with a sufficient .
If Swagger UI receives a request and the response is an HTML document, the most likely cause is the user is not logged in, or is logged in with insufficient permissions.
The Swagger interface shows the namespaces and data models for the API. Often, each one is initially collapsed, as in this example:
Expanding a namespace reveals the endpoints within it:
Expanding an endpoint reveals more information about required inputs (if any) and the information that will be returned in the response.
Some endpoints, as in the example above, do not require any inputs. Others require specific parameters:
... or other inputs, such as a request body.
Selecting the Try it out button will enable the editing of the required inputs, if any. Once the required inputs have been completed, the system will:
display an Execute button, which if selected will submit the command to the system and display the results.
Swagger allows you to interact with the API, try different commands, and see what responses will be generated.
display a command that can be submitted via curl (as explained ), and
