Adding read/write json methods to entity #924
Merged
Conversation
This file contains 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
Signed-off-by: Aaron Eline <aeline+github@amazon.com>
2 tasks
aaronjeline
commented
May 29, 2024
| schema, | ||
| self.extensions, | ||
| ); | ||
| checker.validate_entity(&entity)?; |
There was a problem hiding this comment.
I think this API is a potential footgun, wonder if it can be reworked
There was a problem hiding this comment.
Yes. It seems easy to forget to call that, or have a flow through a function that doesn't call it. Violates the parse-don't-validate guideline
There was a problem hiding this comment.
That suggests an alternate API would have a different type for validated and not-yet-validated entities. The validated one would get the Entity name I presume.
Signed-off-by: Aaron Eline <aeline+github@amazon.com> Co-authored-by: John Kastner <130772734+john-h-kastner-aws@users.noreply.github.com>
cdisselkoen
reviewed
May 29, 2024
Signed-off-by: Aaron Eline <aeline+github@amazon.com>
cedar-policy/src/api.rs
Outdated
| @@ -263,6 +263,8 @@ impl Entity { | |||
| } | |||
|
|
|||
| /// Parse an entity from an in-memory JSON value | |||
| /// If a schema is provided, it is handled identically to | |||
| /// [Entities](https://docs.rs/cedar-policy/latest/cedar_policy/struct.Entities.html#method.from_json_str) | |||
There was a problem hiding this comment.
Why not just the auto doc link?
There was a problem hiding this comment.
How do you auto-doc link to a specific method?
There was a problem hiding this comment.
[Entities::from_json_str] i think
Signed-off-by: Aaron Eline <aeline+github@amazon.com>
Signed-off-by: Aaron Eline <aeline+github@amazon.com>
john-h-kastner-aws
approved these changes
May 30, 2024
shaobo-he-aws
approved these changes
May 30, 2024
aaronjeline
deleted the
807-wish-to-have-more-json-parsing-support-for-entities-or-entity-data-type
branch
2 tasks
khieta
pushed a commit
that referenced
this pull request
Aug 8, 2024
Signed-off-by: Aaron Eline <aeline+github@amazon.com> Co-authored-by: John Kastner <130772734+john-h-kastner-aws@users.noreply.github.com>
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description of changes
Adds methods for reading and writing individual
Entityobjects as JSONIssue #, if available
#807
Checklist for requesting a review
The change in this PR is (choose one, and delete the other options):
cedar-policy(e.g., addition of a new API).I confirm that this PR (choose one, and delete the other options):
I confirm that
cedar-spec(choose one, and delete the other options):