Skip to content

docs(rest-api): Add ER diagram for API resources, clean up deprecation dates#2495

Open
thossain-nv wants to merge 4 commits into
NVIDIA:mainfrom
thossain-nv:docs/rest-er-diagram
Open

docs(rest-api): Add ER diagram for API resources, clean up deprecation dates#2495
thossain-nv wants to merge 4 commits into
NVIDIA:mainfrom
thossain-nv:docs/rest-er-diagram

Conversation

@thossain-nv

Copy link
Copy Markdown
Contributor

Description

  • Adds Resource Overview docs page with ER diagram to help users understand relationship between API resources
  • Extends incorrect deprecation dates and cleans up deprecation information in OpenAPI schema

Type of Change

  • Internal - Internal changes (refactoring, tests, docs, etc.)

Breaking Changes

  • This PR contains breaking changes

Testing

  • No testing required (docs, internal refactor, etc.)

@thossain-nv thossain-nv requested review from a team and Coco-Ben as code owners June 12, 2026 00:52
@coderabbitai

coderabbitai Bot commented Jun 12, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 161c3aeb-eecf-483c-8ba4-b3a602ff2fe8

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

@github-actions

Copy link
Copy Markdown

@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-12 00:55:00 UTC | Commit: 3bf9fb1

@thossain-nv thossain-nv force-pushed the docs/rest-er-diagram branch 3 times, most recently from 3d27f75 to 31448c3 Compare June 12, 2026 19:03
@github-actions

github-actions Bot commented Jun 12, 2026

Copy link
Copy Markdown

🔍 Container Scan Summary

Service Total Critical High Medium Low Other
nico-flow 126 14 55 44 5 8
nico-nsm 133 11 45 66 11 0
nico-psm 128 14 57 44 5 8
nico-rest-api 192 17 89 70 8 8
nico-rest-cert-manager 105 6 52 35 4 8
nico-rest-db 126 14 55 44 5 8
nico-rest-site-agent 125 14 55 44 4 8
nico-rest-workflow 128 14 57 44 5 8
TOTAL 1063 104 465 391 47 56

Per-CVE detail lives in the per-service grype-* artifacts (JSON + SARIF). Severity counts only — no CVE IDs published here.

@thossain-nv thossain-nv force-pushed the docs/rest-er-diagram branch 2 times, most recently from 179ac73 to d641405 Compare June 12, 2026 20:03
…n dates

Signed-off-by: Tareque Hossain <thossain@nvidia.com>
Signed-off-by: Tareque Hossain <thossain@nvidia.com>
Signed-off-by: Tareque Hossain <thossain@nvidia.com>
Signed-off-by: Tareque Hossain <thossain@nvidia.com>
@thossain-nv thossain-nv force-pushed the docs/rest-er-diagram branch from d641405 to fa90115 Compare June 12, 2026 23:29
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