Skip to content

Commit 944b5bd

Browse files
sanswareclaude
sansware
and
claude
committed
chore: publish TicketWave Access API OpenAPI 3.1 spec v1.0.0
Initial public release of the canonical spec describing /api/v1 (read tenant resources) and /api/v2 (access-decision engine). 26 paths, 37 operations, 64 component schemas across 14 tags. This is the source of truth that @ticketwave/sdk and the in-product viewer at access.ticketwavehq.com/developers/api/spec are generated from. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
0 parents  commit 944b5bd

4 files changed

Lines changed: 2616 additions & 0 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Changelog
2+
3+
All notable changes to the TicketWave Access API OpenAPI specification are recorded in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html) per the rules in [`README.md`](./README.md#versioning-policy).
6+
7+
## [1.0.0] — 2026-06-25
8+
9+
Initial public release of the spec.
10+
11+
### Added
12+
13+
- `openapi.yaml` — OpenAPI 3.1 document for the TicketWave Access API.
14+
- `/api/v1/*` namespace — read tenant resources:
15+
- Events (`/api/v1/events`, `/api/v1/events/{eventSlug}`)
16+
- Ticket tiers (`/api/v1/events/{eventSlug}/tiers`)
17+
- Orders (`/api/v1/orders`, `/api/v1/orders/{orderId}`) — PII gated by `plugin:pii` scope; `CustomerMasked` returned by default.
18+
- `/api/v2/*` namespace — the access-decision engine:
19+
- Decisions (`/api/v2/decisions`, `/api/v2/decisions/{decisionId}`, `/api/v2/decisions/{decisionId}/replay`)
20+
- Rules (`/api/v2/rules` CRUD, stage management)
21+
- Resources (`/api/v2/resources` CRUD)
22+
- Actors (`/api/v2/actors`, `/api/v2/actors/{actorId}/claims`)
23+
- Disputes (`/api/v2/disputes`, `/api/v2/disputes/{disputeId}`)
24+
- Overrides (`/api/v2/overrides`)
25+
- Subscriptions (`/api/v2/subscriptions` — HMAC signing secret surfaced once on create)
26+
- Tenants (`/api/v2/tenants/self`)
27+
- Shadow-mode triage (`/api/v2/shadow/disagreements`)
28+
- System events feed (`/api/v2/system/events`)
29+
- Bearer-token security scheme (`apiKey`) with `tw_live_*` token format documentation.
30+
- 14 tags grouping the surface by domain.
31+
- 64 component schemas covering requests, responses, and shared envelopes (`OffsetPagination`, `LimitPagination`, `Money`, `CustomerMasked`, `Tenant`, `Decision`, `Rule`, `Resource`, `Actor`, `Dispute`, `Override`, `Subscription`, `SystemEvent`, …).
32+
- Canonical server `https://access.ticketwavehq.com` listed first; dashboard alias `https://www.ticketwavehq.com` listed second (both resolve to the same deployment).
33+
- Rate-limit guidance: 120 req/min/key on v1, 240 req/min/key on v2.
34+
35+
### Surface counts
36+
37+
| Item | Count |
38+
|---|---|
39+
| Paths | 26 |
40+
| Operations | 37 |
41+
| Component schemas | 64 |
42+
| Tags | 14 |
43+
44+
### Notes
45+
46+
- Webhook signature verification (HMAC-SHA256) is documented out-of-band at <https://access.ticketwavehq.com/help>. The OpenAPI 3.1 `webhooks` block does not yet round-trip HMAC details through every code generator, so we keep that contract human-readable for now.
47+
- Routes marked `# TODO` in the source are passthroughs of underlying rows whose shape is not yet pinned; future minor releases will harden those schemas additively.
48+
49+
[1.0.0]: https://github.com/TicketWaveHQ/openapi-spec/releases/tag/v1.0.0

‎LICENSE‎

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for describing the origin of the Work and
141+
reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Support. While redistributing the Work or
166+
Derivative Works thereof, You may choose to offer, and charge a
167+
fee for, acceptance of support, warranty, indemnity, or other
168+
liability obligations and/or rights consistent with this License.
169+
However, in accepting such obligations, You may act only on Your
170+
own behalf and on Your sole responsibility, not on behalf of any
171+
other Contributor, and only if You agree to indemnify, defend,
172+
and hold each Contributor harmless for any liability incurred by,
173+
or claims asserted against, such Contributor by reason of your
174+
accepting any such warranty or support.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed" page as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright 2026 TicketWave Ltd
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
200+
implied. See the License for the specific language governing
201+
permissions and limitations under the License.

‎README.md‎

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
# TicketWave OpenAPI spec
2+
3+
The canonical OpenAPI 3.1 specification for the **TicketWave Access API** — the public JSON-over-HTTPS surface served at `https://access.ticketwavehq.com`.
4+
5+
This is the **same spec** that powers:
6+
7+
- the official [`@ticketwave/sdk`](https://www.npmjs.com/package/@ticketwave/sdk) TypeScript client,
8+
- the interactive viewer at <https://access.ticketwavehq.com/developers/api/spec>,
9+
- and every downstream Stainless / OpenAPI Generator client we ship.
10+
11+
---
12+
13+
## What it is
14+
15+
A single [`openapi.yaml`](./openapi.yaml) describing two API namespaces:
16+
17+
| Namespace | Purpose | Auth scope | Rate limit |
18+
|---|---|---|---|
19+
| `/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 |
21+
22+
**Current shape (v1.0.0):**
23+
24+
- 26 paths
25+
- 37 operations
26+
- 64 component schemas
27+
- 14 tags
28+
29+
All requests use bearer tokens of the form `tw_live_xxxxxxxxxxxxxxxx`, issued at <https://www.ticketwavehq.com/dashboard/settings/api-keys>. Tenant scoping is enforced server-side on every row — cross-tenant probes resolve to `404`, never `403`, so the surface cannot be used to enumerate other tenants.
30+
31+
---
32+
33+
## How to consume it
34+
35+
### Swagger Editor / Swagger UI
36+
37+
```bash
38+
# https://editor.swagger.io → File → Import URL
39+
https://raw.githubusercontent.com/TicketWaveHQ/openapi-spec/main/openapi.yaml
40+
```
41+
42+
### Postman / Insomnia
43+
44+
`File → Import → Link →` paste the raw URL above. Postman generates a collection with all 37 operations, organised by tag.
45+
46+
### OpenAPI Generator (any language)
47+
48+
```bash
49+
npx @openapitools/openapi-generator-cli generate \
50+
-i https://raw.githubusercontent.com/TicketWaveHQ/openapi-spec/main/openapi.yaml \
51+
-g typescript-fetch \
52+
-o ./ticketwave-client
53+
```
54+
55+
Swap `-g typescript-fetch` for `python`, `go`, `rust`, `java`, `csharp`, etc. The full generator list is in the [openapi-generator docs](https://openapi-generator.tech/docs/generators).
56+
57+
### Stainless
58+
59+
The official `@ticketwave/sdk` is generated by [Stainless](https://stainless.com) from this exact file. If you fork to build a private client, point Stainless at the raw URL above.
60+
61+
### Prefer not to vendor it?
62+
63+
You do not have to. The same spec is served at <https://access.ticketwavehq.com/openapi.yaml> with the same canonical-server values — both URLs are identical bytes on every release.
64+
65+
---
66+
67+
## Versioning policy
68+
69+
This spec follows **semantic versioning** with API-shape rules:
70+
71+
- **Patch** (`1.0.x`) — documentation fixes, example tweaks, description rewording. Wire format unchanged.
72+
- **Minor** (`1.x.0`) — **additive only**. New endpoints, new optional fields on requests, new fields on responses, new enum values. Existing clients keep working.
73+
- **Major** (`x.0.0`) — **breaking**. Renaming a field, removing an endpoint, tightening a type, changing required/optional, narrowing an enum. Announced 30 days in advance on the developer changelog.
74+
75+
The version lives in `info.version` at the top of `openapi.yaml` and is mirrored in [`CHANGELOG.md`](./CHANGELOG.md). Each release is also a GitHub tag (`v1.0.0`, `v1.1.0`, …) so SDK builds can pin.
76+
77+
---
78+
79+
## Webhook signatures
80+
81+
Webhook payloads delivered to outbound subscriptions are signed with **HMAC-SHA256**. The signing secret is returned **once** when you create the subscription via `POST /api/v2/subscriptions` and is never re-displayed. The exact header layout, verification algorithm, and replay-window rules are documented at:
82+
83+
<https://access.ticketwavehq.com/help>
84+
85+
(They are intentionally out of scope for this OpenAPI document — OpenAPI 3.1's `webhooks` block does not yet describe HMAC verification in a way that round-trips through every generator.)
86+
87+
---
88+
89+
## Reporting issues
90+
91+
Found a discrepancy between the spec and the live API? Open an issue here, or email <developers@ticketwavehq.com>.
92+
93+
---
94+
95+
## License
96+
97+
Apache License 2.0 — see [`LICENSE`](./LICENSE).
98+
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.

0 commit comments

Comments
 (0)