Skip to content

Links Object

All of the Resources will return a "links" object in the Response Body if the "output" parameter is not set to "text". It will be returned in a data format as defined by the Output parameter.

Example

<links>
    <about>https://toolbox.omegatower.ninja/resources/characters</about>
    <openapi>https://toolbox.omegatower.ninja/schemas/v1/openapi.yaml</openapi>
    <swaggerhub>https://app.swaggerhub.com/apis-docs/OTDP/Toolbox/1.2.0.13#/Characters/CharactersGet/</swaggerhub>
    <wadl>https://toolbox.omegatower.ninja/schemas/v1/v1.wadl</wadl>
    <describedby>https://toolbox.omegatower.ninja/schemas/v1/characters.xsd</describedby>
</links>

about

This link is where human-readable documentation for the Resource can be found within this website.

Example

<about>https://toolbox.omegatower.ninja/resources/characters</about>

openapi

This link is where OpenAPI documentation, in the form of an OAS3 YAML file, for the Resource can be found within this website.

Example

<openapi>https://toolbox.omegatower.ninja/schemas/v1/openapi.yaml</openapi>

swaggerhub

This link is where the documentation for, and a simple inteface to, the Resource can be found at SwaggerHub.

Example

<swaggerhub>https://app.swaggerhub.com/apis-docs/OTDP/Toolbox/1.2.0.13#/Characters/CharactersGet/</swaggerhub>

wadl

This link is where Web Application Description Language documentation, in the form of a WADL file, for the Resource can be found within this website.

Example

<wadl>https://toolbox.omegatower.ninja/schemas/v1/v1.wadl</wadl>

describedby

If the resource Output parameter has been set to "json" or "xml", this link is where the schema file for the Resource can be found within this website.

Example

<describedby>https://toolbox.omegatower.ninja/schemas/v1/characters.xsd</describedby>