Skip to content

docs: document nat serve /health endpoint in REST API guide - #2173

Closed
alwaysprince05 wants to merge 1 commit into
NVIDIA:developfrom
alwaysprince05:docs/health-endpoint
Closed

docs: document nat serve /health endpoint in REST API guide#2173
alwaysprince05 wants to merge 1 commit into
NVIDIA:developfrom
alwaysprince05:docs/health-endpoint

Conversation

@alwaysprince05

@alwaysprince05 alwaysprince05 commented Aug 23, 2026

Copy link
Copy Markdown
Contributor
  • Add /health to Default Endpoint Paths table
  • Add Health Check Endpoint section with request/response examples
  • Document use cases for liveness/readiness probes
  • Cross-reference MCP/FastMCP health endpoints

Closes #2073

Description

Closes

By Submitting this PR I confirm:

  • I am familiar with the Contributing Guidelines.
  • We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license.
    • Any contribution which contains commits that are not Signed-Off will not be accepted.
  • When the PR is ready for review, new or existing tests cover these changes.
  • When the PR is ready for review, the documentation is up to date with these changes.

Summary by CodeRabbit

  • Documentation
    • Added the /health endpoint to the REST API reference.
    • Documented its GET request, successful response, examples, availability, and use for service health checks.

- Add /health to Default Endpoint Paths table
- Add Health Check Endpoint section with request/response examples
- Document use cases for liveness/readiness probes
- Cross-reference MCP/FastMCP health endpoints

Closes NVIDIA#2073

Signed-off-by: alwaysprince05 <prince.p24@medhaviskillsuniversity.edu.in>
@alwaysprince05
alwaysprince05 requested a review from a team as a code owner August 23, 2026 05:50
@copy-pr-bot

copy-pr-bot Bot commented Aug 23, 2026

Copy link
Copy Markdown

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@coderabbitai

coderabbitai Bot commented Aug 23, 2026

Copy link
Copy Markdown

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: df725d08-226a-4e53-8492-1d63dd6326c5

📥 Commits

Reviewing files that changed from the base of the PR and between 15a28d6 and 866ca56.

📒 Files selected for processing (1)
  • docs/source/reference/rest-api/api-server-endpoints.md

Included review availability: Your plan provides up to 12 included reviews per hour; 11 remain after this review.


Walkthrough

The REST API guide now lists and documents the FastAPI GET /health endpoint, including its successful response, request examples, probe use cases, and availability note.

Changes

REST health endpoint documentation

Layer / File(s) Summary
Health endpoint reference
docs/source/reference/rest-api/api-server-endpoints.md
The endpoint table now includes GET /health. The guide documents the 200 response, {"status":"healthy"} payload, curl and JSON examples, liveness/readiness probes, and FastAPI availability.

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

Merge Risk: ⚪ Minimal · up to 866ca

This documentation-only change adds guidance for the existing health endpoint and introduces no actionable merge-blocking risk; it is merge-ready after normal checks and review.

🚥 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 is concise, descriptive, imperative, and accurately identifies the REST API health endpoint documentation change.
Linked Issues check ✅ Passed The documentation covers the /health route, GET method, 200 response, examples, probe use cases, and operational behavior requested in issue #2073.
Out of Scope Changes check ✅ Passed The changes are limited to REST API documentation and directly support the requirements in issue #2073.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

@willkill07

Copy link
Copy Markdown
Member

@alwaysprince05 this is a duplicate of #2094

This is the second PR you've opened which is duplicative work. Please stop.

@willkill07 willkill07 closed this Aug 23, 2026
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.

Docs: document nat serve /health endpoint in REST API guide

2 participants