| Html macro |
|---|
<div id="model-ApiDTO" class="model-container" data-name="ApiDTO"><span class="models-jump-to-path"></span><span class="model-box"><div class="model-box"><span class="model"><span class=""><button aria-expanded="true" class="model-box-control"><span class="pointer"><span class="model-title"><span class="model-title__text">ApiDTO</span></span></span><span class="model-toggle"></span></button><span class="brace-open object">{</span><span class="inner-object"><table class="model"><tbody><tr class="property-row"><td>id</td><td><span class="model"><span class=""><span class="prop"><span class="prop-type">integer</span><span class="prop-format">($int64)</span></span></span></span></td></tr><tr class="property-row required"><td>name<span class="star">*</span></td><td><span class="model"><span class=""><span class="prop"><span class="prop-type">string</span></span></span></span></td></tr><tr class="property-row required"><td>displayName<span class="star">*</span></td><td><span class="model"><span class=""><span class="prop"><span class="prop-type">string</span></span></span></span></td></tr><tr class="property-row required"><td>description<span class="star">*</span></td><td><span class="model"><span class=""><span class="prop"><span class="prop-type">string</span><span class="property primitive"><br>maxLength: 1000</span><span class="property primitive"><br>minLength: 0</span></span></span></span></td></tr><tr class="property-row"><td>url</td><td><span class="model"><span class=""><span class="prop"><span class="prop-type">string</span></span></span></span></td></tr><tr class="property-row required"><td>visibility<span class="star">*</span></td><td><span class="model"><span class=""><span class="prop"><span class="prop-type">string</span><span class="prop-enum">Enum:<br><span class=""><button aria-expanded="true" class="model-box-control"><span class="model-toggle"></span></button>[ RESTRICTED, PUBLIC ]</span></span></span></span></span></td></tr><tr class="property-row required"><td>published<span class="star">*</span></td><td><span class="model"><span class=""><span class="prop"><span class="prop-type">boolean</span></span></span></span></td></tr><tr class="property-row required"><td>status<span class="star">*</span></td><td><span class="model"><span class=""><span class="prop"><span class="prop-type">string</span><span class="prop-enum">Enum:<br><span class=""><button aria-expanded="false" class="model-box-control"><span class="model-toggle collapsed"></span><span><span>Array [ 2 ]</span></span></button></span></span></span></span></span></td></tr><tr class="property-row"><td>owner</td><td><span class="model"><span class=""><span class="prop"><span class="prop-type">integer</span><span class="prop-format">($int64)</span></span></span></span></td></tr><tr class="property-row required"><td>tags<span class="star">*</span></td><td><span class="model"><span class=""><button aria-expanded="false" class="model-box-control"><span class="model-toggle collapsed"></span><span>[...]</span></button></span></span></td></tr><tr class="property-row"><td>gitUrl</td><td><span class="model"><span class=""><span class="prop"><span class="prop-type">string</span></span></span></span></td></tr><tr class="property-row"><td>gitCredential</td><td><span class="model"><span class=""><span class="prop"><span class="prop-type">integer</span><span class="prop-format">($int64)</span></span></span></span></td></tr><tr class="property-row"><td>platformType</td><td><span class="model"><span class=""><span class="prop"><span class="prop-type">string</span><span class="prop-enum">Enum:<br><span class=""><button aria-expanded="false" class="model-box-control"><span class="model-toggle collapsed"></span><span><span>Array [ 8 ]</span></span></button></span></span></span></span></span></td></tr><tr class="property-row"><td>deploymentStatus</td><td><span class="model"><span class=""><span class="prop"><span class="prop-type">string</span><span class="prop-enum">Enum:<br><span class=""><button aria-expanded="false" class="model-box-control"><span class="model-toggle collapsed"></span><span><span>Array [ 5 ]</span></span></button></span></span></span></span></span></td></tr><tr class="property-row"><td>createdAt</td><td><span class="model"><span class=""><span class="prop"><span class="prop-type">string</span><span class="prop-format">($date-time)</span></span></span></span></td></tr><tr class="property-row"><td>hasImage</td><td><span class="model"><span class=""><span class="prop"><span class="prop-type">boolean</span></span></span></span></td></tr></tbody></table></span><span class="brace-close">}</span></span></span></div></span></div> |
...
id
...
Lorem Ipsum
...
name
...
displayName
...
Technical Name | The technical name of an API must be unique. |
|---|---|
Display Name | The display name can differ from the technical name and does not have to be unique. |
Status | A disabled API can no longer be subscribed to and is no longer visible in the Developer Portal. |
Image | The image of the API. It is also displayed in the Developer Portal. |
Organization | The organization of the API. Who is allowed to see it also depends on this. |
Tags | With the tags you can categorize APIs. e.g. you can search for the tags in the API overview. |
Description | The description of the API is displayed in the Developer Portal. |
Create a new API from Specification File
...