optionally include descriptions in schema #585
Conversation
|
Issues linked to changelog: |
use existing field SkipSchemaDescriptions
| @@ -0,0 +1,6 @@ | |||
| changelog: | |||
| - type: NON_USER_FACING | |||
There was a problem hiding this comment.
nit: i think this could be NEW_FEATURE although i don't know if we publish the skv2 changelogs anywhere so this is probably fine
| @@ -19,12 +19,14 @@ import ( | |||
|
|
|||
| // Implementation of JsonSchemaGenerator that uses a plugin for the protocol buffer compiler | |||
| type protocGenerator struct { | |||
| validationSchemaOptions *ValidationSchemaOptions | |||
| validationSchemaOptions *ValidationSchemaOptions | |||
| excludeDescriptionsInSchema bool | |||
There was a problem hiding this comment.
would it make sense to move this field into ValidationSchemaOptions?
then NewProtocGenerator signature doesn't need to change
There was a problem hiding this comment.
It's not related to validation schema specifically, which is why I felt it should be separate
There was a problem hiding this comment.
open to suggestions on how to refactor though.
Maybe a high level options with validationSchemaOpts nested along with the excludeDescriptionsInSchema?
There was a problem hiding this comment.
IMO the skip descriptions flag does sound like it's related to the validation schema options, as they all go into the openapi schema in the CRD. but i could be mistaken as i'm not too familiar with the usage of these options
codegen/render/manifests_renderer.go
Outdated
| @@ -139,7 +139,7 @@ func generateOpenApi(grp model.Group, protoDir string, protoOpts protoutil.Optio | |||
| } | |||
|
|
|||
| // Use protoc-gen-openapi for transpiling protobuf schemas to openapi v3 with k8s structural schema constraints. | |||
| func generateOpenApiFromProtocGen(grp model.Group, protoDir string, _ protoutil.Options, groupOptions model.GroupOptions) (model.OpenApiSchemas, error) { | |||
| func generateOpenApiFromProtocGen(grp model.Group, _ string, _ protoutil.Options, groupOptions model.GroupOptions) (model.OpenApiSchemas, error) { | |||
There was a problem hiding this comment.
any reason not to remove the 2nd and 3rd arg if they aren't used?
|
Going to park this for now. We might try having links to the docs site rather than removing them |
Description
Add an option to exclude descriptions from generated openapi schema. This option existed for the Cue based generation (pr) but not the protoc-gen-openapi path. This can be used to reduce the size of the crds.
PR where this functionality is used: https://github.com/solo-io/gloo-mesh-enterprise/pull/18641. You can see that the descriptions were removed from the CRD.
Context
The GME CRD chart is massive and approaching the limit that can be stored in a k8s secret. Removing the descriptions reduces the size drastically.
BOT NOTES:
resolves https://github.com/solo-io/gloo-mesh-enterprise/issues/18562