Configuring the API metadata file data source properties

Using the API metadata file data source from an SDK is a good option, for example, for cases when you have network restrictions for using the Web data source option. This data source only requires a suitable SDK to be present.

To configure the API metadata file data source, do the following:

  1. On the Properties tab, select API Metadata files from the SDK from the Data Source drop-down list.

  2. From the listbox, select an SDK from your local workstation.To aid selection ,cached/uncached information is displayed against each sdk.

    With applicable SDKs, API Query starts seeking for the existing .metaxml files from the SDK.

    If you have problems with the SDK, see the Tips and hints below for more information.

Next, you can start an API query either from the Search tab or from the context menu of your project. For instructions, see the Tasks section in the Table of Contents in API Query Help.

Tips and hints for API metadata file data source

Situation Solution

The selected SDK does not contain any API metadata .metaxml files.

The SDK cannot be used in API queries. Select another SDK and try again.

Some of the data sources cannot be loaded.

The SDK contains API metadata files that are not formally valid XML. These files are excluded from API queries.

(If possible, to fix the issue, notify the API's responsible person about the problem.)

The SDK contents have changed since it was first loaded.

You can refresh the local cache of the specified SDK by clicking Refresh cache.

Refreshing the SDK data is useful in cases when the metadata files have been updated or errors detected earlier have been corrected.