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
@@ -7,6 +7,8 @@ Higher-Level-Wrapper that adds:
|
||||
|
||||
- Bearer-token, API-key, and async-getter auth modes
|
||||
- Retry with exponential backoff and jitter, honoring `Retry-After`
|
||||
- HTTPS/same-origin request enforcement with redirects disabled
|
||||
- Per-attempt timeouts and bounded response-body streaming
|
||||
- Auto-generated `Idempotency-Key` headers on POST/PUT/PATCH
|
||||
- Async iterator pagination (cursor / token / page)
|
||||
- HMAC-SHA256 webhook signature verification with constant-time compare
|
||||
@@ -20,6 +22,8 @@ const client = createHiveGridClient({
|
||||
baseUrl: "https://api.hivegrid.de",
|
||||
auth: { apiKey: process.env.HIVEGRID_API_KEY! },
|
||||
tenantId: process.env.HIVEGRID_TENANT_ID,
|
||||
timeoutMs: 30_000,
|
||||
maxResponseBodyBytes: 10 * 1024 * 1024,
|
||||
});
|
||||
|
||||
const me = await client.request({ method: "GET", path: "/v1/me" });
|
||||
@@ -29,6 +33,11 @@ for await (const contact of client.paginate("/v1/contacts")) {
|
||||
}
|
||||
```
|
||||
|
||||
`baseUrl` must use HTTPS. Local HTTP development requires the explicit
|
||||
`allowInsecureLocalhost: true` option and is restricted to loopback hosts.
|
||||
Request paths may be relative or absolute same-origin URLs; cross-origin paths
|
||||
and redirects fail closed so auth, tenant, and trace headers cannot leak.
|
||||
|
||||
## Codegen
|
||||
|
||||
The `src/generated/` directory is produced from the upstream OpenAPI document
|
||||
@@ -38,7 +47,7 @@ checked into this package as `openapi.json`. Regenerate with:
|
||||
pnpm --filter @hivegrid/api-client-ts generate:all
|
||||
```
|
||||
|
||||
The CI workflow `.github/workflows/sdk-codegen.yml` rejects PRs whose generated
|
||||
The CI workflow `.gitea/workflows/sdk-codegen.yml` rejects pull requests whose generated
|
||||
output drifts from the committed spec.
|
||||
|
||||
## See also
|
||||
|
||||
Reference in new issue
Block a user