Manage revisions

You're viewing Apigee X documentation.
View Apigee Edge documentation.

Every API in the API hub can have multiple versions, and each version can have a specification which can have multiple revisions. The History tab on the APIs page lists every specification revision across all versions of the API.

History tab
View API Registry schema

The following illustrates the relationships between API hub APIs, versions, deployments, and specifications.

alt_text
Reference Item Description
Registry A registry is a collection of APIs that serves as an API catalog.
Version An API can have multiple versions. A version should correspond to a stable interface that clients can use to call an API. One of these versions may be designated as the recommended version. In semver terminology, it is a best practice for versions to be major versions.
Deployment An API may have multiple deployments, e.g., different staging environments or regions. A deployment is a location (an address) where users can access an API. One of these deployments can be the recommended deployment.
Specification It is recommended, but not required that an API version is described by formal specifications, often using different API specification formats. One of these specification formats can be primary, which indicates that other specs for this version are derived from it.
Revisions
  • Deployments have a revision history. Deployment revisions represent particular instances of a deployment in time and can refer to one or more spec revisions if the API implementation being served by the deployment changed.
  • Specs have a revision history. Spec revisions represent subsequent instances of a spec and typically represent non-breaking changes to spec contents. In semver terminology, revisions might correspond to minor or point versions.

Sort revision table

Click the Updated column heading to sort the table.

Add revision

To add a revision:

  1. In the Cloud console, go to the Apigee API hub page.

    Go to API hub

    The APIs list page is displayed by default.

  2. From APIs list, click an API row. The Overview tab is displayed by default.
  3. Select the History tab.
  4. Click Add revision.
  5. Click Browse and then select a description document or zip file.
  6. Click Open.
  7. Specify Details:
    • Select an API version.
    • Select a MIME type. If you select Other, a text field is displayed where you can manually specify the MIME type.
    • Type a Commit message (optional).
    • Type a Commit hash (optional).
  8. Click Save (or Cancel).

View revision

See View or download a specification

Delete revision

To delete a revision:

  1. In the Cloud console, go to the Apigee API hub page.

    Go to API hub

    The APIs list page is displayed by default.

  2. From APIs list, click an API row. The Overview tab is displayed by default.
  3. Select the History tab.
  4. Click Delete next to the desired revision.
  5. Click Delete (or Cancel) at the prompt.