-
Notifications
You must be signed in to change notification settings - Fork 0
docs: rewrite README to house standard #40
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
yakimoto
wants to merge
3
commits into
main
Choose a base branch
from
docs/readme-refresh
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,41 +1,83 @@ | ||
| # WAVE API specification | ||
| <div align="center"> | ||
|
|
||
| OpenAPI 3.1 specification for the WAVE enterprise streaming platform APIs. | ||
| # api-spec | ||
|
|
||
| ## Overview | ||
| **OpenAPI 3.1 specification for the WAVE streaming platform API — 43 documented endpoints across 17 tag groups (streaming, production, analytics, voice, captions, clips, and more), plus generators for client SDKs.** | ||
|
|
||
| Complete API specification covering 34 API modules: streaming, production, analytics, voice, captions, chapters, clips, phone, collaboration, search, and more. | ||
|      | ||
|
|
||
| ## Usage | ||
| [wave.online](https://wave.online) · [Docs](https://docs.wave.online) · [github](https://github.com/wave-av/api-spec) · [Status](https://wave.online/status) | ||
|
|
||
| </div> | ||
|
|
||
| --- | ||
|
|
||
| ## What this is | ||
|
|
||
| A single-file OpenAPI 3.1 document (`openapi.yaml`) describing the WAVE Enterprise Streaming Platform | ||
| API: 43 endpoint paths grouped under 17 tags. It is the source of truth other WAVE packages generate | ||
| from — the [`@wave-av/sdk`](https://www.npmjs.com/package/@wave-av/sdk) TypeScript client is built from | ||
| this spec. | ||
|
|
||
| ## Quick start | ||
|
|
||
| ```bash | ||
| # Preview with Redoc | ||
| # Preview the spec in a browser (Redoc) | ||
| npx @redocly/cli preview openapi.yaml | ||
|
|
||
| # Validate | ||
| # Lint / validate | ||
| npx @redocly/cli lint openapi.yaml | ||
|
|
||
| # Generate SDKs | ||
| # Generate a client SDK (example: TypeScript fetch client) | ||
| npx @openapitools/openapi-generator-cli generate -i openapi.yaml -g typescript-fetch -o ./sdk/typescript | ||
| ``` | ||
|
|
||
| ## Authentication | ||
|
|
||
| All API requests require a Bearer token: | ||
| Most documented endpoints require a Bearer token (the x402-payable `/render` operations — | ||
| `renderVideo`, `renderPoll`, `renderEvents` — are the exception; they set `security: []` and | ||
| authenticate via an x402 payment challenge instead): | ||
|
|
||
| ``` | ||
| Authorization: Bearer YOUR_API_KEY | ||
| ``` | ||
|
|
||
| Get your API key at [wave.online/developers](https://wave.online/developers). | ||
| ## Errors | ||
|
|
||
| The spec documents a normalized error envelope used across all endpoints: | ||
|
|
||
| ```json | ||
| { "error": { "code": "...", "message": "...", "details": { "field": "..." }, "suggestions": ["..."], "did_you_mean": ["..."], "doc_url": "..." } } | ||
| ``` | ||
|
yakimoto marked this conversation as resolved.
|
||
|
|
||
| ## Related | ||
| List endpoints support `page` / `perPage` pagination, and requests are subject to rate limiting | ||
| (responses include a `Retry-After` header when throttled) — both per the spec's top-level description. | ||
|
|
||
| - [@wave-av/sdk](https://www.npmjs.com/package/@wave-av/sdk) — TypeScript SDK (34 API modules) | ||
| - [@wave-av/adk](https://www.npmjs.com/package/@wave-av/adk) — Agent Developer Kit | ||
| - [@wave-av/mcp-server](https://www.npmjs.com/package/@wave-av/mcp-server) — MCP server for AI tools | ||
| - [@wave-av/cli](https://www.npmjs.com/package/@wave-av/cli) — Command-line interface | ||
| ## Repo layout | ||
|
|
||
| | Path | What it is | | ||
| | --- | --- | | ||
| | `openapi.yaml` | The spec itself — 3,589 lines, 43 paths, 17 tags | | ||
| | `capabilities.json` | Machine-readable lifecycle metadata (this spec is tagged `ga`, version 3.0.0) | | ||
| | `scripts/public-repo-guard` | CI check that keeps this public mirror free of internal-only content | | ||
|
|
||
| ## Related packages | ||
|
|
||
| | Package | Description | | ||
| | --- | --- | | ||
| | [@wave-av/sdk](https://www.npmjs.com/package/@wave-av/sdk) | TypeScript SDK generated against this spec | | ||
| | [@wave-av/adk](https://www.npmjs.com/package/@wave-av/adk) | Agent Developer Kit | | ||
| | [@wave-av/mcp-server](https://www.npmjs.com/package/@wave-av/mcp-server) | MCP server exposing WAVE APIs as tools | | ||
| | [@wave-av/cli](https://www.npmjs.com/package/@wave-av/cli) | Command-line interface | | ||
|
|
||
| ## License | ||
|
|
||
| Apache-2.0 — see [LICENSE](LICENSE) and [NOTICE](NOTICE). | ||
|
|
||
| --- | ||
|
|
||
| <div align="center"> | ||
|
|
||
| **Built by [WAVE Online, LLC](https://wave.online)** · [wave.online](https://wave.online) · [Docs](https://docs.wave.online) | ||
|
|
||
| </div> | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.