image-index: mark os.version, os.features and variant as "reserved"

These properties seems unclear and not suitable for standardization at the moment. Signed-off-by: Akihiro Suda <suda.akihiro@lab.ntt.co.jp>
opencontainers · Apr 10, 2017 · 1738745 · 1738745
1 parent a90602e
commit 1738745
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 7 deletions.
diff --git a/image-index.md b/image-index.md
@@ -55,15 +55,15 @@ For the media type(s) that this document is compatible with, see the [matrix][ma
 
     - **`os.version`** *string*
 
-        This OPTIONAL property specifies the operating system version, for example `10.0.10586`.
+        This OPTIONAL property is *reserved* for future versions of the specification and hence SHOULD NOT be used.
 
     - **`os.features`** *array of strings*
 
-        This OPTIONAL property specifies an array of strings, each specifying a mandatory OS feature (for example on Windows `win32k`).
+        This OPTIONAL property is *reserved* for future versions of the specification and hence SHOULD NOT be used.
 
     - **`variant`** *string*
 
-        This OPTIONAL property specifies the variant of the CPU, for example `armv6l` to specify a particular CPU variant of the ARM CPU.
+        This OPTIONAL property is *reserved* for future versions of the specification and hence SHOULD NOT be used.
 
     - **`features`** *array of strings*
 

diff --git a/specs-go/v1/descriptor.go b/specs-go/v1/descriptor.go
@@ -51,15 +51,16 @@ type Platform struct {
 	OS string `json:"os"`
 
 	// OSVersion is an optional field specifying the operating system
-	// version, for example `10.0.10586`.
+	// version. This property is reserved and SHOULD NOT be used.
 	OSVersion string `json:"os.version,omitempty"`
 
 	// OSFeatures is an optional field specifying an array of strings,
-	// each listing a required OS feature (for example on Windows `win32k`).
+	// each listing a required OS feature. This property is reserved and
+	// SHOULD NOT be used.
 	OSFeatures []string `json:"os.features,omitempty"`
 
-	// Variant is an optional field specifying a variant of the CPU, for
-	// example `ppc64le` to specify a little-endian version of a PowerPC CPU.
+	// Variant is an optional field specifying a variant of the CPU.
+	// This property is reserved and SHOULD NOT be used.
 	Variant string `json:"variant,omitempty"`
 
 	// Features is an optional field specifying an array of strings, each