From eea068cea9245130ccfaa06f34f0b4e5dbeb2f6d Mon Sep 17 00:00:00 2001 From: Cian Johnston Date: Thu, 2 Jan 2025 09:44:51 +0000 Subject: [PATCH] chore(apiversion): add guidelines regarding bumping apiversion --- apiversion/doc.go | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 apiversion/doc.go diff --git a/apiversion/doc.go b/apiversion/doc.go new file mode 100644 index 0000000000000..3c4eb9cfd9ea9 --- /dev/null +++ b/apiversion/doc.go @@ -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 pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy