OpenAPI 3.0 docs for all Wire APIs
This wire-server system provides OpenAPI 3.0 documentation of our HTTP REST API.
The openapi docs are correct by construction (compiled from the server code), and more or less complete.
Some endpoints are version-controlled. Show all supported versions. find out more.
Public (all available versions)
v0:
swagger-ui;
swagger.json
v1:
swagger-ui;
swagger.json
v2:
swagger-ui;
swagger.json
v3:
swagger-ui;
swagger.json
v4:
swagger-ui;
swagger.json
v5:
swagger-ui;
swagger.json
v6:
swagger-ui;
swagger.json
v7:
swagger-ui;
swagger.json
v8:
swagger-ui;
swagger.json
Internal (not versioned)
Openapi docs for internal endpoints are served per service. I.e. there's one for `brig`, one for `cannon`, etc.. This is because Openapi doesn't play well with multiple actions having the same combination of HTTP method and URL path.
brig:
swagger-ui;
swagger.json
galley:
swagger-ui;
swagger.json
spar:
swagger-ui;
swagger.json
cargohold:
swagger-ui;
swagger.json
gundeck:
swagger-ui;
swagger.json
cannon:
swagger-ui;
swagger.json
proxy:
swagger-ui;
swagger.json
Federated API (backend-to-backend)
brig (v0):
swagger-ui; swagger.json
brig (v1):
swagger-ui; swagger.json
brig (v2):
swagger-ui; swagger.json
galley (v0):
swagger-ui; swagger.json
galley (v1):
swagger-ui; swagger.json
galley (v2):
swagger-ui; swagger.json
cargohold (v0):
swagger-ui; swagger.json
cargohold (v1):
swagger-ui; swagger.json
cargohold (v2):
swagger-ui; swagger.json