Document the JSON format used for DRT #125
Labels
backlog
We hope to work on this in the future
documentation
Improvements or additions to documentation
feature-request
Request for a new feature
Category
DRT infrastructure
Describe the feature you'd like to request
PR #124 makes it somewhat easier to customize DRT by abstracting away the details of our Dafny/Java implementation. This allows users to (with minimal work) provide their own implementation of Cedar to differentially test against the
cedar-policy
crate. However, users must figure out for themselves how to translatecedar-policy
types likeRequest
andEntities
into appropriate format for their implementation.In practice, we expect users to use JSON to pass data between Rust and their custom implementation, which is what we currently do for our Dafny/Java implementation. In particular, we rely on the generated
serde_json
JSON representation of thecedar-policy
types. We should document this somewhere, and perhaps change the interfaces introduced in PR #124 to use JSON inputs/outputs rather than structuredcedar-policy
types.Describe alternatives you've considered
No response
Additional context
No response
Is this something that you'd be interested in working on?
The text was updated successfully, but these errors were encountered: