Manage versions

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

A version is a well-defined interface of an API that provides stability for consuming applications. You can have multiple versions of an API.

An API can have multiple deployments. Each deployment can have a different version.

Versions are associated with an API by a user with edit permissions when registering an API, and associated with a deployment when adding or editing a deployment.

Versions 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.

Add version

To add a version:

  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 Versions tab.
  4. Click Add version.
  5. Specify details:
    • Enter ID. Use lowercase letters, numbers, and hyphens (-). For example, v1, v1, 1, 1-0-0, etc.
    • Enter Version. Use any character.
    • Select an API lifecycle stage.
    • Expected end of life:
      • Select an Expectation from the list.
      • If Expectation is Minimum date, specify a Date.
      • If Expectation is Confirmed date, specify a Date.
  6. Click Save (or Cancel).

Edit version

To edit a version:

  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 Versions tab.
  4. Click More > Edit next to the desired version.
  5. Make modifications as necessary.
  6. Click Save (or Cancel)

Delete version

To delete a version:

  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 Versions tab.
  4. Click More > Delete next to the desired version.
  5. Click Delete (or Cancel) at the prompt.