docs(auth): add Plugin Authorization page for the routes-derived surface - #542
Conversation
Document how plugin authorization is declared and derived from routes: the service.resource.action permission grammar, OAuth scopes, caller kinds, the job and function route factories, extra_permissions/extra_role_permissions, the on_invalid_plugin fail modes, and how to verify a plugin's authz. Add it to the Authorization nav and link it from the Writing Plugins section. Signed-off-by: Max Dubrinsky <mdubrinsky@nvidia.com>
|
🌿 Preview your docs: https://nvidia-preview-plugin-authz-docs-md.docs.buildwithfern.com/nemo-platform |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (3)
📝 WalkthroughWalkthroughThis PR adds documentation for plugin HTTP route authorization, describing route-derived permission catalogs, caller kinds, OAuth scopes, route factory requirements, extra permissions, and fail-closed validation behavior. It updates the plugin authoring guide and adds a navigation entry for the new page. ChangesPlugin Authorization Documentation
Possibly related PRs
Suggested labels: Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
|
…ace (#542) Document how plugin authorization is declared and derived from routes: the service.resource.action permission grammar, OAuth scopes, caller kinds, the job and function route factories, extra_permissions/extra_role_permissions, the on_invalid_plugin fail modes, and how to verify a plugin's authz. Add it to the Authorization nav and link it from the Writing Plugins section. Signed-off-by: Max Dubrinsky <mdubrinsky@nvidia.com>
What
A human-facing Plugin Authorization page documenting the routes-derived plugin authz surface (#332), for plugin authors.
Changes
docs/auth/authorization/plugin-authorization.mdx: how plugin authz is derived from routes, theservice.resource.actionpermission grammar, OAuth scopes, caller kinds, the job/function route factories (authz=),extra_permissions/extra_role_permissions, theon_invalid_pluginfail modes, and how to verify a plugin's authz.versions/latest.yml(between Permissions Reference and Policy Engine).plugins.mdxnow covers authz and links the new page, with an authz note on the HTTP-service surface row.Verification
fern checkcould not run locally (broken local fern install,EPERMreading its own CLI); docs CI runs the real fern validation on this PR.Summary by CodeRabbit