Skip to content

docs: Add REST Core proxy agent guidance#2807

Open
kfelternv wants to merge 5 commits into
NVIDIA:mainfrom
kfelternv:rest-grpc-proxy-skill
Open

docs: Add REST Core proxy agent guidance#2807
kfelternv wants to merge 5 commits into
NVIDIA:mainfrom
kfelternv:rest-grpc-proxy-skill

Conversation

@kfelternv

@kfelternv kfelternv commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

This PR creates a skill that will help us migrate to using a centralized grpc proxy workflow and activity when calling the grpc api from the rest api, it will help the agent follow the pattern established in this PR: #2477

Signed-off-by: Kyle Felter <kfelter@nvidia.com>
@copy-pr-bot

copy-pr-bot Bot commented Jun 23, 2026

Copy link
Copy Markdown

Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually.

Contributors can view more details about this message here.

@coderabbitai

coderabbitai Bot commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 8877ddc7-bbd5-4ab4-939a-a5cf4ab6d50b

📥 Commits

Reviewing files that changed from the base of the PR and between 89c0b75 and 2a98c0d.

📒 Files selected for processing (2)
  • rest-api/AGENTS.md
  • rest-api/skills/rest-core-grpc-proxy/SKILL.md

Summary by CodeRabbit

Documentation

  • Added guidance for building REST endpoints through the Core gRPC proxy
  • Added comprehensive skill documentation including implementation workflows, pre-coding checklists, and reference patterns for REST API endpoint development

Walkthrough

Two documentation files are added. rest-api/AGENTS.md receives a new subsection directing agents to skills/rest-core-grpc-proxy/SKILL.md. That new skill document specifies the proxy contract, a pre-coding checklist, an implementation workflow, test requirements, a protojson vs protobuf-bytes rationale, and a known BMC credential endpoint example.

Changes

REST Core gRPC Proxy Agent Skill

Layer / File(s) Summary
AGENTS.md skill registration
rest-api/AGENTS.md
Inserts a subsection instructing agents to consult skills/rest-core-grpc-proxy/SKILL.md when building or converting REST endpoints that route through the Core gRPC proxy.
Proxy contract and pre-coding checklist
rest-api/skills/rest-core-grpc-proxy/SKILL.md
Documents the proxy contract (cloud helper, shared types, CoreGrpcClient.InvokeJSON, Temporal JSON and encrypted secret field handling) and enumerates the pre-coding checklist items including unary-only constraint, typed protobuf expectations, secret field identification, and retry behavior.
Implementation workflow, tests, rationale, and known example
rest-api/skills/rest-core-grpc-proxy/SKILL.md
Specifies the step-by-step implementation workflow (common.ExecuteCoreGRPC invocation, secret key handling, logging constraints, response shaping, OpenAPI/SDK update rules), required test categories, the protojson design rationale over raw protobuf bytes, and the BMC credential endpoint as a reference pattern.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs: Add REST Core proxy agent guidance' accurately describes the primary change—adding documentation guidance for REST Core proxy agents. It is concise, specific, and clearly summarizes the main objective.
Description check ✅ Passed The description directly relates to the changeset, explaining the purpose of the new skill documentation and its connection to the migration pattern. It provides meaningful context about the intent.
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

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

Signed-off-by: Kyle Felter <kfelter@nvidia.com>
Signed-off-by: Kyle Felter <kfelter@nvidia.com>
Signed-off-by: Kyle Felter <kfelter@nvidia.com>
Signed-off-by: Kyle Felter <kfelter@nvidia.com>
@kfelternv kfelternv marked this pull request as ready for review June 23, 2026 19:14
@kfelternv kfelternv requested a review from a team as a code owner June 23, 2026 19:14
@kfelternv kfelternv requested a review from thossain-nv June 23, 2026 19:14
@github-actions

Copy link
Copy Markdown

🔍 Container Scan Summary

No Grype artifacts were found to aggregate.

@github-actions

Copy link
Copy Markdown

🔐 TruffleHog Secret Scan

No secrets or credentials found!

Your code has been scanned for 700+ types of secrets and credentials. All clear! 🎉

🔗 View scan details

🕐 Last updated: 2026-06-23 19:17:47 UTC | Commit: 2a98c0d

@thossain-nv thossain-nv 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.

Thanks for this @kfelternv

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