Fix duplicate "id" values in JSON schema #750
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The "id" values in JSON schema files must be unique, per RFC draft 8.3.1: > A schema MAY (and likely will) have multiple URIs, but there is no > way for a URI to identify more than one schema. and recent gojsonschema fails when handling such inputs (fairly nontransparently, it silently fails to resolve $ref references to absolute URIs and reports something like > Reference defs.json#/definitions/mapStringString must be canonical .) In particular, the https://opencontainers.org/schema/image/descriptor/annotations id value had three definitions. To resolve this: - Leave the definition in image-index-schema.json; although using the /descriptor subnamespace for the "manifests" array is a bit surprising, the /image/ part clearly belongs to image-index-schema.json - Rename the id definition in content-descriptor.json, to use the generic "blob descriptor" namespace. - Remove the definition in defs-descriptor.json; that seems to be an "utility" schema file describing common structures, but it's better for users to reference schema fragments by purpose than by common structure (so that we can let the structure diverge in the future if necessary). Finally, changing the content-descriptor.json "id" value changes the resolved absolute value of the reference to defs-descriptor.json, so add another namespace to be handled by fsLoaderFactory. Signed-off-by: Miloslav Trmač <mitr@redhat.com>
Signed-off-by: Miloslav Trmač <mitr@redhat.com>
mtrmac
added a commit
to mtrmac/skopeo
that referenced
this pull request
Sep 17, 2018
Temporarily vendor opencontainers/image-spec from a fork to fix "id" value duplication, which is detected and refused by gojsonschema now ( opencontainers/image-spec#750 ). Signed-off-by: Miloslav Trmač <mitr@redhat.com>
|
👍 |
|
LGTM. |
jonboulle
approved these changes
Sep 18, 2018
cyphar
added a commit
that referenced
this pull request
Sep 18, 2018
Run (make schema/fs.go) to make the previous commit effective Fix duplicate "id" values in JSON schema LGTMs: @jonboulle @cyphar Closes #750
mtrmac
added a commit
to mtrmac/skopeo
that referenced
this pull request
Sep 29, 2018
... after opencontainers/image-spec#750 was merged. Signed-off-by: Miloslav Trmač <mitr@redhat.com>
mtrmac
added a commit
to mtrmac/skopeo
that referenced
this pull request
Oct 1, 2018
... after opencontainers/image-spec#750 was merged. Signed-off-by: Miloslav Trmač <mitr@redhat.com>
mtrmac
added a commit
to mtrmac/skopeo
that referenced
this pull request
Oct 20, 2018
... after opencontainers/image-spec#750 was merged. Signed-off-by: Miloslav Trmač <mitr@redhat.com>
mtrmac
added a commit
to mtrmac/skopeo
that referenced
this pull request
Nov 3, 2018
... after opencontainers/image-spec#750 was merged. Signed-off-by: Miloslav Trmač <mitr@redhat.com>
mtrmac
added a commit
to mtrmac/skopeo
that referenced
this pull request
Nov 3, 2018
... after opencontainers/image-spec#750 was merged. Signed-off-by: Miloslav Trmač <mitr@redhat.com>
mtrmac
added a commit
to mtrmac/skopeo
that referenced
this pull request
Nov 8, 2018
... after opencontainers/image-spec#750 was merged. Signed-off-by: Miloslav Trmač <mitr@redhat.com>
mtrmac
added a commit
to mtrmac/skopeo
that referenced
this pull request
Nov 29, 2018
... after opencontainers/image-spec#750 was merged. Signed-off-by: Miloslav Trmač <mitr@redhat.com>
lsm5
pushed a commit
to lsm5/skopeo
that referenced
this pull request
Apr 11, 2019
... after opencontainers/image-spec#750 was merged. Signed-off-by: Miloslav Trmač <mitr@redhat.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
"id"values in JSON schema files must be unique, per RFC draft 8.3.1:and recent
gojsonschemafails when handling such inputs (fairly nontransparently, it silently fails to resolve$refreferences to absolute URIs and reports something like. This is visible in
make test.)In particular, the
https://opencontainers.org/schema/image/descriptor/annotationsidvalue had three definitions. To resolve this:image-index-schema.json; although using the/descriptorsubnamespace for the"manifests"array is a bit surprising, the/image/part clearly belongs toimage-index-schema.json.iddefinition incontent-descriptor.json, to use the generic "blob descriptor" namespace.defs-descriptor.json; that seems to be an "utility" schema file describing common structures, but it's better for users to reference schema fragments by purpose than by common structure (so that we can let the structure diverge in the future if necessary).Finally, changing the content-descriptor.json
"id"value changes the resolved absolute value of the reference todefs-descriptor.json, so add another namespace to be handled byfsLoaderFactory.(As in #739, all I want to do is make the validation work, or, well, not fail. I am expressing no opinion on JSON schema or its use in this project.)