Create a cloud-iox ref contract containing a subset of cloud endpoints
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 25/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- openapi
- Domain
- api, cloud, documentation
Research direction
Start with the shared Cloud v2 endpoint consensus document and compare the proposed approaches with ./contracts/ref/ and docs-v2. Done means the relevant IOx endpoints are agreed and represented by the selected contract, tag list, or path/operation list.
Written by the indexing model from the issue text.
Description
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.
- Dominant language
- Shell
- Stars
- 18
- Forks
- 9
- Avg merge
- 2d 18h
- Merged PRs (30d)
- 1
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from influxdata/openapi
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
influxdata/openapi#657 ·
-
Difficulty 1/5 1-3 hours Newbie friendliness 85/100
influxdata/openapi#653 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 65/100
influxdata/openapi#240 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
influxdata/openapi#622 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 50/100
influxdata/openapi#621 ·
All issues in influxdata/openapi
Similar issues
-
area:release bug
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
registrystack/registry-stack#1874 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
AppImage/appimage.github.io#9676 ·
Maintainers usually reply within 1 day
-
Link Checker ReportOpenautomated issue report
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
a2aproject/A2A#2289 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
YunoHost-Apps/pixelfed_ynh#346 ·