API metadata

API metadata provides a way for users to get information about suites, products, and operations within these suites and products through the use of Swagger UI.

API Gateway metadata is an index of suites, products, and operations as found in each endpoints’ Swagger documentation. The API Gateway indexing service runs every five days or whenever an API suite is added or deleted.

While you can search within API Gateway metadata by using the provided Swagger UI, API Gateway metadata is used by other applications to query what suites, products, and operations are available in your environment. To be sure your API is included in API Gateway metadata, add swagger documentation to each of your endpoints as specified in Adding API endpoint documentation.

Troubleshooting API metadata issues

Scenario 1: If the operations are not showing up in the metadata, manually trigger metadata reindexing. This should fix the issue, and this should also fix missing operations in ION workflow, APIFlow, and so on.

Scenario 2: Usually metadata reindexing takes from 15 minutes to 1 hour to complete; however, if the metadata indexing status is stuck at triggered status for a long time, create a dummy non-Infor suite. That should re-trigger metadata, and the status should stabilize after the new refresh is completed.