Use REQUIRED properties instead of base properties
#583
Conversation
mikebrow
left a comment
mikebrow
left a comment
There was a problem hiding this comment.
Suggestions for not repeating REQUIRED language.
| While this property MUST be present, the size of the array MAY be zero. | ||
|
|
||
| Each object in `manifests` has the base properties of [descriptor](descriptor.md) with the following additional properties and restrictions: | ||
| Each object in `manifests` has the REQUIRED properties of [descriptor](descriptor.md) with the following additional properties and restrictions: |
There was a problem hiding this comment.
Suggest:
Each object in `manifests` includes a set of [descriptor properties](descriptor.md#properties) with the following additional properties and restrictions:
There was a problem hiding this comment.
@mikebrow is a set of also not clear on which property is required and which is not requred?
There was a problem hiding this comment.
Yes. The point is, we are repeating the REQUIRED statement which is located in the forward reference document.
There was a problem hiding this comment.
+1 to @mikebrow's wording. We're also including OPTIONAL descriptor properties in this extension, not just the REQUIRED properties.
image-layout.md
Outdated
| - It MUST exist | ||
| - It MUST be a JSON object | ||
| - It MUST have the base properties of an [image index](image-index.md). | ||
| - It MUST have the REQUIRED properties of an [image index](image-index.md). |
There was a problem hiding this comment.
Suggest:
It MUST include [image index properties](image-index.md).
There was a problem hiding this comment.
How about consolidating the last two lines:
index.jsonfile
- It MUST exist.
- It MUST be an image index JSON object.
Or alternatively:
index.jsonfile
- It MUST exist.
- It MUST be a valid
application/vnd.oci.image.index.v1+json.
|
is this PR waiting on updates, @coolljt0725 ? |
|
@vbatts sorry for the late response, updated |
`base properties` is not quite clear because we don't define which property is the base properties and which is not the base properties. Use `REQUIRED properties` to make it more clear. Signed-off-by: Lei Jitang <[email protected]>
|
LGTM |
5 participants
base propertiesis not quite clear because we don'tdefine which property is the base properties and which
is not the base properties. Use
REQUIRED propertiesto make it more clear.
Signed-off-by: Lei Jitang [email protected]