Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel6
outlinefalse
stylenone
typelist
printablefalse

You can manage multiple API versions simultaneously. The overview will always display scoring results for your most recently created version..

ApiDetailsVersions-20240209-105209.pngImage Modified

Create new Version

Press the three dots in the top right-hand corner. You can create a new version there. The appropriate Open Proxy Specification can then be uploaded as described below.

API Specification

Maximize API quality: Include a specification file with each version for automatic scoring against industry best practices (along with the ability to calculate a score against your own rulesets).

image-20240314-091211.pngImage Modified

To edit the displayed API specification file, you can click on the pencil icon to the left of the line number. A new dialogue opens in which you can edit the file directly in the browser.
If you close the dialogue by clicking the 'X' button, your changes will not be applied.

image-20240314-091248.pngImage Modified

Swagger UI

Each version displays the results of its specification file validation.

ApiDetailsVersionSpecSwaggerUI-20230914-111631-20240209-110346.pngImage Modified

Open Proxy Specification

For APIs created in API Control Plane (not imported from a gateway), you can manage the Open Proxy Specification file.
Click on the “Open Proxy Specification” tab to view the file content.

In the top right menu, you can upload a new file and download or delete the current file.

You cannot overwrite or delete a file which has been imported from a Git repository.

Info

If you create an API via the 'API Control Plane Rest API' and do not specify a platform type, you can create a new version under Versions and manually upload an open proxy specification there. This turns the API into an Open Proxy API.

apis_version_ops-20240209-110133.pngImage Modified

Edit Mode

You can use the 'Edit File' button to edit the displayed Open Proxy File directly in the browser.

image-20240313-132457.pngImage Modified

A dialogue appears in which you can edit and reload the file. If a problem occurs during validation, the corresponding messages appear above the editing area.

If there are errors, the file will not be uploaded. All errors must first be corrected before the file can be successfully uploaded.

If there are warnings, the file is automatically uploaded and the corresponding messages are displayed.

If there are no problems, the file is automatically uploaded and the editing mode is automatically closed.

If you close the dialogue by clicking the 'X' button, your changes will not be applied.

image-20240313-132542.pngImage Modified

Settings

Here you can adjust the name and description of the version

image-20240313-132609.pngImage Modified

Table of Content

Table of Contents
minLevel1
maxLevel6
outlinefalse
styledisc
typelist
printablefalse