Skip to content

Overview

Thin REST API over the emely Hasura backend for the collecting-society catalogue and the caller’s own society memberships. Callers authenticate with a Nhost OAuth2 access token scoped openid graphql:role:api_operator or openid graphql:role:api_user (a token may carry both role scopes); the API forwards it to Hasura under the role the route declares, which must be one the token holds. Scripts may instead send a Nhost personal access token on the /v1/me/ routes: the API exchanges it at Nhost, holds the session server-side and calls Hasura as api_user. Catalogue reads accept both roles; catalogue writes require api_operator; the /v1/me/ routes require api_user and serve only the caller’s own rows. Membership identifiers are write-only: they are accepted on writes and never returned.

Information

  • OpenAPI version: 3.1.0

Nhost OAuth2 access token scoped openid graphql:role:api_operator or openid graphql:role:api_user (a token may carry both), or a Nhost personal access token (a UUID; user routes only, it is exchanged server-side and always runs as api_user). Each route runs under one declared role the token must hold; a token holding none of the declared roles gets 403.

Security scheme type: http

Bearer format: JWT