From ab9d0aa2b6a253ce3411b1b0cad9abc0181414b6 Mon Sep 17 00:00:00 2001 From: Ed Bartosh Date: Tue, 29 Oct 2024 18:17:21 +0200 Subject: [PATCH] document version match process Signed-off-by: Ed Bartosh Co-authored-by: Evan Lezar --- SPEC.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/SPEC.md b/SPEC.md index 441ff93..b88922a 100644 --- a/SPEC.md +++ b/SPEC.md @@ -33,6 +33,11 @@ Released versions of the spec are available as Git tags. | | | Add `AdditionalGIDs` to `ContainerEdits` | | v0.8.0 | | Remove .ToOCI() functions from specs-go package. | +*Note*: spec loading fails on unknown fields and when the minimum required version is higher than the version specified in the spec. The minimum required version is determined based on the usage of fields mentioned in the table above. For example the minimum required version is v0.6.0 if the `Annotations` field is used in the spec, but `IntelRdt` is not. +`MinimumRequiredVersion` API can be used to get the minimum required version. + + *Note*: Golang zero default values are used for all new fields so that the spec remains valid when loading older spec versions. + *Note*: The initial release of a **spec** with version `v0.x.0` will be tagged as `v0.x.0` with subsequent changes to the API applicable to this version tagged as `v0.x.y`. ## Overview