- Notifications
You must be signed in to change notification settings - Fork914
chore(apiversion): add guidelines regarding bumping apiversion#16009
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.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
26 changes: 26 additions & 0 deletionsapiversion/doc.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
// Package apiversion provides an API version type that can be used to validate | ||
// compatibility between two API versions. | ||
// | ||
// NOTE: API VERSIONS ARE NOT SEMANTIC VERSIONS. | ||
// | ||
// API versions are represented as major.minor where major and minor are both | ||
// positive integers. | ||
// | ||
// API versions are not directly tied to a specific release of the software. | ||
// Instead, they are used to represent the capabilities of the server. For | ||
// example, a server that supports API version 1.2 should be able to handle | ||
// requests from clients that support API version 1.0, 1.1, or 1.2. | ||
// However, a server that supports API version 2.0 is not required to handle | ||
// requests from clients that support API version 1.x. | ||
// Clients may need to negotiate with the server to determine the highest | ||
// supported API version. | ||
// | ||
// When making a change to the API, use the following rules to determine the | ||
// next API version: | ||
// 1. If the change is backward-compatible, increment the minor version. | ||
// Examples of backward-compatible changes include adding new fields to | ||
// a response or adding new endpoints. | ||
// 2. If the change is not backward-compatible, increment the major version. | ||
// Examples of non-backward-compatible changes include removing or renaming | ||
// fields. | ||
package apiversion |
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.