Known limitations

• You cannot rename the top level schema.
• The top level schema doesn't display the minProperties, maxProperties, and enum properties for the definition.
• The OneOf, AllOf, and Enum schema structures aren't handled properly by the UI.

1. Download and extract API Designer, then install the credentials file as explained in steps 1, 2, and 7 in Setting up the API Connect toolkit.

2. Edit the designer_credentials.json file and configure the following settings:
   • "endpoint": "https://localhost"

   • "manager_endpoint": "https://localhost/manager"

   • "client_id": Client Id

     The client ID displays on the console when you start the LTE platform-apic-lte. For more information, see Testing an API with the Local Test Environment.

   • "client_secret": Client Secret

     The client secret displays on the console when you start the LTE platform-apic-lte. For more information, see Testing an API with the Local Test Environment.

3. Start API Designer and log in with the LTE using https://localhost as the Host URL (the management endpoint).

• If you plan to provision or work with API Connect Enterprise as a Service, you must first update your IBMid (or create a new one) so that it matches your primary email address.
• If you already provisioned an instance of API Connect Enterprise as a Service using an unsupported IBMid, do one of the following:
  • Ask IBM Support to delete the instance before updating your IBMid and provisioning a new instance.
  • Create a new IBMid with an email address that matches your primary email address, and then provision a new instance.

1. On your local file system, locate the autoproduct file called API-NAME-auto-product_API-VERSION.yaml.
2. Delete the file.
3. In API Designer, edit the newly imported API and activate it by clicking the Online toggle.

In general, it is best practice to activate an API using the Online toggle or by publishing the API with the Publish option.

• Developers that have been given only View permissions cannot see the Test tab in the API editor. For developers to be able to see the Test tab, they must be given a different permission level. For information about the default permission levels available, see API Connect user roles.
• Users with API-Drafts permissions, but who don't have any Sandbox Catalog permissions, cannot see the Test preferences in the Sandbox Catalog. For these users to be able to see the Test preferences, they must be given the Developer or Administrator role on the Sandbox Catalog.

• Reload the browser window.
• If there is still an issue, clear the browser cache and then log back in to the UI.
• Try using a private browser window.
• If possible, try a different browser type.

• clustermgmt:catAllocation
• clustermgmt:catIndices
• clustermgmt:catNodes
• clustermgmt:catRecovery
• clustermgmt:catShards
• clustermgmt:catAliases

• clustermgmt:getNodesHotThreads
• clustermgmt:getNodesHotThreadsById

• "X-BurstLimit-Limit"
• "X-BurstLimit-Remaining"

• "X-RateLimit-Limit"
• "X-RateLimit-Remaining"

Note that this limitation does not apply to assembly burst limits.

The workaround is to using the 'Lax' SameSite Cookie attribute.

• Remove the rate limit definition from the OpenAPI source for the API. For example, if the source is in YAML format, remove the following lines:

  - name: graphql-input-type-cost
    operation: consume

• Edit the source for the Product and define a graphql-input-type-cost rate limit in all of the Plans that include the API.
  Note: You can edit only a manually created Product, not a Product that is generated by the automatic activation mechanism.

For example, if you configure three different user registries for a particular Developer Portal site, the email address alice@acme.com can be used to log in to the site from only one of the user registries.

You can create and update user registries with the apic user-registries:create and apic user-registries:update commands. Both commands accept the external_group_mapping_enabled option. If you then create a configured user registry with the configured_catalog_user_registries:create command, the results depend on how you set the external_group_mapping_enabled option in the user registry.

Suppose you create a user registry (for example, call it UR) and you want to create a configured user registry (call it CUR) based on UR. Consider the following scenarios:

1. You create UR with the external_group_mapping_enabled: false. In this case, you can create your CUR based on that registry.

2. You create UR with external_group_mapping_enabled: true. In this case, you cannot base a configured user registry on it, so the creation of CUR fails.

3. You create UR with external_group_mapping_enabled: false and create CUR based on it, as in scenario 1. However, you then update UR and set external_group_mapping_enabled: true. In this case, you have a problem.
   The operation described in scenario 3 is not currently blocked, so you will successfully create an unsupported CUR and then run into errors when you attempt to onboard users. To resolve the issue, complete one of the following workarounds:

   • Update UR (the base user registry) and set external_group_mapping_enabled: false.
   • Leave UR with external_group_mapping_enabled: true but delete the configured registry (CUR) that is based on it.

Parser failed with error: syntax error, variables type is neither a JSON object nor null.

To resolve this problem, modify the query to remove the variable definitions before re-sending the HTTP request.

- Must validate at least one schema (anyOf) (context: (root).paths./example/types.post.parameters.0.schema.properties.items, line: 0, col: 0)
- Must validate one and only one schema (oneOf) (context: (root).paths./example/types.post.parameters.0, line: 46164, col: 21)
- paths./example/types.post.parameters.0.schema.properties.items.properties.pattern Does not match format 'regex' (context: (root).paths./example/types.post.parameters.0.schema.properties.items.properties.pattern, line: 0, col: 0)

• The ID Name field is required, but the API definition can be saved without entering a value in the field.
• The Secret Name field is required only when the Secret Required option is selected, but the user interface indicates that the Secret Name field is required regardless. Furthermore, when the field is required, the API definition can be save without entering a value.
• If the Authenticate Client Method is set to Third party, the User Registry Name field is required, but the API definition can be saved without entering a value in this field.

catalogs:
    apic-dev:
      properties:
        runtime-url: $(TARGET_URL)
    sb:
      properties:
        runtime-url: 'http://localhost:4001

For example, if an assembly includes a switch policy containing four redact conditions followed by an invoke policy, each redact condition redacts the response data. After porting to the API Gateway, the redact conditions remain inside the switch policy and target the message.body property for redaction. These redactions fail to execute because the message.body property has not yet been retrieved by the invoke policy. To correct this problem, you must move the invoke policy before the switch policy in the assembly.

/cloud/events?response_http_headers[X-Client-IP]=not:10.51.11.183&response_http_headers[X-Client-IP]=not:10.51.11.184

• You cannot extract or redact content from the same source that is defined in the root. For example, if the root is defined as message.body.a, the action fails if the content to extract or redact is defined as the entire input.

  As a workaround, remove the last element of the root and define that element as the content to extract or redact. For the previous example, define root as message.body and the content as a.

• New JSON objects cannot be constructed from the capture field that is specified in an Extract policy. As a workaround, use the transform expression $merge([]) to construct the empty object. You can then specify more extracts as needed for key-value pairs.
• If soft linked copies of a field exist in different locations, an Extract or Redaction policy can cause content from all of the linked fields to be extracted or redacted. As a workaround for the Extract policy, use the $merge($spread($)) object function to construct new, unlinked objects and arrays. For example, the following transform expressions construct unlinked copies of the field c.

  \"a\": $merge($spread($.c)
  \"b\": $merge($spread($.c)