Skip to content

Commit ec7ca91

Browse files
committed
Merge pull request #309 from vbatts/version_name
config: qualify the name of the version field
2 parents ed08c12 + 4e63ee0 commit ec7ca91

File tree

2 files changed

+7
-4
lines changed

2 files changed

+7
-4
lines changed

config.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ package specs
55
// bundle is packaged for distribution.
66
type Spec struct {
77
// Version is the version of the specification that is supported.
8-
Version string `json:"version"`
8+
Version string `json:"ociVersion"`
99
// Platform is the host information for OS and Arch.
1010
Platform Platform `json:"platform"`
1111
// Process is the container's main process.

config.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,17 @@ This includes the process to run, environment variables to inject, sandboxing fe
88

99
Below is a detailed description of each field defined in the configuration format.
1010

11-
## Manifest version
11+
## Specification version
1212

13-
* **`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.
13+
* **`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.
14+
The OpenContainer spec follows semantic versioning and retains forward and backward compatibility within major versions.
15+
For example, if an implementation is compliant with version 1.0.1 of the spec, it is compatible with the complete 1.x series.
16+
NOTE that there is no guarantee for forward or backward compatibility for version 0.x.
1417

1518
*Example*
1619

1720
```json
18-
"version": "0.1.0"
21+
"ociVersion": "0.1.0"
1922
```
2023

2124
## Root Configuration

0 commit comments

Comments
 (0)