search

phylum-dev / documentation

Documentation for the Phylum products
1 stars 1 forks source link

update policy documentation for v1 #152

Closed matt-phylum closed 1 month ago

matt-phylum commented 1 month ago

This PR updates the policy documentation to reflect the new policy.v1 format. The previous format still works, but the new format is preferred.

There's currently an issue with the policy SDK zip where the root element is missing. I'm pretty sure it was unintentional and there isn't a trick to making the opa CLI load data with a prefix. It should be like this one:

constants.json

Checklist

louislang commented 1 month ago

Do we need to do something to update the constants.json in the SDK?

matt-phylum commented 1 month ago

Yes, but it doesn't block this PR.

There has been some talk about hosting the SDK from the policy repo on GitHub. constants.json is generated based on the code in the API service, but the constants and the other files in the SDK change infrequently so if we wanted to put them on GitHub that would skip waiting for a new API deployment.