Define what the OpenAPI info.version means and add a changelog
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 75/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Domain
- documentation
Research direction
Start with the info.version field in docs/api/openapi.yaml and docs/api/harness-openapi.yaml, then read docs/reference/change-policy.md from PR #506. Add a sentence to each spec stating that the version tracks the /v1 contract, with the minor bumped for additive changes and the major bumped only alongside a /v2. Add a short changelog to each file or link one, and state the same rule on the policy page. Done when both specs and the policy page say the same thing and a changelog entry exists.
Written by the indexing model from the issue text.
Description
Follow-up from the change policy (docs/reference/change-policy.md, PR #506).
Both docs/api/openapi.yaml and docs/api/harness-openapi.yaml say version: 1.0.0 with no stated meaning.
Decision: it is the version of the /v1 contract. Bump the minor for additive changes; bump the major only together with a /v2. Add a short changelog to each file (or a linked changelog) and mention the rule in the policy page.
- Dominant language
- TypeScript
- Stars
- 5
- Forks
- 11
- Avg merge
- 8h 58m
- Merged PRs (30d)
- 154
Getting set up
- Ships a Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
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 rossoctl/moca
-
Difficulty 2/5 1-3 hours Newbie friendliness 77/100
Maintainers usually reply within 1 day
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 64/100
Maintainers usually reply within 1 day
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
rossoctl/moca#421 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
Maintainers usually reply within 1 day
Similar issues
-
calcite-ui-icons enhancement impact - p3 - not time sensitive needs triage
Difficulty 2/5 1-3 hours Newbie friendliness 67/100
Esri/calcite-design-system#15467 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
diegosouzapw/OmniRoute#18390 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
Difficulty 1/5 1-3 hours Newbie friendliness 86/100
guilhermerodz/input-otp#157 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
davidjerleke/embla-carousel#1414 ·
Maintainers usually reply within 4 days