Generate descriptions for parameters

[stek29]

Currently there's no way to generate @parameters with description

I'm not sure what would be the best way to document them, but this might be an option:

having:

# @parameter exemptImages array string
#  Any container that uses an image that matches an entry in this list will be excluded
#  from enforcement. Prefix-matching can be signified with `*`. For example: `my-image-*`.

generate:

properties:
  exemptImages:
    description: >-
      Any container that uses an image that matches an entry in this list will be excluded
      from enforcement. Prefix-matching can be signified with `*`. For example: `my-image-*`.
    type: array
    items:
      type: string

[jalseth]

H @stek29, thanks for opening the issue! I think this makes sense. From an implementation standpoint, I think it may be easier if there's an indicator on the same line as the @parameter tag that lets Konstraint know to expect a description.

For example, all the three following scenarios would generate the same description.

# @parameter foo string -- Parameter foo is a string

# @parameter foo string -- Parameter foo
#  is a string

# @paramater foo string --
#  Parameter foo is a string

As always, I'd welcome a PR!

[stek29]

@jalseth I've submitted the pull request.