Skip to main content

Publishing and versions

API Studio

Each API is kept in versions. A draft can be edited. A published version is read only.

Publish a draft​

Admin and Owner only.

  1. Open the API and select the draft version.
  2. Save any changes in API Studio > Design > Designer. Publishing uses the saved document.
  3. Press Publish.
  4. Review the Changes and Lint sections.
  5. Press Publish to confirm.

Changes​

Changes compares the draft with the previous published version. Breaking changes are listed first and counted, followed by non-breaking changes. Each change shows its path in the document and a message.

A breaking change is one that can stop an existing client working, such as a removed operation or a new required parameter.

The first version of an API has no earlier published version to compare with.

Lint​

Lint lists the errors and warnings in the saved document. Errors block publishing: fix them, save, and open Publish again. Warnings do not block.

A document with no security scheme reports an error. Add one under Security schemes in the visual designer. Security best-practice checks report warnings.

Start a new draft​

Builder, Admin and Owner only.

When the newest version is published, press New draft on the API. The new draft starts from the published document and opens in API Studio > Design > Designer.

Without the API Studio add-on​

An account without the API Studio add-on cannot publish.