schema-validation.md

Schema validation

We validate values with our values-schema.yaml JSON Schema.

Guidelines for describing strings

By having accurate and consistent descriptions (refer to description keys in values-schema.yaml), we can provide a better experience in configuring otomi-values. Refer to the Kubernetes API documentation on conventions for description writing.

Examples

Excellent:

oauth2-proxy:
   type: object
   additionalProperties: false
   properties:
      config:
      type: object
         properties:
      cookieSecret:
         type: string
         description: Must be a 128 bit base64 encoded string.
         pattern: ^(?:[A-Za-z0-9+/]{4})\\\*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?\$

Seeing a small improvement:

armAuth:
   type: object
   additionalProperties: false
   description: A service Principal secret
   properties:
   secretJSON:
      description: A service Principal secret JSON key (base64 encoded)
      type: string

This could be modified to:

armAuth:
   type: object
   additionalProperties: false
   description: A service Principal secret
   properties:
   secretJSON:
      description: Must be a service Principal secret JSON key (base64 encoded)
      type: string

etc.