API Versioning
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 30/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Domain
- api, documentation
Research direction
Start by reviewing the versioning section of the API guidelines and compare its recommendations with the release practices described here. Check the two existing comments for context, then seek agreement on whether the guidance should change; done means the project has an accepted, updated position on API versioning.
Written by the indexing model from the issue text.
Description
Let me first off say, thank you for doing this collaboratively and for all the work that has gone into this.
I do find the versioning section to be very prescriptive. Versioning is hard. Our project currently releases every day and usually has API changes on every release. Not breaking changes, but usually small additions. We're starting to get third-party consumers and will version when we introduce a breaking change.
I feel versioning at this fidelity forces an event driven architecture which is an unneeded complexity for many applications.
Feel free to hit me up in the lab if you'd like to discuss more.
- Dominant language
- No language data
- Stars
- 34
- Forks
- 10
- PR merge metrics
- No merged PRs in 30d
Getting set up
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 bcgov/api-guidelines
-
Difficulty 1/5 Under an hour Newbie friendliness 72/100
bcgov/api-guidelines#34 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 25/100
bcgov/api-guidelines#33 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 55/100
bcgov/api-guidelines#32 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
bcgov/api-guidelines#31 ·
-
It's Been a While Since This Repository has Been UpdatedMay be free again @jeff-card claimed this 1544 days ago, and no pull request is open. Open
bcgov/api-guidelines#28 · 3 comments · 2 assignees ·
All issues in bcgov/api-guidelines
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
SciML/Evolutionary.jl#182 ·
Maintainers usually reply within 1 day
-
Missing GLM modelsOpen
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
simonw/llm-mistral#43 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
rossoctl/context-guru#346 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
prime-radiant-inc/evener#2883 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
GoogleChromeLabs/project-sesame#216 ·
Maintainers usually reply within 12 days