Skip to content

map types from openapi.json #150

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lucasbalieiro wants to merge 2 commits into
base: main
Choose a base branch
from
Open

map types from openapi.json #150

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1357b8d
map types from openapi.json file
lucasbalieiro May 4, 2026
165d37c
add docs explaining the types generation from openapi.json
lucasbalieiro May 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions docs/monitoring-api-compatibility.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,3 +61,23 @@ The React frontend should avoid depending on version-specific raw JDC/tProxy res
If a raw API difference affects data already shown by the dashboard, normalize it in the `sv2-ui` backend or shared monitoring layer first.

If a future image exposes new monitoring data that older images do not have, treat it as an optional feature and render it only for compatible profiles.

## API Type Generation

TypeScript types are **auto-generated from the shared OpenAPI spec** (`shared/openapi.json`), not manually maintained.

### File Structure

| File | Purpose |
|------|---------|
| `src/types/api-generated.ts` | **AUTO-GENERATED** - Types from OpenAPI spec. Do not edit manually. |
| `src/types/api.ts` | Re-exports generated types + manual app-specific types |

### Generating Types

```bash
npm run generate:types
```

Regenerate after updating `shared/openapi.json` from upstream.

Loading
Loading