Commit dd53924
docs(cli): document usage commands (#1408)
* docs(usage-api): add Usage API reference under the Admin API section
Vendors the Usage API OpenAPI spec (GET /v1/usage/summary,
POST /v1/usage/time-series) into src/openapi/usage-api and wires it into the
Admin API nav section as "Usage API Endpoints", mirroring how the Admin API
("Apps API") endpoints are surfaced.
The spec is vendored locally for now because usage-api.alchemy.com is not yet
serving its /openapi.yaml publicly; once it is, this can switch to a
content/remote-specs.json entry (like admin-api) for auto-sync.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
* docs(usage-api): use admin-api.alchemy.com as the server
The Usage API is path-routed (`/v1/usage*`) through the Apps API ALB at
admin-api.alchemy.com (see terraform aws_alb_listener_rule.admin_api_usage),
not served directly at usage-api.alchemy.com. Match the public host (and the
sibling admin-api spec's server) so the reference shows the correct base URL.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
* docs(usage-api): use remote spec instead of vendored copy
Per the sync-docs-as-code pattern, register the Usage API spec as a remote
entry (served at https://admin-api.alchemy.com/v1/usage/openapi.json) and
remove the vendored src/openapi/usage-api/ copy. content/docs.yml already
references api-name: usage-api; the remote entry now supplies it.
Blocked: merge only after the dashboard change serving the spec at that URL
deploys (OMGWINNING/dashboard#8050) — CI lints the live URL.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
* docs(cli): document usage commands
Add a Usage (alpha) section to the Alchemy CLI reference covering
`alchemy usage summary` and `alchemy usage timeseries`, including the
time-series flag table for date ranges, granularity, filters, and
group-by.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
* docs(cli): drop alpha framing from usage section
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
---------
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>1 parent 414b733 commit dd53924
3 files changed
Lines changed: 41 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
125 | 125 | | |
126 | 126 | | |
127 | 127 | | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
128 | 131 | | |
129 | 132 | | |
130 | 133 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
3 | 3 | | |
4 | 4 | | |
5 | 5 | | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
6 | 10 | | |
7 | 11 | | |
8 | 12 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
269 | 269 | | |
270 | 270 | | |
271 | 271 | | |
| 272 | + | |
| 273 | + | |
| 274 | + | |
| 275 | + | |
| 276 | + | |
| 277 | + | |
| 278 | + | |
| 279 | + | |
| 280 | + | |
| 281 | + | |
| 282 | + | |
| 283 | + | |
| 284 | + | |
| 285 | + | |
| 286 | + | |
| 287 | + | |
| 288 | + | |
| 289 | + | |
| 290 | + | |
| 291 | + | |
| 292 | + | |
| 293 | + | |
| 294 | + | |
| 295 | + | |
| 296 | + | |
| 297 | + | |
| 298 | + | |
| 299 | + | |
| 300 | + | |
| 301 | + | |
| 302 | + | |
| 303 | + | |
| 304 | + | |
| 305 | + | |
272 | 306 | | |
273 | 307 | | |
274 | 308 | | |
| |||
0 commit comments