Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Clean up of screenshots after the editor conversion. Also, minor tweaks in the text for minimalism and clarity.

In this article

Table of Contents
maxLevel2

Overview

The Version Details page is the space where you can view information about a Version version of the API, the Assets assets it contains, and Permissionspermissions. Besides performing all lifecycle actions for an API published on the API Portal, you can view information about your API Versions, as well as view, add and delete API policies,manage API policies for the API version.

  • Created: The date when the API is created.

  • Owner: The user who owns the Asset. Typically, the owner inherits the asset when it is moved or the creator is no longer a user in the Org.

  • Updated: The time the API Version is last updated.

  • Versions: The status of the API version

    . Currently, all API versions are unpublished

    .

  • Policy: The policies applied

    against

    to the API Version

    , listed by label

    . Click the policy name to display the

    API policy

    policy’s Settings dialog

    window

    .

  • Type: The type of the API policy

    for each policy listed

    .

  • Owner: The owner of the API policy.

  • Update:

    .

    The time the API policy is last updated.

  • Status: Indicates if the API policy is Enabled or Disabled. You can enable or disable an API policy in the

    settings

    policy’s Settings dialog

    window

    .

  • Description: The

    description of the API that

    API’s description, which is added during the creation of the API or the API Version.

  • Tags: Metadata added to the API and API version.

...

To view the Version Details page,

  1. In the API Manager, click the API name.

  2. Go to the Versions tab.

  3. Click the version number of the API version you want.

...

For details about the assets used in the API version, see Managing API Version Assets.

...

To view the API policies applied at the various levels for a version of an API :

...

version,

  1. In the Version Details tab of the

    AP

    API version dialog, click View Applied Policies to display the Related Policies dialog

    window

    .

    Image Removed

    View Applied Policies buttonImage Added

  2. In the Applied Policies tab, the following information is displayed

    .

    :

    Image RemovedApplied Policies dialogImage Added
    • Name: The name entered in the Label field for the API

      Policy

      policy. Click the name to display the

      settings

      Settings dialog

      window

      for that API policy.

    • Type: The type of the policy.

    • Path: The path of the policy.

  3. Click

    Go to the Hierarchy tab to view

    at which

    the level (Org, API, version)

    ,

    where the API policy is applied.

     Image RemovedPolicies Hierarchy dialogImage Added

  4. Click Close to return to the Version Details tab.

You can change add and delete policies from the Version Details page. 

...

Editing Version Details

You can edit the description and tags for an API Version without having to republish republishing the API. You can also change the Snaplex if the API version is unpublished.

  1. Navigate to the target API, and click the version

    whose details you are changing

    to edit.

  2. Click Edit Details, and

    change the content in

    update the following fields:

    • Description

    • Tags

Note
title

Known Issue

In 4.26, to change a Snaplex for an API Version, you must create a new version, update the Snaplex, and then publish a new version of the API. Clicking Edit Details from the API > Versions page displays the Server field for selecting another Snaplex, but the field is disabled.

...

Generating the Specification for your API

You can To preserve the API specification used in the API version published in the published Developer Portal. Clicking Generate Specification enables , click Generate Specification. The generated specification is in the Open API Specification (OAS) format, and the API consumer to can examine its contents in the Open API Specification format when viewing the API’s documentation for an API on in the Developer Portal.