diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..b94b38e --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1 @@ +* @sansware diff --git a/.github/ISSUE_TEMPLATE/spec-discrepancy.yml b/.github/ISSUE_TEMPLATE/spec-discrepancy.yml new file mode 100644 index 0000000..690c9a6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/spec-discrepancy.yml @@ -0,0 +1,70 @@ +name: Spec discrepancy +description: Report a difference between this OpenAPI spec and the live TicketWave API. +title: "[spec-discrepancy] " +labels: + - spec-discrepancy + - triage +assignees: + - sansware +body: + - type: markdown + attributes: + value: | + Thanks for filing a spec discrepancy. Please give us enough detail to reproduce. + For security issues, **do not** use this form — see [`SECURITY.md`](../../SECURITY.md). + - type: input + id: operation + attributes: + label: Affected operation + description: The `operationId` or path + method (e.g. `listEvents` or `GET /api/v1/events`). + placeholder: GET /api/v1/events + validations: + required: true + - type: input + id: spec-version + attributes: + label: Spec version + description: Value of `info.version` you tested against (e.g. `1.0.1`). + placeholder: "1.0.1" + validations: + required: true + - type: textarea + id: request + attributes: + label: Request + description: The HTTP method, path, headers (redact secrets), and body that you sent. + render: http + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected response (per the spec) + description: The schema / status code / shape that the spec promises. + render: json + validations: + required: true + - type: textarea + id: actual + attributes: + label: Actual response + description: What the live API actually returned. Include status code and body. + render: json + validations: + required: true + - type: textarea + id: notes + attributes: + label: Additional notes + description: Reproduction frequency, environment, anything else useful. + validations: + required: false + - type: checkboxes + id: confirmations + attributes: + label: Confirmations + options: + - label: I have checked the latest `openapi.yaml` on `main`. + required: true + - label: This is not a security vulnerability (if it is, I will email security@ticketwavehq.com instead). + required: true diff --git a/.github/workflows/validate.yml b/.github/workflows/validate.yml new file mode 100644 index 0000000..604f0e2 --- /dev/null +++ b/.github/workflows/validate.yml @@ -0,0 +1,32 @@ +name: Validate OpenAPI spec + +on: + pull_request: + paths: + - "openapi.yaml" + - ".github/workflows/validate.yml" + push: + branches: [main] + paths: + - "openapi.yaml" + - ".github/workflows/validate.yml" + +jobs: + validate: + name: Lint + validate openapi.yaml + runs-on: ubuntu-latest + timeout-minutes: 5 + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Setup Node.js + uses: actions/setup-node@v4 + with: + node-version: "20" + + - name: Redocly lint + run: npx --yes @redocly/cli@latest lint openapi.yaml + + - name: swagger-cli validate + run: npx --yes @apidevtools/swagger-cli@latest validate openapi.yaml diff --git a/CHANGELOG.md b/CHANGELOG.md index 0add303..6ecfcf0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,9 +1,27 @@ # Changelog -All notable changes to the TicketWave Access API OpenAPI specification are recorded in this file. +All notable changes to the TicketWave API OpenAPI specification are recorded in this file. 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). +## [1.0.1] — 2026-06-28 + +Brand-name canon alignment + apex URL sweep. No wire-format changes. + +### Changed + +- `info.title` renamed from "TicketWave Access API" to "TicketWave API" to align with the canonical brand name (canon §3). +- All `www.ticketwavehq.com` references swept to the apex `ticketwavehq.com`: + - `info.contact.url` + - `info.license.url` + - `info.description` (api-keys URL) + - `servers[1].url` (dashboard alias) + - `components.securitySchemes.apiKey.description` (api-keys URL) + - README License section + - this CHANGELOG (footer reference below) + +[1.0.1]: https://github.com/TicketWaveHQ/openapi-spec/releases/tag/v1.0.1 + ## [1.0.0] — 2026-06-25 Initial public release of the spec. @@ -29,7 +47,7 @@ Initial public release of the spec. - Bearer-token security scheme (`apiKey`) with `tw_live_*` token format documentation. - 14 tags grouping the surface by domain. - 64 component schemas covering requests, responses, and shared envelopes (`OffsetPagination`, `LimitPagination`, `Money`, `CustomerMasked`, `Tenant`, `Decision`, `Rule`, `Resource`, `Actor`, `Dispute`, `Override`, `Subscription`, `SystemEvent`, …). -- Canonical server `https://access.ticketwavehq.com` listed first; dashboard alias `https://www.ticketwavehq.com` listed second (both resolve to the same deployment). +- Canonical server `https://access.ticketwavehq.com` listed first; dashboard alias `https://ticketwavehq.com` listed second (both resolve to the same deployment). - Rate-limit guidance: 120 req/min/key on v1, 240 req/min/key on v2. ### Surface counts diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..bdb517a --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,132 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the overall + community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or advances + of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email address, + without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +[conduct@ticketwavehq.com](mailto:conduct@ticketwavehq.com). +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of +actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or permanent +ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the +community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at +[https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..1e16fb4 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,42 @@ +# Contributing to TicketWave OpenAPI spec + +Thank you for opening an issue or PR. This repository holds the single canonical OpenAPI 3.1 document for the TicketWave API. Because downstream SDKs and the official documentation viewer are generated from `openapi.yaml`, even small changes can ripple — please follow the rules below. + +## Ground rules + +- **One source of truth.** `openapi.yaml` is canonical. Do not split it. +- **Semantic versioning.** Bump `info.version` per the rules in [`README.md`](./README.md#versioning-policy): + - `patch` — documentation, descriptions, examples. + - `minor` — additive only (new endpoints, optional fields, new enum values). + - `major` — breaking changes. 30-day advance notice required. +- **Changelog every release.** Add a `[x.y.z] — YYYY-MM-DD` block to [`CHANGELOG.md`](./CHANGELOG.md). +- **Brand canon.** The product is the **TicketWave API** (not "Access API"). URLs use the apex `ticketwavehq.com` — no `www.` prefix. + +## Local checks + +```bash +npx --yes @redocly/cli@latest lint openapi.yaml +npx --yes @apidevtools/swagger-cli@latest validate openapi.yaml +``` + +CI runs both on every PR via [`.github/workflows/validate.yml`](./.github/workflows/validate.yml). + +## Filing a spec discrepancy + +If the live API behaves differently from the spec, open an issue using the **"Spec discrepancy"** template at [`.github/ISSUE_TEMPLATE/spec-discrepancy.yml`](./.github/ISSUE_TEMPLATE/spec-discrepancy.yml). Include the request, the actual response, and the expected response per the spec. + +## Pull request expectations + +- Title: imperative mood, scoped (e.g. `feat(v2-rules): add ...`, `chore: ...`, `docs: ...`). +- Description: what changed, why, and any version bump rationale. +- One logical change per PR. +- CI must be green. +- Code-owner review per [`CODEOWNERS`](./.github/CODEOWNERS). + +## Code of conduct + +Participation is governed by [`CODE_OF_CONDUCT.md`](./CODE_OF_CONDUCT.md). + +## Security + +Do not file security issues here. See [`SECURITY.md`](./SECURITY.md) for the private disclosure channel. diff --git a/README.md b/README.md index 5eb6a68..d96ad6a 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ A single [`openapi.yaml`](./openapi.yaml) describing two API namespaces: - 64 component schemas - 14 tags -All requests use bearer tokens of the form `tw_live_xxxxxxxxxxxxxxxx`, issued at . 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. +All requests use bearer tokens of the form `tw_live_xxxxxxxxxxxxxxxx`, issued at . 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. --- @@ -96,4 +96,37 @@ Found a discrepancy between the spec and the live API? Open an issue here, or em Apache License 2.0 — see [`LICENSE`](./LICENSE). -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. +The TicketWave API itself is offered under the proprietary [TicketWave Public API Terms](https://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. + +--- + +## Organization metadata + +```json +{ + "@context": "https://schema.org", + "@type": "Organization", + "name": "TicketWave", + "legalName": "TicketWave HQ Ltd", + "url": "https://ticketwavehq.com", + "logo": "https://ticketwavehq.com/logo.png", + "description": "TicketWave is an events-and-access platform providing a public REST API for events, orders, and the access-decision engine.", + "sameAs": [ + "https://github.com/TicketWaveHQ" + ], + "contactPoint": [ + { + "@type": "ContactPoint", + "contactType": "developer support", + "email": "developers@ticketwavehq.com", + "url": "https://ticketwavehq.com/developers" + }, + { + "@type": "ContactPoint", + "contactType": "security", + "email": "security@ticketwavehq.com" + } + ] +} +``` + diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..2d89c57 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,36 @@ +# Security Policy + +## Reporting a vulnerability + +If you believe you have found a security vulnerability in the TicketWave API surface described by this spec, or in any TicketWave-operated service, please **do not** open a public GitHub issue. + +Instead, report it privately to: + +**[security@ticketwavehq.com](mailto:security@ticketwavehq.com)** + +Please include, where possible: + +- A description of the issue and its impact. +- Steps to reproduce (request payloads, headers, expected vs actual response). +- Whether the issue has been disclosed elsewhere. +- Your name / handle for credit, if you would like to be acknowledged. + +We aim to acknowledge new reports within **3 business days** and to provide a remediation timeline within **10 business days** of acknowledgement. Critical-severity issues are triaged immediately. + +## Scope + +In scope: + +- The endpoints documented in [`openapi.yaml`](./openapi.yaml). +- Authentication, authorisation, tenant-isolation, and rate-limiting behaviour described in the spec. +- The signing and verification of webhook payloads referenced in this spec. + +Out of scope (report to the project that owns them instead): + +- Vulnerabilities in third-party SDK generators (OpenAPI Generator, Stainless, Redocly). +- Issues in client code generated *from* this spec by third parties. +- Spam, social engineering, or denial-of-service attempts against TicketWave staff. + +## Safe-harbour + +Good-faith research that follows this policy will not be pursued under the Computer Misuse Act 1990 or equivalent legislation. Please do not access, modify, or exfiltrate data belonging to anyone other than yourself, and stop and notify us if you encounter such data during testing. diff --git a/openapi.yaml b/openapi.yaml index d3558ef..9c1c604 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: - title: TicketWave Access API - version: 1.0.0 + title: TicketWave API + version: 1.0.1 summary: Public REST API for TicketWave events, orders, and the access-decision engine. description: | The TicketWave public API is a JSON-over-HTTPS REST surface in two namespaces: @@ -14,7 +14,7 @@ info: and override. Rate-limited at 240 req/min/key. Scopes are `plugin:read` for GETs and `plugin:write` for state-changing routes. - Key management lives at https://www.ticketwavehq.com/dashboard/settings/api-keys. + Key management lives at https://ticketwavehq.com/dashboard/settings/api-keys. Tokens look like `tw_live_xxxxxxxxxxxxxxxx` and are passed in the `Authorization: Bearer` header. @@ -31,14 +31,14 @@ info: contact: name: TicketWave Developer Relations email: developers@ticketwavehq.com - url: https://www.ticketwavehq.com/developers + url: https://ticketwavehq.com/developers license: name: Proprietary — TicketWave Public API Terms - url: https://www.ticketwavehq.com/terms + url: https://ticketwavehq.com/terms servers: - url: https://access.ticketwavehq.com description: Production (public canonical) - - url: https://www.ticketwavehq.com + - url: https://ticketwavehq.com description: Production (dashboard alias — same deployment) tags: - name: meta @@ -1152,7 +1152,7 @@ components: description: | TicketWave API key. Format `tw_live_xxxxxxxxxxxxxxxx`. Pass via `Authorization: Bearer `. Manage at - `https://www.ticketwavehq.com/dashboard/settings/api-keys`. + `https://ticketwavehq.com/dashboard/settings/api-keys`. parameters: PageQuery: name: page