Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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 Assetasset. 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.
  • VersionsStatus: The status of the API version. CurrentlyInitially, all API versions are unpublished.
  • Policy: The names of the policies applied against to the API Version, listed by labelversion. Click the policy name to display the API 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. Click the Versions tab.
  3. Click the version number of the API version you want.

Image Added

a.

...

View API policy information

b. Edit API version details

c. Generate an OAS 2.0 spec

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

Anchor
view-policies
view-policies
Viewing API Policy Information

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

  1. In the API Manager console, click the target API version.
    In the Version Details tab of the AP API version dialog, click View Applied Policies to display the Related Policies dialog window.Image Removed

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

    • Name: The name entered in the Label field for the API Policy. Click the name to display the settings dialog window for that API policy.
    • Type: The type of policy.
    • Path: The path of the policy.

  3. Click the Hierarchy tab to view at which level (Org, API, version), the API policy is applied.
     

  4. Click Close to return the Version Details tab.

You can change policies from the Version Details page. 

Anchor
edit-details
edit-details
Editing Version Details

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

...

Note
titleKnown 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.

...

Anchor
generate-spec-oas2
generate-spec-oas2
Generating the Specification for your API

You can preserve the API specification used in the version in the published Developer Portal. Clicking Generate Specification enables OAS 2.0 Spec enables the API consumer to examine its contents in the Open API Specification 2.0 format when viewing the API's documentation for an API on the Developer Portal.