Skip to content

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

@jstirnaman

Description

@jstirnaman

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions