This documentation is for WSO2 API Manager 1.8.0 View documentation for the latest release.
Publish the new Version and Deprecate the old - API Manager 1.8.0 - WSO2 Documentation
||
Skip to end of metadata
Go to start of metadata

You publish an API to make it available for subscription in the API Store. If you set up multiple tenants, your tenant store will be visible to other tenants as well. Therefore, users of the other tenants can view the APIs that are published in your default API Store. This allows you to advertise your APIs to a wider audience. Although the APIs that are published in your tenant store are visible to the users of other tenant stores, they need to log in to your tenant store in order to subscribe to and use them.

For a description of the API lifecycle stages, see  API lifecycle.

The steps below show how to publish an API to its default API Store:
  1. Log in to the API Publisher as a user who has the publisher role assigned. 
  2. Click the API that you deprecated in the previous tutorial (e.g., PhoneVerification 2.0.0).

  3. Go to the API's Lifecycle tab and select the PUBLISHED state from the drop-down list. Then, select all the options and click Update

    Tip: The Lifecycle tab is only visible to users with publisher privileges.

    The three options are described below:

    OptionDescription
    Propagate Changes to API Gateway

    Automatically changes the API metadata in the API Gateway according to the information published in the API Store. If unselected, you have to manually configure the Gateway.

    Deprecate Old Versions

    Automatically deprecates all prior versions of the API, if any.

    Require Re-Subscription

    If unchecked, all users who are subscribed to the older version of the API will be automatically subscribed to the new version. If not, they need to subscribe to the new version again.

    The API is now published to the default API Store and all its previous versions are deprecated.

  4. Log in to the default Store and click the APIs menu to see the API that you just published listed there. The older version (e.g., PhoneVerification 1.0.0) is no longer listed here as it is deprecated.

  5. Click the My Subscriptions menu and look under the Subscribed APIs section. The subscriptions made to the older API versions must be deprecated now.

    Tip: When an API is deprecated, new subscriptions are disabled (you cannot see the subscription options) and existing subscribers can continue to use the API as usual until it is eventually retired.

You have published an API to the API Store and deprecated its previous versions.

  • No labels