Manage lifecycle stages

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

The Lifecycle settings page allows Administrators to define an ordered set of stages that an API should progress through, from conception to end-of-life. Since each version of an API usually moves through its own lifecycle separately, we don't directly set the lifecycle stage of an API, but instead allow each API version to have an assigned lifecycle stage.

An API Lifecycle stage is defined by a Name, Description, and optional URL. The URL can be used to provide a link to documentation about the specific lifecycle stage.

Lifecycle tab

The default API Lifecycle stages provided are as follows:

  • Concept: Description of the business case and user needs for why an API should exist
  • Design: Definition of the interface details and proposal of the API contract
  • Develop: Implementation of the service and its API
  • Preview: Staging of implementations in the pre-production phase
  • Production: API available for production workloads
  • Deprecated: API not recommended for new consumers
  • Retired: API no longer available for use

Add lifecycle stage

To add a lifecycle stage:

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

    Go to API hub lifecycle

  2. Click Add lifecycle stage.
  3. Specify the following:
    • ID: A name for an API resource. The ID can contain only lowercase letters, numbers, and hyphens. The ID must be unique in the project. IDs must be between 4 and 63 characters long. IDs cannot be changed once a lifecycle stage has been created.
    • Name: A name for the stage, for example: Concept or Retired.
    • Description: A short explanation of the lifecycle stage. This text is displayed in the UI as a tooltip.
    • URL: Enter a full URL that provides more detailed information about a lifecycle stage.
  4. Click Save (or Cancel).

Edit lifecycle stage

To edit a lifecycle stage:

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

    Go to API hub lifecycle

  2. Click More > Edit next to the desired lifecycle stage.
  3. Make modifications as necessary.
  4. Click Save (or Cancel).

Delete lifecycle stage

To delete a lifecycle stage:

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

    Go to API hub lifecycle

  2. Click More > Delete next to the desired lifecycle stage.
  3. A confirmation dialog opens:

    Delete lifecycle stage confirmation

    Do one of the following:

    • Select a Replacement API lifecycle stage and then click Delete. Replacing a lifecycle stage changes all APIs that currently indicate they are in the selected lifecycle stage to the new one.
    • Click Delete. Deleting without selecting a replacement lifecycle stage moves all APIs with the selected lifecycle stage to a Not specified lifecycle stage.

Reorder lifecycle stage list

Lifecycle stages appear within the UI in the order they are listed on the Lifecycle pane.

To reorder the lifecycle stages list:

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

    Go to API hub lifecycle

  2. Click an up or down arrow until the lifecycle is at the desired position.