Refresh HiveGrid Cloud reference snapshot
This commit is contained in:
1 parent
5e99e14772
commit
7f88026f79
5955 files changed
+1177325
-188362
No files matched your search
@@ -17,11 +17,11 @@ The API server listens on `API_PORT` when set, falls back to `PORT`, and otherwi
|
||||
| `GET` | `/v1/session/current-user`, `/v1/accounts`, `/v1/accounts/:id` | Service token | Service principal and account metadata. |
|
||||
| `GET` | `/v1/usage` | Tenant API key | Usage metadata for the credential-scoped tenant. |
|
||||
| `POST` | `/v1/api-keys/validate` | Optional presented API key or service token | Redacted API-key/service-token validation helper. |
|
||||
| `POST` | `/v1/ai/upload` | Service token | AI upload through configured service storage. |
|
||||
| `POST` | `/v1/maintenance/export-retention/enqueue` | Service token | Operator maintenance enqueue action. |
|
||||
| `POST` | `/v1/support/inbound-email` | Webhook signature | Signed inbound support email ingress that creates tenant support tickets. |
|
||||
| `GET` | `/v1/analytics/public`, `/v1/analytics/admin` | Analytics token or service token | Analytics read surfaces. |
|
||||
| `POST` | `/v1/analytics/events`, `/v1/analytics/page-views` | Analytics token | Public analytics ingress. |
|
||||
| `GET` | `/v1/analytics/public` | Public-setting gate | Tenantless global aggregates; unavailable unless `AnalyticsSettings.public` is enabled. |
|
||||
| `GET` | `/v1/analytics/admin` | Service token plus verified operator user | Global tenantless aggregates or an exact `tenantId` + `portalId` scope. |
|
||||
| `POST` | `/v1/analytics/events`, `/v1/analytics/page-views` | Analytics ingest token | Anonymous tenantless analytics ingress; user and portal identity fields are rejected. |
|
||||
| `GET` | `/v1/notifications/stream` | Service token | Notification diagnostics stream. |
|
||||
| `GET` | `/v1/entities/:entity` | Service token | Entity metadata lookup. |
|
||||
| `GET/POST/PATCH/DELETE` | `/v1/entities/:entity/rows*` | Service token or tenant API key | Tenant-scoped entity row operations. |
|
||||
@@ -38,6 +38,8 @@ Tenant-scoped row, relationship, and export requests resolve tenant scope from t
|
||||
|
||||
Set `API_ACCESS_TOKEN` in the API runtime environment to enable the service-token endpoints. Authenticated calls use `Authorization: Bearer <service-token>`; key validation may also read the candidate key from the `x-api-key` header or from the JSON `apiKey` request body when using `POST /v1/api-keys/validate`.
|
||||
|
||||
`ANALYTICS_TOKEN` is browser-readable by design and is therefore only a bounded ingest capability, not a read credential. It permits anonymous event/page-view submissions after rate limiting. Public aggregate reads rely solely on the operator-controlled public setting, while admin aggregate reads require the service credential and an `x-hivegrid-operator-user-id` that resolves to an RLS-visible `AdminUser` row.
|
||||
|
||||
Authentication failures return JSON error envelopes without echoing token values, API keys, bearer fragments, headers, request bodies, tenant identifiers, customer identifiers, or environment values. Support notes should record only the generic endpoint, response status, stable error code, and request ID. Never paste real authorization headers, raw API key inputs, or token-shaped values into tickets, chat, logs, screenshots, or documentation examples.
|
||||
|
||||
## OpenAPI contract
|
||||
@@ -108,7 +110,7 @@ for marker in ('TO' + 'DO', 'T' + 'BD', 'FIX' + 'ME'):
|
||||
PY
|
||||
pnpm exec eslint apps/api/src/app.ts apps/api/src/cors.ts --max-warnings=0
|
||||
pnpm exec vitest run apps/api/src/app.test.ts apps/api/src/cors.test.ts
|
||||
pnpm run verify:production-docs
|
||||
pnpm run verify:docs-links
|
||||
```
|
||||
|
||||
Browser automation, Playwright, Cypress, live Docker, live registry, and E2E execution are manual-only unless a human explicitly approves the exact focused run in the current session.
|
||||
|
||||
Reference in new issue
Block a user