Allow numbers again #414
Merged
Allow numbers again #414
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
Revert the changes in cnabio#257 which updated the spec to disallow non-integer values. We misunderstood the canonical json spec and were using a library that didn't support numbers. I have an open PRs for cnab-go which tested out switching to a library that support numbers in canonical json and it works great. * cnabio/cnab-go#247 * cnabio/cnab-go#248 So now fields such as default, maximum, minimum, etc can use numbers again! Signed-off-by: Carolyn Van Slyck <me@carolynvanslyck.com>
|
@technosophos @chris-crone I believe this would be a patch to the spec version? I think we will want to bump the spec version after this is merged. |
carolynvs
requested review from
jeremyrickard,
vdice,
jlegrone,
radu-matei,
silvin-lubecki and
technosophos
vdice
reviewed
May 17, 2021
101-bundle-json.md
Outdated
| @@ -415,7 +415,7 @@ of how to use `definitions` along with `parameters` and `outputs` can be seen in | |||
| - `required`: Parameter validation requiring the properties named in the user-provided object include the specified list of properties. MUST be an array of strings. (OPTIONAL) | |||
| - `then`: Parameter validation requiring that the user-provided value match the specified schema. Only matches if the user-provided value matches the schema provided in the `if` property. MUST be a JSON schema. (OPTIONAL) | |||
| - `title`: Short, human-readable descriptive name for the field. Can be used to decorate a user interface. MUST be a string. (OPTIONAL) | |||
| - `type`: Parameter validation requiring that the user-provided value is either a "null", "boolean", "object", "array", "string", or "integer". MUST be a string or an array of strings with unique elements. If you need to represent another numeric type, upscale to an integer or use a string type and convert within your bundle. (OPTIONAL) | |||
| - `type`: Parameter validation requiring that the user-provided value is either a "null", "boolean", "object", "array", "string", or "number". MUST be a string or an array of strings with unique elements. (OPTIONAL) | |||
There was a problem hiding this comment.
We can keep "integer" as well, right? I think it's a valid JSON Schema construct distinct from "number".
Signed-off-by: Carolyn Van Slyck <me@carolynvanslyck.com>
vdice
approved these changes
May 17, 2021
radu-matei
approved these changes
May 17, 2021
|
I'll submit a PR to signy as I already went through the switch for cnab-go. Here are the follow-up PRs to this spec change for cnab-go: |
carolynvs
added a commit
to carolynvs/signy
that referenced
this pull request
May 17, 2021
Per CNAB Spec cnabio/cnab-spec#414, we want to support numbers in our canonical json representation. The library we are currently using, github.com/docker/go/json, does not support this. So I am migrating us to the library mentioned in the spec as being compliant. This is the same library used by cnab-go. I was not able to completely remove the import of the old library because TUF uses its RawMessage struct, which is a very simple wrapper around a byte array. If we are intersted we can try to get TUF to use an interface instead of a hard-coded struct type so that we can drop the dependency on the other canonical json library. Signed-off-by: Carolyn Van Slyck <me@carolynvanslyck.com>
This doesn't break the existing interpretation so I agree! |
carolynvs
added a commit
to carolynvs/signy
that referenced
this pull request
May 19, 2021
Per CNAB Spec cnabio/cnab-spec#414, we want to support numbers in our canonical json representation. The library we are currently using, github.com/docker/go/json, does not support this. So I am migrating us to the library mentioned in the spec as being compliant. This is the same library used by cnab-go. I was not able to completely remove the import of the old library because TUF uses its RawMessage struct, which is a very simple wrapper around a byte array. If we are intersted we can try to get TUF to use an interface instead of a hard-coded struct type so that we can drop the dependency on the other canonical json library. Signed-off-by: Carolyn Van Slyck <me@carolynvanslyck.com>
trishankatdatadog
pushed a commit
to cnabio/signy
that referenced
this pull request
May 24, 2021
* go mod tidy Signed-off-by: Carolyn Van Slyck <me@carolynvanslyck.com> * Switch canonical json libraries Per CNAB Spec cnabio/cnab-spec#414, we want to support numbers in our canonical json representation. The library we are currently using, github.com/docker/go/json, does not support this. So I am migrating us to the library mentioned in the spec as being compliant. This is the same library used by cnab-go. I was not able to completely remove the import of the old library because TUF uses its RawMessage struct, which is a very simple wrapper around a byte array. If we are intersted we can try to get TUF to use an interface instead of a hard-coded struct type so that we can drop the dependency on the other canonical json library. Signed-off-by: Carolyn Van Slyck <me@carolynvanslyck.com> * Make linter happy Rename package to not use an underscore Signed-off-by: Carolyn Van Slyck <me@carolynvanslyck.com> * Remove MarshalToRawMessage This wasn't necessary like I originally thought since []byte converts cleanly to RawMessage by the compiler with any extra code. Signed-off-by: Carolyn Van Slyck <me@carolynvanslyck.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.
Revert the changes in #257 which updated the spec to disallow non-integer values. We misunderstood the canonical json spec and were using a library that didn't support numbers.
I have an open PRs for cnab-go which tested out switching to a library that support numbers in canonical json and it works great.
So now fields such as default, maximum, minimum, etc can use numbers again! 🎉
Closes #413