Skip to content

Commit

Permalink
config: qualify the name of the version field
Browse files Browse the repository at this point in the history
#110

Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>
  • Loading branch information
vbatts committed Jan 13, 2016
1 parent 353631a commit 4b57e29
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
2 changes: 1 addition & 1 deletion config.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ package specs
// bundle is packaged for distribution.
type Spec struct {
// Version is the version of the specification that is supported.
Version string `json:"version"`
Version string `json:"spec_version"`
// Platform is the host information for OS and Arch.
Platform Platform `json:"platform"`
// Process is the container's main process.
Expand Down
9 changes: 6 additions & 3 deletions config.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

## 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.
* **`spec_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 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*

```json
"version": "0.1.0"
"spec_version": "0.1.0"
```

## Root Configuration
Expand Down

0 comments on commit 4b57e29

Please sign in to comment.