API Catalog

blank

Displays instructions for configuring autocompletion

bash

Installs autocompletion using Bash shell settings

zsh

Installs autocompletion using Z shell settings

-r, --refresh cache

Removes the current autocompletion configuration. Use this before running the command with a different shell type.

-d, --delete

Deletes the config file entry for the given key

-h, --help

Shows the help for this command

-k, --key=key

Shows the value that corresponds with the given key

-v, --value=value

Shows the key that corresponds with the given value

-d, --file=file

Default: catalog.yaml

The name and location in which to save the generated catalog descriptor file

--external

Generates an exchange.json file for each API described in the descriptor file and adds a reference to each of those in the descriptor file using the ref tag in the projects section

-d, --descriptor-file=descriptor-file

Default: catalog.yaml

The name and location in which to save the updated catalog descriptor file information

--async

Runs the publish job asynchronously.

-d, --descriptor-file=descriptor-file

or

ANYPOINT_DESCRIPTOR_FILE environment variable

Default: ./catalog.yaml

The name and location of the catalog descriptor file.

See Create a Descriptor File Using the CLI.

--dry-run

Runs the command to verify that the descriptor file is valid. No APIs are published.

--force-publish

Bypasses the comparison and creates a new version of the asset in Exchange regardless of the content.

--force-update-metadata

Updates the asset’s metadata, such as tags, in the latest version in Exchange regardless of the content. This does not republish the asset.

--json

Prints the execution result in JSON format.

-s, --silent

Enables silent logging.

-t, --trigger-criteria=<descriptor-tag>:<value> --trigger-criteria=<descriptor-tag>:value

This flag works in conjunction with the triggerConditions section in the descriptor file. For each run of the api-catalog publish-asset command, the trigger values are compared to trigger condition values in the descriptor file to determine whether to publish the APIs described in the descriptor file. To match multiple conditions, specify separate --trigger-criteria flags for each condition. For the APIs to be published, all trigger conditions set in the descriptor file must be matched by --trigger-criteria flag values.

Example:

--trigger-criteria=branch:main --trigger-criteria=anytag:release/ --trigger=user:admin

See Descriptor YAML Schema.

-v, --verbose

Enables verbose logging.

--version-strategy-criteria=<descriptor-tag>:<value>

This flag works in conjunction with the versionStrategyConditions section in the descriptor file. The api-catalog publish-asset command compares the version strategy criteria values to version strategy condition values in the descriptor file to determine the version strategy to use to publish the APIs. To match multiple conditions, specify separate --version-strategy-criteria flags for each condition.

Example:

--version-strategy-criteria=branch:main --version-strategy-criteria=anytag:release/ --version-strategy-criteria=user:admin

See Descriptor YAML Schema.

--client_id=client_id

or

ANYPOINT_CLIENT_ID environment variable

Connected app client ID

See Authentication.

--client_secret

or

ANYPOINT_CLIENT_SECRET environment variable

Prompt for the connected app secret for the client ID

See Authentication.

--collectMetrics

or

COLLECT_METRICS environment variable

Not currently used

--environment=environment

or

ANYPOINT_ENV environment variable

The name of the Anypoint Platform environment where the APIs are cataloged

--host=host

or

ANYPOINT_HOST environment variable

Default:

The Anypoint Platform base URL without the protocol

For the US Anypoint Platform, use:

For the European Anypoint Platform, use:

--organization=organization

or

ANYPOINT_ORG environment variable

The ID of the Anypoint Platform organization where the APIs are cataloged

-p, --password

or

ANYPOINT_PASSWORD environment variable

Anypoint user password

See Authentication.

-u, --username=username

or

ANYPOINT_USERNAME environment variable

Anypoint username

See Authentication.