Removing keys beginning with x-ibm from Open API document download

You can remove keys that begin with x-ibm from the Open API document download in the Developer Portal.

Before you begin

You must have administrator access to the Developer Portal to complete this task.

About this task

By removing keys that begin with x-ibm from the Open API document download, you can download the Open API documents without any key-value pairs that are IBM specific. Enabling this configuration setting removes the information about the API Management provider from the Open API document that is downloaded in the Developer Portal.
Warning: Removing keys that begins with x-ibm from the Open API document download also removes certain details from the downloaded API document. For example, the x-ibm-languages key that provides language support to the API will be removed from the downloaded API document after you enable this configuration.

Procedure

To remove keys that begin with x-ibm from the Open API document download in the Developer Portal, complete the following steps:

  1. Log in to the Developer Portal as an administrator.
  2. If the administrator dashboard is not displayed, click Manage to display it.
  3. Click Configuration > System > IBM API Developer Portal.
    The Configure the IBM API Developer Portal page is displayed.
  4. Select the Remove keys beginning with x-ibm from Open API document download option.The Remove keys beginning with x-ibm from Open API document download option is selected in the IBM API Developer Portal configuration settings
  5. Click Save configuration to save the changes.
    The keys beginning with x-ibm is removed from the JSON or YAML download of the Open API definition.