Skip to content

Align the applicable policy response example with the REST API - #6142

Open
flyrain wants to merge 2 commits into
apache:mainfrom
flyrain:yf/docs-190-applicable-policies
Open

flyrain wants to merge 2 commits into
apache:mainfrom
flyrain:yf/docs-190-applicable-policies

Conversation

@flyrain

@flyrain flyrain commented Nov 19, 2026 •

Copy link
Copy Markdown
Contributor

The example for retrieving applicable policies uses a different collection name and field layout from the REST API. A client reading policies can silently return an empty list. The revised sample uses applicable-policies and represents each policy’s content as a JSON string. The inheritance note qualifies the single attachment limit by policy type.

Validated the response against GetApplicablePoliciesResponse on main. Decoded both content strings and validated them against their respective policy type schemas.

Verification build

Checklist

  • The change concerns public documentation.
  • The reason for the correction is described above.
  • The verification is described above.
  • No complex implementation logic needs comments.
  • This correction to documented behavior needs no changelog entry.
  • The change updates the unreleased documentation or its source.

AI assistance was used to prepare and check this change.

@flyrain
flyrain changed the base branch from versioned-docs to main November 19, 2026 03:23
@flyrain
flyrain force-pushed the yf/docs-190-applicable-policies branch from 4ee2cdb to f7ce4b6 Compare November 19, 2026 03:24
@flyrain flyrain changed the title Align the 1.9.0 applicable policy example with the REST API Align the applicable policy response example with the REST API Nov 19, 2026
@flyrain
flyrain marked this pull request as ready for review November 19, 2026 05:25
Copilot AI balanced review requested due to automatic review settings November 19, 2026 05:25

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 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-encoded content strings.
  • 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

@ayushtkn ayushtkn left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanx @flyrain for the fix

```

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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

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.

@github-project-automation github-project-automation Bot moved this from PRs In Progress to Ready to merge in Basic Kanban Board Nov 19, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants