Skip to main content

Reference

Endpoints, configuration, commands, error codes and events, looked up by name.

Most of this reference is generated from the code that does the work, so it lists what the version you run does and cannot fall behind it. The pages say which source they were generated from. If you would rather follow a journey than look something up, the guides come first.

Protocol, configuration, commands, errors and events​

  • Protocol in plain words: the discovery document, the endpoints and the parameters each takes.
  • Configuration: every environment variable, with its type, bounds and default.
  • Command line: odudu init, seed, reap and the other commands. odudu help lists them, and odudu help seed client shows the options of one.
  • Endpoints: everything the server serves, and how each endpoint authenticates.
  • Error codes: admin API problem types, OAuth errors and the errors a command stops with.
  • Audit events: the event types, actions and reasons the audit trail records.

What is not there yet​

The roadmap lists every gap, the phase that brings it, and the decisions that mean a thing is left out on purpose.

Admin API​

The operations of the admin API, one page for each area. The same description is published as an OpenAPI document that a client generator can read.

Transcripts​

The full, recorded runs behind the guides, with every request and the response that came back.

  • Request paths: sign-in, tokens, sessions, logout and the refusals each can end in, one page for each journey.
  • Admin paths: the admin API route by route, with the response each one answers.
  • Console paths: the routes the admin console signs in and forwards its calls through.

All three are listed on the Transcripts page.