Issues With Swagger API Documentation

(Doc ID 2355671.1)

Last updated on FEBRUARY 07, 2018

Applies to:

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

Goal

On : NA version, Store Administration

Issues with Swagger API documentation

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. Attached is a document containing specific issues with the API and its documentation.
 

Solution

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 hundreds of Community platforms