KEP-35 Parameters extensions and json schema export #1698
Conversation
Signed-off-by: Andreas Neumann <aneumann@mesosphere.com>
Signed-off-by: Andreas Neumann <aneumann@mesosphere.com>
Signed-off-by: Andreas Neumann <aneumann@mesosphere.com>
keps/0035-json-schema-export.md
Outdated
| All of the additional attributes are fully optional. | ||
|
|
||
| `group` | ||
| An attribute of type "string". This attribute describes a top-level group used for this parameter. |
There was a problem hiding this comment.
so this is just one level group?
There was a problem hiding this comment.
Yes-ish. It would probably be easy enough to allow multiple levels by separating the groups by / or ., but for now only one level is supported. Although it might be a good idea to reserve a separation character already.
Any preferences?
keps/0035-json-schema-export.md
Outdated
|
|
||
| ### JSON-Schema export | ||
|
|
||
| Extend the `kudo package list parameters` with an option `--output json-schema` to describe the parameters as JSON-Schema. |
There was a problem hiding this comment.
I wonder how we can output a JSON-schema in YAML with this way though... --output yaml-schema is not really correct, --output json-schema-as-yaml might work, but is quite long...
And it might be nice to have the output as yaml, as the KEP-33 will support a JSON-Schema defined in a yaml file, so it would help with the conversion, and yaml is more common in the k8s world. But we can also add that later if required.
Signed-off-by: Andreas Neumann <aneumann@mesosphere.com>
keps/0035-json-schema-export.md
Outdated
|
|
||
| Extend the `kudo package list parameters` with an option `--output json-schema` to describe the parameters as JSON-Schema. | ||
|
|
||
| Alternatively, add a new command `kudo package list json-schema`, which then could be used with `--output json` or `--output yaml` to export the JSON-Schema in both variants. |
There was a problem hiding this comment.
The kudo package list parameters sounds better but I like the possibility of having YAML/JSON as output format.
There was a problem hiding this comment.
I've adjusted the proposal, found a (in my mind) even better solution.
Signed-off-by: Andreas Neumann <aneumann@mesosphere.com>
Signed-off-by: Andreas Neumann <aneumann@mesosphere.com>
keps/0035-json-schema-export.md
Outdated
|
|
||
| To bring the parameters up to par with JSON-schema, we add these additional types: | ||
| - `boolean` A "true" or "false" value, from the JSON "true" or "false" productions | ||
| - `number` An arbitrary-precision, base-10 decimal number value, from the JSON "number" production |
There was a problem hiding this comment.
In Javascript and therefore in JSON, number is a double-precision float, should we use that definition here instead?
| `kudo package list parameters --output json-schema` | ||
| Outputs the parameters as JSON-Schema | ||
|
|
||
| `kudo package list parameters --output json-schema-yaml` |
There was a problem hiding this comment.
Hm, I'm not sure about this. --output is about the output format. If we say that YAML is one and JSON too, can we really say that json-schema is one too? And json-schema-yaml sounds strange to me (what is it now? JSON? YAML? Both?)
There was a problem hiding this comment.
I've had another approach here: f9e3294#diff-78066f3086b3541869b714f9b97d9814R143
Where I used --output and --format, but @alenkacz convinced me that using only --output would be ok. We copied that parameter from kubectl, which also uses multiple variants ( i.e. -o wide, etc.)
As for --output json-schema-yaml I agree that it's a bit cumbersome, but better than --output json-schema-as-yaml and --output yaml-schema is really wrong in my eyes.
I feel this is the most pragmatic approach
Signed-off-by: Andreas Neumann <aneumann@mesosphere.com>
What this PR does / why we need it:
This KEP describes:
This can be a first step to KEP-33 (Structured Parameters)