Skip to content

Commit e051294

Browse files
sanswareclaude
andauthored
chore: align README with brand canon (TicketWave API) (#1)
Replace "TicketWave Access API" with "TicketWave API" per the brand-name canon at docs/strategy/brand-name-canon.md. Also retires "access-decision engine" phrasing in the /api/v2 row to match the current commerce positioning. README only — historical artefacts in CHANGELOG.md and openapi.yaml (info.title) are left untouched. Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com>
1 parent 944b5bd commit e051294

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# TicketWave OpenAPI spec
22

3-
The canonical OpenAPI 3.1 specification for the **TicketWave Access API** — the public JSON-over-HTTPS surface served at `https://access.ticketwavehq.com`.
3+
The canonical OpenAPI 3.1 specification for the **TicketWave API** — the public JSON-over-HTTPS surface served at `https://access.ticketwavehq.com`.
44

55
This is the **same spec** that powers:
66

@@ -17,7 +17,7 @@ A single [`openapi.yaml`](./openapi.yaml) describing two API namespaces:
1717
| Namespace | Purpose | Auth scope | Rate limit |
1818
|---|---|---|---|
1919
| `/api/v1/*` | Read tenant resources — events, ticket tiers, orders. | `plugin:read` (+ optional `plugin:pii` to unmask buyers) | 120 req/min/key |
20-
| `/api/v2/*` | The access-decision engine — register resources, write rules, ask for `ALLOW` / `DENY` / `REVIEW`, replay, dispute, override. | `plugin:read` for GETs, `plugin:write` for state changes | 240 req/min/key |
20+
| `/api/v2/*` | The commerce engine — register resources, write rules, ask for `ALLOW` / `DENY` / `REVIEW`, replay, dispute, override. | `plugin:read` for GETs, `plugin:write` for state changes | 240 req/min/key |
2121

2222
**Current shape (v1.0.0):**
2323

@@ -96,4 +96,4 @@ Found a discrepancy between the spec and the live API? Open an issue here, or em
9696

9797
Apache License 2.0 — see [`LICENSE`](./LICENSE).
9898

99-
The TicketWave Access API itself is offered under the proprietary [TicketWave Public API Terms](https://www.ticketwavehq.com/terms); this OpenAPI document describing the API is Apache-2.0 so you can vendor, fork, generate clients from, and redistribute it freely.
99+
The TicketWave API itself is offered under the proprietary [TicketWave Public API Terms](https://www.ticketwavehq.com/terms); this OpenAPI document describing the API is Apache-2.0 so you can vendor, fork, generate clients from, and redistribute it freely.

0 commit comments

Comments
 (0)