Skip to Main Content
Status Future consideration
Workspace * IBM Cloud Ideas
Categories Documentation
Created by Guest
Created on Aug 25, 2022

OpenAPI definitions for all IBM Cloud services should be publicly available

https://cloud.ibm.com/docs?tab=api-docs Current OpenAPI definitions for IBM Cloud services are available at above page.


Customers do not have access to collated GITHUB Repo where IBM Cloud maintains OpenAPI definition of all IBM CLoud services.

https://github.ibm.com/cloud-api-docs


If we do not have access to this repository, it becomes extremely difficult to maintain OpenAPI definition versioning. We do not have any way to determine what was the earlier version for specific services and what is the new one.


All other CSPs provide access to there OpenAPI defintions. Examples are provided below.


All other CSPs do provided access to their repos publicly.


Azure -->
https://github.com/Azure/azure-rest-api-specs

AWS --> https://github.com/aws/aws-sdk-java-v2

OCI --> https://docs.oracle.com/en-us/iaas/api/specs/index.json

GCP -> https://www.googleapis.com/discovery/v1/apis









Idea priority Urgent
Needed By Week
  • Guest
    Aug 25, 2022

    I know that OpenAPI definitions are publicly available on individual pages and we can download it. In this case we need to crawl through every page and download the OpenAPI definition for every IBM Cloud service.



    But this does not work for us, we need one collated GITHUB repo where all OpenAPI definitions are available and we can track version history of every OpenAPI definition.

    All other CSPs do provide access to their OpenAPI specs publically.

  • Guest
    Aug 25, 2022

    Thanks for posting a new idea! Most services do make their OpenAPI definition file available for download through the API Reference. To find out if it is available, go the API Reference and click the menu next to the title of the reference in the left navigation. (See attached screenshot)