Reference

The reference pages give the interfaces of the API. The options, the database diagram and the flake attributes are generated from the code.

  • Options -- the services.fediversity-api NixOS options.
  • Environment reference -- each environment variable that the API reads, its default, and the option that sets it on NixOS.
  • Wire surface -- the OpenAPI and AsyncAPI documents, and the documentation pages that each deployment serves.
  • Error codes -- the fediversity.error.* codes and their HTTP status codes.
  • Database -- the state store and its schema.
  • Flake attributes -- the flake outputs of the api entrypoint.