docs: document the new validateInstance API#135
Open
mttrbrts wants to merge 1 commit into
Open
Conversation
…odelManager Rewrites the "Validating Data" page to lead with the ergonomic validateInstance / validateInstanceOrThrow / isValidInstance trio added in accordproject/concerto#1240, with diagnostic shape, codes table, aggregation contract, and a form-validation worked example. Keeps the existing Serializer.fromJSON example as the lower-level alternative. Signed-off-by: Matt Roberts <code@rbrts.uk>
✅ Deploy Preview for concerto-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Updates the "Validating Data" page to lead with the ergonomic
validateInstanceAPI added in accordproject/concerto#1240, while keeping the existingSerializer.fromJSONexample as a lower-level alternative.The new page covers:
validateInstance/validateInstanceOrThrow/isValidInstanceon bothModelManagerandClassDeclarationValidationResultshape and theDiagnostictypeMISSING_REQUIRED_FIELD,TYPE_MISMATCH,VALIDATOR_VIOLATION, etc.)DESERIALIZATION_ERROR)generateSample()for round-trippable sample dataTest plan
npm run startrenders the page without broken links