search

cedar-policy / cedar

Implementation of the Cedar Policy Language
https://www.cedarpolicy.com
Apache License 2.0
775 stars 64 forks source link

Unify "human" vs "natural" vs "Cedar" terminology #842

Open cdisselkoen opened 2 months ago

cdisselkoen commented 2 months ago

Category

User level API features/changes

Describe the feature you'd like to request

The codebase uses different terms for the Cedar/human/natural schema format, including in function and type names. For instance, the CLI uses --schema-format human, but Schema uses from_str_natural() and from_file_natural(). Internally, we have HumanSchemaError and an entire human_schema module in cedar_policy_validator. Our public docs refer to the "human-readable schema format". We should unify our terminology as much as possible.

It's probably not worth breaking APIs over this change, so we should consider just deprecating functions/types and introducing aliases with preferred names, instead of renaming things that are visible in our public API. For internal things, let's rename.

Describe alternatives you've considered

N/A

Additional context

No response

Is this something that you'd be interested in working on?

cdisselkoen commented 4 weeks ago

Found a few places that use "custom", so it's actually "human" vs "natural" vs "Cedar" vs "custom".