feat: generate json schema for func.yaml

[zroubalik]

Signed-off-by: Zbynek Roubalik zroubali@redhat.com

Changes

• 🎁 Generate json schema for func.yaml

/kind enhancement

Relates: #336

We can generate json schema for func.yaml, the schema could be added to https://www.schemastore.org/json/ -> most of IDEs uses schemastore to enable code completion & validation of certain files for users out of the box:

schema.mp4

I wasn't able to add validation to Envs and Labels, because they internally share the same type Pairs, but the validation of values is different for each type: https://github.com/knative-sandbox/kn-plugin-func/blob/818ec572aa52f12a35bb6b022c2e727ce6ebbfd3/config.go#L120-L123
A solution would be to re-introduce separate Go types for each property.

Release Note

Generate json schema for func.yaml

[lkingland]

This is sure to be a much-appreciated addition by folks editing the func.yaml directly

👍🏻

[knative-prow-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: lkingland, zroubalik

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [lkingland,zroubalik]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[zroubalik]

I wasn't able to add validation to Envs and Labels, because they internally share the same type Pairs, but the validation of values is different for each type:

https://github.com/knative-sandbox/kn-plugin-func/blob/818ec572aa52f12a35bb6b022c2e727ce6ebbfd3/config.go#L120-L123

A solution would be to re-introduce separate Go types for each property.

@lance @matejvasek what do you think about this?

[lance]

@zroubalik I guess I'm not really opposed to this. Of course, I think it's always best to have common/reusable code where possible. But validation is really nice.

[zroubalik]

@zroubalik I guess I'm not really opposed to this. Of course, I think it's always best to have common/reusable code where possible. But validation is really nice.

Yeah, I share the same concern. But in this case it makes sense, this makes me wonder, whether I should make to labels as well, currently they are name&value, but more correct syntax is imho key & value, that would be a breaking change though.

[lkingland]

I vote for key usually, because Name implies a standalone value, whereas Key an index into a structure that uniquely identifies the value that goes with it.