mirror of
https://github.com/gravitational/teleport
synced 2024-10-21 17:53:28 +00:00
cd2f4fceb7
* Remove JSON schema validation Removing JSON schema validation from all resource unmarshalers. --- what JSON schema gets us Looking at the JSON schema spec and our usage, here are the supposed benefits: - type validation - make sure incoming data uses the right types for the right fields - required fields - make sure that mandatory fields are set - defaulting - set defaults for fields - documentation - schema definition for our API objects Note that it does _not_ do: - fail on unknown fields in data - fail on a required field with an empty value --- what replaces it Based on the above, it may seem like JSON schema provides value. But it's not the case, let's break it down one by one: - type validation - unmarshaling JSON into a typed Go struct does this - required fields - only checks that the field was provided, doesn't actually check that a value is set (e.g. `"name": ""` will pass the `required` check) - so it's pretty useless for any real validation - and we already have a separate place for proper validation - `CheckAndSetDefaults` methods - defaulting - done in `CheckAndSetDefaults` methods - `Version` is the only annoying field, had to add it in a bunch of objects - documentation - protobuf definitions are the source of truth for our API schema --- the benefits - performance - schema validation does a few rounds of `json.Marshal/Unmarshal` in addition to actual validation; now we simply skip all that - maintenance - no need to keep protobuf and JSON schema definitions in sync anymore - creating new API objects - one error-prone step removed - (future) fewer dependencies - we can _almost_ remove the Go libraries for schema validation (one transient dependency keeping them around) * Remove services.SkipValidation No more JSON schema validation so this option is a noop. |
||
|---|---|---|
| .. | ||
| asciitable | ||
| auth | ||
| backend | ||
| benchmark | ||
| bpf | ||
| cache | ||
| cgroup | ||
| client | ||
| config | ||
| defaults | ||
| events | ||
| fixtures | ||
| fuzz | ||
| httplib | ||
| jwt | ||
| kube | ||
| labels | ||
| limiter | ||
| modules | ||
| multiplexer | ||
| pam | ||
| plugin | ||
| reversetunnel | ||
| secret | ||
| service | ||
| services | ||
| session | ||
| shell | ||
| srv | ||
| sshca | ||
| sshutils | ||
| system | ||
| teleagent | ||
| tlsca | ||
| utils | ||
| web | ||
| runtimeflags.go | ||