Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

lexicon: document PDS validation behavior #353

Open
bnewbold opened this issue Oct 14, 2024 · 0 comments
Open

lexicon: document PDS validation behavior #353

bnewbold opened this issue Oct 14, 2024 · 0 comments
Labels

Comments

@bnewbold
Copy link
Contributor

PDS has three Lexicon validation options when creating (or updating) records:

  • explicit validation required: the record must be validated against a Lexicon schema. If the PDS does not know of the Lexicon, and/or can not resolve it on demand, the record creation fails
  • explicit no validation: the record is not validated against any Lexicon, even if the PDS knows the Lexicon locally. the record still has to pass data validation rules (eg, no malformed blob objects at any nested depth)
  • optimistic validation (default if no explicit argument): if the PDS knows the record Lexicon, it validates. but if it does not know it, and can't resolve it (or does not do live validation), the record is allowed to be created. aka, "fail open".

In success responses, where the record was persisted in the repository, a flag indicates if Lexicon validation happened or not.

This behavior should be added to the Lexicon specs.

@bnewbold bnewbold added the specs label Oct 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant