Skip to content
rixlhqPublic

About

OpenAPI Schema for Rixl

Resources

Stars

1 star

Watchers

0 watching

Forks

Latest commit

 

History

64 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Rixl OpenAPI Specification

CI

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.

Generated, don't edit

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.

  1. The service protos in api, auth-api and analytics define the operations.
  2. gateway/scripts/generate-openapi.sh merges them with gateway/docs/base.yaml (servers, security, shared error response) and gateway/docs/remap.jq into gateway/docs/swagger.yaml.
  3. A gateway workflow copies it here as openapi.yaml and openapi.json.
  4. A change to openapi.yaml on main runs .github/workflows/trigger.yml, which asks each SDK repository and docs to regenerate.

To change the spec, change the protos or gateway/docs/ and open a PR there.

SDK support

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.

API contract

Versioning, errors, retries, idempotency and pagination are documented once, in the Rixl docs:

Local validation

npx @stoplight/spectral-cli lint openapi.yaml

License

Rixl API Specification — © Rixl Inc.

About

OpenAPI Schema for Rixl

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors