My Oracle Support Banner

Issues With Swagger API Documentation (Doc ID 2355671.1)

Last updated on OCTOBER 27, 2020

Applies to:

Oracle Commerce Cloud Service - Version N/A and later
Information in this document applies to any platform.


There are numerous issues with the Swagger API documentation returned by the call to '/ccadmin/v1/metadata-catalog' with the 'Accept' header set to 'application/swagger+json'. Swagger provides utilities to use the API documentation to generate client libraries, but the usefulness and correctness of the generated code is hurt by deficiencies in the documentation. Also, certain issues, such as ambiguous field names, or lack of description for formatted string fields make the API more difficult to consume, requiring trial and error to discover the actual behavior. There is also a general lack of polish throughout the API, such as having no consistent naming convention.


To view full details, sign in with your My Oracle Support account.

Don't have a My Oracle Support account? Click to get started!

My Oracle Support provides customers with access to over a million knowledge articles and a vibrant support community of peers and Oracle experts.