Skip to content

docs: document GET /v1/usage#6

Open
armandokun wants to merge 1 commit into
feat/per-inbox-webhooksfrom
feat/usage-api
Open

docs: document GET /v1/usage#6
armandokun wants to merge 1 commit into
feat/per-inbox-webhooksfrom
feat/usage-api

Conversation

@armandokun

Copy link
Copy Markdown
Collaborator

Stacked on #5 (base: feat/per-inbox-webhooks). Review/merge that first.

Summary

  • OpenAPI: add the /v1/usage endpoint and UsageReport/InboxUsage schemas; regenerate the spec.
  • New Usage concept page: endpoint, query params, windowed vs. point-in-time metrics, and a pass-through metering pattern. Registered in the nav.

Why

Companion to openmailsh/openmail#99 (usage API).

Test plan

  • node scripts/generate-openapi.js runs clean; spec includes /v1/usage + schemas
  • mint broken-links (CLI not installed locally)

Made with Cursor

Add the usage endpoint and UsageReport/InboxUsage schemas to the OpenAPI
generator and regenerate the spec. Add a Usage concept page covering the
endpoint, query params, windowed vs. point-in-time metrics, and a
pass-through metering pattern; register it in the nav.

Co-authored-by: Cursor <cursoragent@cursor.com>
@armandokun armandokun mentioned this pull request Jun 1, 2026
1 task
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.

1 participant