Skip to content

feat(docs): document Resource Mapping Groups and FQN format#350

Open
marythought wants to merge 5 commits into
mainfrom
mary/DSPX-3656-resource-mapping-groups-docs
Open

feat(docs): document Resource Mapping Groups and FQN format#350
marythought wants to merge 5 commits into
mainfrom
mary/DSPX-3656-resource-mapping-groups-docs

Conversation

@marythought

@marythought marythought commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add Resource Mapping Groups section to the resource_mappings page
  • Document the FQN format (https://<namespace>/resm/<group-name>)
  • Show CLI usage for creating groups and assigning mappings
  • Explain usage of group FQNs as synonym dictionary identifiers

This gap was identified when the FQN format could not be found in any documentation or CLI output, requiring engineers to read source code to discover it.

Test plan

  • npm run build passes
  • Surge preview renders the updated page correctly
  • Content reviewed for accuracy against source code (lib/identifier/resource_mapping_group.go)

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Expanded the Resource Mappings guide to cover the optional group field and clarified the “Examples” section structure.
    • Added a new “Resource Mapping Groups” section, including group composition details and the required FQN format (with lowercase normalization) and its URL pattern.
    • Included CLI walkthroughs for creating groups and assigning mappings (including referencing by group id), plus a note about current listing/get behavior for group FQNs.
    • Documented how groups can be used as synonym dictionaries for database-backed FQN resolution.

@marythought marythought requested review from a team as code owners June 22, 2026 20:17
@coderabbitai

coderabbitai Bot commented Jun 22, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@marythought, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 58 minutes and 30 seconds. Learn how PR review limits work.

Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file).

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits.

🚦 How do rate limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan refill rate.

For paid Pro and Pro+ PR reviews, CodeRabbit uses rolling per-developer review limits. Reviews become available again as older review attempts age out of the rolling limit window.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 0b468d7b-231b-4576-b34e-41fc5a467387

📥 Commits

Reviewing files that changed from the base of the PR and between bf0b8c4 and 056bde4.

📒 Files selected for processing (1)
  • docs/components/policy/resource_mappings.md
📝 Walkthrough

Walkthrough

Documentation for resource_mappings.md is updated to add an optional group field description, reformat the Examples section as a level-2 heading, and introduce a new "Resource Mapping Groups" section covering group composition, FQN format and normalization, CLI-based creation commands, and synonym dictionary lookups.

Changes

Resource Mapping Groups Documentation

Layer / File(s) Summary
Resource Mapping Groups documentation
docs/components/policy/resource_mappings.md
Adds the optional group field to the Resource Mapping schema description, reformats "Examples" as a level-2 heading, and introduces a new "Resource Mapping Groups" section covering group composition, FQN URL pattern with lowercase normalization, CLI commands for creating groups and assigning mappings, and FQN-based synonym dictionary resolution via the policy database.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

A rabbit hops through policy land,
Where groups and FQNs are freshly planned.
Synonyms align in the database bright,
CLI commands set the mappings right.
🐇 "My docs are tidy, my carrots aligned!"

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and specifically describes the main change: documenting Resource Mapping Groups and their FQN format, which aligns with the primary objective of adding documentation for these features.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch mary/DSPX-3656-resource-mapping-groups-docs

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@gemini-code-assist gemini-code-assist Bot 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.

Code Review

This pull request updates the documentation for Resource Mappings to introduce Resource Mapping Groups, explaining their purpose, FQN format, CLI commands for creation, and usage as synonym dictionaries. It also fixes a minor typo in an example URL. The reviewer suggested using the .md extension for relative file links to ensure build-time validation in Docusaurus and compatibility with standard Markdown readers.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread docs/components/policy/resource_mappings.md Outdated
@github-actions

Copy link
Copy Markdown
Contributor

❌ Surge preview build failed — no preview was deployed. Check the workflow logs for details.

Once the build passes, the preview will be at: https://opentdf-docs-pr-350.surge.sh

Common cause: If the build failed on vendored YAML validation, run the following locally and commit the result:

npm run update-vendored-yaml
git add specs/
git commit -m "chore(deps): update vendored OpenAPI specs"

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/components/policy/resource_mappings.md`:
- Line 33: Add language specifiers to the fenced code blocks to comply with the
MD040 linting rule. Locate the two code blocks containing the FQN examples (at
the lines with the namespace/resm examples) and change the opening triple
backticks from ``` to ```text for both blocks to provide proper syntax
highlighting and satisfy the linting requirement.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: c09b1cf2-2226-495e-a860-ddeb169196a8

📥 Commits

Reviewing files that changed from the base of the PR and between 12fcee6 and 845401f.

📒 Files selected for processing (1)
  • docs/components/policy/resource_mappings.md

Comment thread docs/components/policy/resource_mappings.md Outdated
marythought and others added 2 commits June 22, 2026 16:14
Add Resource Mapping Groups section to the resource_mappings page
covering group composition, FQN format (https://<namespace>/resm/<name>),
CLI usage for creating groups and assigning mappings, and usage as
synonym dictionaries.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Address Gemini and CodeRabbit review feedback:
- Use ./attributes.md#namespaces for build-time link validation
- Add text language specifier to FQN code blocks (MD040)

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@marythought marythought force-pushed the mary/DSPX-3656-resource-mapping-groups-docs branch from 845401f to 0faf858 Compare June 22, 2026 23:15
@github-actions

Copy link
Copy Markdown
Contributor

📄 Preview deployed to https://opentdf-docs-pr-350.surge.sh

marythought and others added 3 commits June 23, 2026 07:57
Tie the CLI example to Bob's DoD classification scenario from
earlier in the page instead of using generic placeholders.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@marythought marythought enabled auto-merge (squash) June 23, 2026 16:00
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.

1 participant