Skip to content

Commit 085aaab

Browse files
Add Open API specification to the documentation (#799)
1 parent 0707e84 commit 085aaab

3 files changed

Lines changed: 1740 additions & 0 deletions

File tree

site/content/docs/test-profiles/_index.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,17 @@ Your framework must implement endpoints depending on which test profiles it part
1010

1111
Each profile is run at multiple connection counts to show how frameworks scale under increasing concurrency.
1212

13+
## API Specification
14+
15+
All benchmark endpoints are described in machine-readable OpenAPI 3.0 specifications. Each spec covers request/response schemas, status codes, production and tuned implementation rules, and links back to the relevant documentation pages.
16+
17+
The endpoints are split across two files:
18+
19+
| Spec | Profiles covered | |
20+
|------|-----------------|---|
21+
| [openapi.json](/openapi.json) | All HTTP/1.1, HTTP/2, HTTP/3, gRPC, and WebSocket profiles | [Browse](https://redocly.github.io/redoc/?url=https://www.http-arena.com/openapi.json) |
22+
| [openapi-gateway.json](/openapi-gateway.json) | Gateway profiles (production-stack) | [Browse](https://redocly.github.io/redoc/?url=https://www.http-arena.com/openapi-gateway.json) |
23+
1324
## Benchmark parameters
1425

1526
Five load generators are dispatched per profile — each one is built for a specific protocol + workload shape. See [Load Generators](../load-generators/) for per-tool details.

0 commit comments

Comments
 (0)