Version Details

In this article

Overview

The Version Details page is the space where you can view information about a version of the API, the assets it contains, and permissions. Besides performing all lifecycle actions for an API published on the API Portal, you can manage API policies for the API version. You can also manage the specification file referenced by the version. SnapLogic APIM supports both JSON and YAML formats for specification files. Both OAS 2.0 and OAS 3.0 specification types are supported.

To navigate 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.

Supported UI Operations

On the Version Details page, you can do the following operations:

Callout

Description

Callout

Description

a

Manage developer portal status and lifecycle of your API version.

b

View API policy information.

c

Edit API version details

d

Generate API specification

 

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

Viewing API Policy Information

To view the API policies applied at the various levels for an API version,

  1. In the Version Details tab of the API version dialog, click View Applied Policies to display the Related Policies dialog.

     

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

    Applied Policies dialog
    • Name: The name entered in the Label field for the API policy. Click the name to display the Settings dialog for that API policy.

    • Type: The type of the policy.

    • Path: The path of the policy.

  3. Go to the Hierarchy tab to view the level (Org, API, version) where the API policy is applied.

    Policies Hierarchy dialog

     

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

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

Editing Version Details

You can edit the description and tags for an API Version without 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 to edit.

  2. Click Edit Details, and update the following fields:

    • Description

    • Tags

Generate the Specification for your API

For your specification to be valid, the Tasks in your API Version and all associated assets must be valid. When you generate the API specification from a Task or Pipeline that is not valid, the UI displays an error message.
For details, refer to Troubleshooting Spec Generation Errors.

To enable your API Consumers to download the API specification used in the API version published in the Developer Portal:

  1. Click Generate Spec

  2. In the Generate API Specification dialog, select from the following options:

    1. File type. Choose from one of the two following options:

      • JSON

      • YAML

    2. OpenAPI version. Choose from one of the two following options:

      • 2.0

      • 3.0

    3. Click Generate. The following message appears:
      API Specification generated per the modifications made to the API implementation.

The generated specification is in the Open API Specification (OAS) format, and the API consumer can examine its contents when viewing the API’s documentation in the Developer Portal.

Version Details Reference

  • 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.

  • Policy: The policies applied to the API Version. Click the policy name to display the policy’s Settings dialog.

  • Type: The type of the API policy.

  • Owner: The owner of the API policy.

  • Update: The time that 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 policy’s Settings dialog.

  • Description: The 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.

Troubleshooting Spec Generation Errors

Use the following table to troubleshoot errors when you generate specifications from your API Versions.

Error

Reason

Resolution

Error

Reason

Resolution

No triggered or ultra tasks found in project

The pipeline for the API Version is configured to run an error pipeline, the API version is missing the required Tasks.

Add the required Triggered or Ultra Tasks to the Assets folder for your API Version.

Task "new" has following error(s): No node available for the selected snaplex(Automation2/rt/sidekick/dev)

The Snaplex specified in the API Version details does not have nodes.

Navigate to the Versions tab and specify a Snaplex with nodes from the global shared folder.

Task '"error code pipeline Task" has following error(s): Pipeline not found for ID: some_asset_id

The API Version has the required Tasks, but the Tasks do not specify a pipeline.

Add or create a pipeline for your Task.

Task "ZD61310-TestPipeline Task" has following errors(s):

No details given

The specification for the API Version has an invalid reference: for example, a non existent expression library.

Fix the reference, then upload and generate it.