Skip to content

docs: clarify workflow extension ownership - #179

Merged
rapids-bot[bot] merged 1 commit into
NVIDIA:mainfrom
zhongxuanwang-nv:docs/clarify-workflow-extension-ownership
Aug 6, 2026
Merged

docs: clarify workflow extension ownership#179
rapids-bot[bot] merged 1 commit into
NVIDIA:mainfrom
zhongxuanwang-nv:docs/clarify-workflow-extension-ownership

Conversation

@zhongxuanwang-nv

@zhongxuanwang-nv zhongxuanwang-nv commented Aug 6, 2026

Copy link
Copy Markdown
Member

Overview

Clarify that extensions within FabricConfig.workflow and workflow.entrypoint are adapter-owned when a descriptor validates the workflow. A closed workflow_schema rejects fields that it does not declare, so those extension points cannot carry caller-owned annotations.

Details

  • Update the adapter-authoring skill to require declaring accepted workflow and entry-point extension fields in workflow_schema.
  • Update the consumer config-mapping reference to distinguish workflow extensions from caller-owned annotations.

Validation

  • Inspected validate_workflow, which serializes and validates the complete workflow object against the resolved descriptor schema.
  • Confirmed the workflow test fixture closes both workflow and entry-point schemas with additionalProperties: false.
  • git diff --check
  • Not run: just docs and focused Python tests; just and uv are unavailable in this environment. This change does not modify the docs site, generated references, or runtime code.

Where should the reviewer start?

Start with .agents/skills/contribute-adapter/SKILL.md, then review skills/integrations/consumer/nemo-fabric-integrate/references/config-mapping.md for the caller-facing clarification.

Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)

  • Relates to: none

  • I confirm this contribution is my own work, or I have the right to submit it under this project's license.

  • I searched existing issues and open pull requests, and this does not duplicate existing work.

Summary by CodeRabbit

  • Documentation
    • Clarified adapter workflow guidance to require schema validation for workflow and entry-point extensions.
    • Documented that unsupported workflow fields are rejected by closed schemas.
    • Directed caller-owned annotations to metadata or supported extension fields.

Signed-off-by: Zhongxuan Wang <daniewang@nvidia.com>
@coderabbitai

coderabbitai Bot commented Aug 6, 2026

Copy link
Copy Markdown

Review Change Stack

Walkthrough

The changes align adapter contribution guidance and integration configuration guidance with schema-controlled workflow extensions. Undeclared fields are rejected, conditional null support remains documented, and caller-owned annotations use metadata or extensions outside workflow.

Changes

Workflow Schema Guidance

Layer / File(s) Summary
Schema-controlled workflow extensions
.agents/skills/contribute-adapter/SKILL.md, skills/integrations/consumer/nemo-fabric-integrate/references/config-mapping.md
Adapter-owned workflow and entry-point extensions must pass workflow_schema validation. Undeclared fields are rejected. Adapters with default workflows may support null. Caller-owned annotations belong in metadata or extensions outside workflow.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

  • NVIDIA/NeMo-Fabric#175: Updates workflow-schema rules for NAT adapter workflow extensions and descriptor configuration.
  • NVIDIA/NeMo-Fabric#176: Updates related adapter workflow schema validation and extension-field guidance.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description check ✅ Passed The description includes the required overview, reviewer starting point, related-issues section, validation details, and contribution confirmations.
Linked Issues check ✅ Passed The description includes the required Related Issues section and explicitly states that no issue applies.
Out of Scope Changes check ✅ Passed The changes are limited to adapter workflow guidance and consumer configuration documentation, which match the pull request objectives.
Title check ✅ Passed The title follows Conventional Commits format, uses an allowed type, summarizes the documentation change, and is under 72 characters.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

@zhongxuanwang-nv zhongxuanwang-nv self-assigned this Aug 6, 2026
@zhongxuanwang-nv
zhongxuanwang-nv marked this pull request as ready for review August 6, 2026 00:23
@zhongxuanwang-nv
zhongxuanwang-nv requested a review from a team as a code owner August 6, 2026 00:23
@AjayThorve

Copy link
Copy Markdown
Collaborator

/merge

@rapids-bot
rapids-bot Bot merged commit 7a3272d into NVIDIA:main Aug 6, 2026
32 checks passed
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.

2 participants