Additional catalog options

Transferring the catalog ownership

To transfer ownership of the Catalog to a different user, perform the following steps:

1. Click Catalog settings and select Overview.
2. Click Edit.
3. From Select owner user, select the user who will become the new owner.
4. If Spaces are enabled in the Catalog then to also have the ownership of all Spaces in the Catalog transferred to the new Catalog owner, select Also transfer ownership of owned Spaces.
5. Click Save to save the changes.

Configuring the publish validations

To configure the publish validations that are performed when a Product is published, perform the following steps:

1. Click Catalog settings and select Publish validations.
2. Click Edit, and select or clear the validation check boxes as required.
   Note: The following validation options can be selected:

   • Publishing APIs with empty paths is not allowed.
   • Validate custom policy schema in assembly.
   • Validate the references inside the API and perform additional OpenAPI validations.
   • Publishing APIs with duplicate base paths is not allowed.
3. Click Save to save the changes.

Configuring the vanity API endpoints

To have an endpoint visible to the consumer that is different to the gateway endpoint, you configure a vanity endpoint. A vanity endpoint represents the endpoint by which an API is known externally; that is, the endpoint that is published to the Developer Portal and is used by an application developer to invoke the API. The way in which the gateway endpoints for an API are determined depends on the OpenAPI version of the API, as follows:

(OpenAPI 3.0): If the API is enforced by the DataPower® API Gateway, the value specified for the first url entry in the servers array in the OpenAPI definition of the API is used to determine the basepath element of the API endpoint, as follows:

1. If a relative URL is specified for the server URL, that value is used as-is for the basepath, and the API endpoint has the following format:

   https://gateway_service_host/provider_organization/catalog/basepath

2. If a full URL is specified for the server URL, the scheme (http:// or https://) is ignored by the DataPower API Gateway, and the remaining host name and basepath are used to form the API endpoint as follows:

   https://gateway_service_host/provider_organization/catalog/host_name/basepath

In these endpoint URLs, the variables are as follows:

• gateway_service_host is the host name of the gateway service on which the API is running.
• provider_organization is the value of the name field of the provider organization that contains the Catalog in which the API is published.
• catalog is the value of the name field of the Catalog in which the API is published.
• host_name is the value of the host name in the server URL.
• basepath is the value of the basepath derived from the server URL.

For details on configuring the server URL in an OpenAPI 3.0 API definition, see Defining servers for an API, Defining servers for a Path, and Defining servers for an operation.

To configure vanity API endpoints, so that you can publish endpoints that are different to these gateway endpoints, complete the following steps:

1. Click API Endpoints in the Catalog settings navigation pane. The Vanity API Endpoint page opens.
2. Click Edit.
3. To display the current API base endpoint settings, select Display vanity endpoint.
4. Select the required Preference setting. Choose one the following settings:
   • Catalog priority: Any host defined in the OpenAPI definition of the API is ignored and all API endpoints always point to the endpoints that you define here. For example, suppose you define a vanity API endpoint, with Catalog priority preference, to be https://prod.acme.com/. Then the API endpoint will be https://prod.acme.com/basepath.
     The way in which the basepath is determined depends on the OpenAPI version of the API, as follows:

     • (OpenAPI 2.0): The basepath is taken from the basepath field in the OpenAPI definition.
     • (OpenAPI 3.0): The basepath is taken from the first url entry in the servers array in the OpenAPI definition, ignoring any scheme (http:// or https://) and host name.
   • API priority: The host defined in the OpenAPI definition for the API takes precedence. For example, suppose you define a vanity API endpoint, with API priority preference, to be https://api.acme.com/. Then the following rules determine the endpoint that is used when an API is called:
     • If the OpenAPI definition has a host defined, test.acme.com for example, then that value is used to determine the API endpoint. For example: https://test.acme.com/basepath.
     • If the OpenAPI definition has no host defined, the API endpoint will be https://api.acme.com/basepath, as determined by the vanity API endpoint setting.
     The way in which any defined host is determined depends on the OpenAPI version of the API, as follows:

     • (OpenAPI 2.0): The host is taken from the host field in the OpenAPI definition.
     • (OpenAPI 3.0): The host is taken from the host name in the first url entry in the servers array in the OpenAPI definition.
5. Supply one or more endpoints, as follows:
   • If you selected Catalog priority, click Add to enter one or more endpoints URLs, and an optional summary for each. Any of the endpoint URLs can be used to invoke an API.
   • If you selected API priority, enter the endpoint URL, and an optional summary.

api.acme.com. CNAME apigw.dc.zone.mycompany.com.

api.acme.com. A 29.12.141.150