The published OpenAPI 3.1 specification for the Rixl platform API (https://api.rixl.com). Every Rixl SDK and the API reference are generated from openapi.yaml.
openapi.yaml and openapi.json are generated in rixlhq/gateway and copied here whenever the generated spec changes on gateway main. Edits made in this repository are overwritten.
- The service protos in
api,auth-apiandanalyticsdefine the operations. gateway/scripts/generate-openapi.shmerges them withgateway/docs/base.yaml(servers, security, shared error response) andgateway/docs/remap.jqintogateway/docs/swagger.yaml.- A gateway workflow copies it here as
openapi.yamlandopenapi.json. - A change to
openapi.yamlonmainruns.github/workflows/trigger.yml, which asks each SDK repository anddocsto regenerate.
To change the spec, change the protos or gateway/docs/ and open a PR there.
| SDK | Repository | Status |
|---|---|---|
JavaScript / TypeScript (@rixl/sdk) |
rixlhq/rixl-js | Supported |
| Go | rixlhq/rixl-go | Preview |
| Python | rixlhq/rixl-python | Preview |
| PHP | rixlhq/rixl-php | Preview |
| Java | rixlhq/rixl-java | Preview |
| C# | rixlhq/rixl-csharp | Preview |
| Ruby | rixlhq/rixl-ruby | Unmaintained |
| Rust | rixlhq/rixl-rust | Unmaintained |
- Supported: covered by the versioning policy.
- Preview: generated on every spec change, with no stability guarantees between releases.
- Unmaintained: generation is stale and the code does not match the current API paths. Don't use these in new integrations.
Versioning, errors, retries, idempotency and pagination are documented once, in the Rixl docs:
npx @stoplight/spectral-cli lint openapi.yamlRixl API Specification — © Rixl Inc.