config: qualify the name of the version field

https://github.com/opencontainers/specs/issues/110

Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>
This commit is contained in:
Vincent Batts 2016-01-13 18:10:54 -05:00
parent 353631ab5e
commit 4e63ee0a1e
2 changed files with 7 additions and 4 deletions

View File

@ -5,7 +5,7 @@ package specs
// bundle is packaged for distribution. // bundle is packaged for distribution.
type Spec struct { type Spec struct {
// Version is the version of the specification that is supported. // Version is the version of the specification that is supported.
Version string `json:"version"` Version string `json:"ociVersion"`
// Platform is the host information for OS and Arch. // Platform is the host information for OS and Arch.
Platform Platform `json:"platform"` Platform Platform `json:"platform"`
// Process is the container's main process. // Process is the container's main process.

View File

@ -8,14 +8,17 @@ This includes the process to run, environment variables to inject, sandboxing fe
Below is a detailed description of each field defined in the configuration format. Below is a detailed description of each field defined in the configuration format.
## Manifest version ## Specification version
* **`version`** (string, required) must be in [SemVer v2.0.0](http://semver.org/spec/v2.0.0.html) format and specifies the version of the OCF specification with which the container bundle complies. The Open Container spec follows semantic versioning and retains forward and backward compatibility within major versions. For example, if an implementation is compliant with version 1.0.1 of the spec, it is compatible with the complete 1.x series. NOTE that there is no guarantee for forward or backward compatibility for version 0.x. * **`ociVersion`** (string, required) must be in [SemVer v2.0.0](http://semver.org/spec/v2.0.0.html) format and specifies the version of the OpenContainer specification with which the bundle complies.
The OpenContainer spec follows semantic versioning and retains forward and backward compatibility within major versions.
For example, if an implementation is compliant with version 1.0.1 of the spec, it is compatible with the complete 1.x series.
NOTE that there is no guarantee for forward or backward compatibility for version 0.x.
*Example* *Example*
```json ```json
"version": "0.1.0" "ociVersion": "0.1.0"
``` ```
## Root Configuration ## Root Configuration