Page Comparison - Publish the New Version and Deprecate the Old (v.3 vs v.4) - API Manager 2.6.0 - WSO2 Documentation

All docs This doc

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Added a note for copying subscriptions to lower versions

...

  1. Sign in to the WSO2 API Publisher as a user who has the publisher role assigned to themselves. 
    https://<hostname>:9443/publisher 
  2. Click on the API that you prototyped in the previous tutorial (e.g., PhoneVerification 2.0.0).
    Select the PhoneVerification 2.0.0 API

  3. Click GO TO OVERVIEW.

  4. Go to the API's Lifecycle tab and click Publish

    Info
    iconfalse

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

    Publish the PhoneVerification 2.0.0 prototyped API

    Tip
    • Leave the Requires Re-Subscription check box cleared if you want all users who are subscribed to the older version of the API to be automatically subscribed to the new version. If not, they need to subscribe to the new version again.

    • You can choose to deprecate old versions of this API at this stage by selecting the Deprecate Old Versions check box.

    Warning

    Note that you should not change these checklist items through the methods mentioned below.

    1. Editing the <API-M_HOME>/repository/resources/lifecycles/APILifecycle.xml file.

    2. Editing through the Management Console via Extensions > Lifecycles.

    For instructions on changing the text appearing in the API Publisher UI, see Adding Internalization and Localization.

    Note
    titleNote
    Users will not automatically get subscribed to lower versions of an existing API even if the lower version is newly created. For example, if you create version v1 from existing API version v2, the subscriptions belonging to v2 are not automatically assigned to v1.

    The API is now published to the default API Store.

  5. Sign in to the default Store and click on the APIs menu to see the API that you just published listed there.
  6. Go back to the WSO2 API Publisher and click the API that you want to deprecate (e.g., PhoneVerification 1.0.0 ).

  7. Go to the API's Lifecycle tab and click Deprecate
    Deprecate the PhoneVerification 1.0.0 API
    The API is now deprecated.

  8. Go back to the WSO2 API Store, click the Applications menu, click on TestApp to open the TestApp application, which you used to subscribe to the API. Click on the Subscriptions tab to view the deprecated API.
    The subscriptions made to the older API versions should be deprecated now.

    View the deprecated and published API in the subscriber list

    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.

...