Skip to content

Conversation

cdisselkoen
Copy link
Contributor

Description of changes

Removes Display from EntityId, as it was unclear whether it should produce an escaped or unescaped representation. Instead, users should choose the explicit .escaped() for the former, or .as_ref() for the latter. Added doc comments to this effect.

Issue #, if available

Fixes #884

Checklist for requesting a review

The change in this PR is (choose one, and delete the other options):

  • A breaking change requiring a major version bump to cedar-policy (e.g., changes to the signature of an existing API).

I confirm that this PR (choose one, and delete the other options):

  • Updates the "Unreleased" section of the CHANGELOG with a description of my change (required for major/minor version bumps).

I confirm that cedar-spec (choose one, and delete the other options):

  • Requires updates, and I have made / will make these updates myself. (Please include in your description a timeline or link to the relevant PR in cedar-spec, and how you have tested that your updates are correct.)

@cdisselkoen cdisselkoen requested review from khieta and aaronjeline May 28, 2024 19:37
Copy link
Contributor

@khieta khieta left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lgtm. @andrewbanchich does this change address your concerns?

@khieta
Copy link
Contributor

khieta commented May 29, 2024

CI failures appear to be caused by a missing cargo fmt.

@andrewbanchich
Copy link
Contributor

Lgtm. @andrewbanchich does this change address your concerns?

Yep, perfect! Thanks!

Signed-off-by: Craig Disselkoen <[email protected]>
@john-h-kastner-aws john-h-kastner-aws added the breaking-change This is (likely) a breaking change label May 29, 2024
@cdisselkoen cdisselkoen merged commit 10e1b27 into main May 29, 2024
@cdisselkoen cdisselkoen deleted the cdisselkoen/entityid-display branch May 29, 2024 19:59
@khieta khieta mentioned this pull request Aug 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking-change This is (likely) a breaking change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

EntityId ToString impl escapes while AsRef<str> does not
6 participants