New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Create a cloud-iox ref contract containing a subset of cloud endpoints #636

Open

jstirnaman opened this issue Mar 13, 2023 · 0 comments

Contributor

jstirnaman commented Mar 13, 2023

In order to build Cloud IOx HTTP API documentation, we need a contract(s) defining the relevant endpoints for IOx.

For docs' purposes alone, we can achieve this a few different ways:

Option 1: a complete ./contracts/ref/cloud-iox.yml contract maintained in this repo.
Option 2: a list of the relevant tags (if we don't need to exclude specific operations) maintained either in this repo or in docs-v2.
Option 3: a list of the relevant paths and operations (if Option 2 isn't "surgical" enough).

Questions:

Is Option 1 the "correct" way?
If so, is anyone working on that?

I've shared a doc to gather consensus on which current Cloud v2 endpoints are (or will be) relevant for IOx.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment