Repository navigation
Conversation
4ee2cdb to
f7ce4b6
Compare
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues are reported for the documentation-only update to policy examples and inheritance guidance.
No open issues 🎉
What changed in this PR
This documentation-only PR updates the unreleased policy guide to align its applicable-policy response example with the REST API.
Changes:
- Uses
applicable-policies, REST API field names, and JSON-encodedcontentstrings. - Clarifies where policies are defined and how the example table inherits them.
- Limits the single-attachment rule to one directly attached policy per inheritable type.
| File | Description |
|---|---|
site/content/in-dev/unreleased/policy.md |
Updates the response example and clarifies policy inheritance and attachment limits. |
Review effort: Balanced
| ``` | ||
|
|
||
| The `namespace` field identifies where each policy is defined. Both policies are defined in `finance`. | ||
| The table inherits the snapshot expiry policy from that namespace and the compaction policy from the catalog. |
There was a problem hiding this comment.
Nit: One suggestion on the new prose. "The table inherits the snapshot expiry policy from that namespace and the compaction policy from the catalog" can be true as scenario setup, but nothing in the sample response shows it — namespace is where the policy is defined, not where it is attached. A reader is likely to look for an attachment-point field, which is the appliedAt this PR correctly removes. Either drop that clause, or say outright that the response reports where a policy is defined and whether it was inherited, not where it is attached.
The example for retrieving applicable policies uses a different collection name and field layout from the REST API. A client reading
policiescan silently return an empty list. The revised sample usesapplicable-policiesand represents each policy’s content as a JSON string. The inheritance note qualifies the single attachment limit by policy type.Validated the response against
GetApplicablePoliciesResponseon main. Decoded both content strings and validated them against their respective policy type schemas.Verification build
Checklist
AI assistance was used to prepare and check this change.