Elgato_dark/trailbase
1
0
Fork 0
mirror of https://github.com/trailbaseio/trailbase synced 2026-04-21 21:47:55 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
trailbase/docs/openapi/schema.json

1501 lines
39 KiB
JSON
Raw Normal View History

Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
{
"openapi": "3.1.0",
"info": {
"title": "TrailBase",
"description": "TrailBase APIs",
"license": {
"name": "OSL-3.0",
"identifier": "OSL-3.0"
},
"version": "0.2.0"
},
"paths": {
"/api/auth/v1/avatar/": {
"post": {
Improve OpenAPI documentation.
2025-06-23 15:04:18 +00:00
"tags": ["auth"],
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
"operationId": "create_avatar_handler",
"responses": {
"200": {
"description": "Deletion success"
}
}
},
"delete": {
Improve OpenAPI documentation.
2025-06-23 15:04:18 +00:00
"tags": ["auth"],
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
"operationId": "delete_avatar_handler",
"responses": {
"200": {
"description": "Deletion success"
}
}
}
},
"/api/auth/v1/avatar/:b64_user_id": {
"get": {
Improve OpenAPI documentation.
2025-06-23 15:04:18 +00:00
"tags": ["auth"],
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
"operationId": "get_avatar_handler",
"responses": {
"200": {
"description": "Optional Avatar file"
}
}
}
},
"/api/auth/v1/change_email/confirm/:email_verification_code": {
"get": {
Improve OpenAPI documentation.
2025-06-23 15:04:18 +00:00
"tags": ["auth"],
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
"summary": "Confirm a change of email address.",
"operationId": "change_email_confirm_handler",
"responses": {
"200": {
Update docs to astro6 and update JS dependencies.
2026-03-18 19:30:26 +00:00
"description": "Success, when redirect_uri is not present."
},
"303": {
"description": "Success, when redirect_uri is present."
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
}
}
}
},
"/api/auth/v1/change_email/request": {
"post": {
Improve OpenAPI documentation.
2025-06-23 15:04:18 +00:00
"tags": ["auth"],
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
"summary": "Request an email change.",
"operationId": "change_email_request_handler",
Update docs to astro6 and update JS dependencies.
2026-03-18 19:30:26 +00:00
"parameters": [
{
"name": "redirect_uri",
"in": "query",
"description": "Success (and error if err_redirect_uri not present) redirect target for non-JSON requests.",
"required": false,
"schema": {
"type": ["string", "null"]
}
},
{
"name": "err_redirect_uri",
"in": "query",
"description": "Error redirect target for non-JSON requests.",
"required": false,
"schema": {
"type": ["string", "null"]
}
}
],
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChangeEmailRequest"
}
}
},
"required": true
},
"responses": {
"200": {
Update docs to astro6 and update JS dependencies.
2026-03-18 19:30:26 +00:00
"description": "Success, when redirect_uri is not present and JSON input"
},
"303": {
"description": "Success, when redirect_uri is present or HTML form input"
},
"400": {
"description": "Bad request."
},
"403": {
"description": "User conflict."
},
"429": {
"description": "Too many attempts."
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
}
}
}
},
"/api/auth/v1/change_password": {
"post": {
Improve OpenAPI documentation.
2025-06-23 15:04:18 +00:00
"tags": ["auth"],
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
"summary": "Request a change of password.",
"operationId": "change_password_handler",
"parameters": [
{
Rename `redirect_to` query parameter to `redirect_uri` in accordance with RFC 6749. Reference: https://datatracker.ietf.org/doc/html/rfc6749#appendix-A.6
2025-08-05 08:16:21 +00:00
"name": "redirect_uri",
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
"in": "query",
Update docs to astro6 and update JS dependencies.
2026-03-18 19:30:26 +00:00
"description": "Success (and error if err_redirect_uri not present) redirect target for non-JSON requests.",
"required": false,
"schema": {
"type": ["string", "null"]
}
},
{
"name": "err_redirect_uri",
"in": "query",
"description": "Error redirect target for non-JSON requests.",
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
"required": false,
"schema": {
"type": ["string", "null"]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChangePasswordRequest"
}
}
},
"required": true
},
"responses": {
"200": {
Update docs to astro6 and update JS dependencies.
2026-03-18 19:30:26 +00:00
"description": "Success, when redirect_uri not present."
},
"303": {
"description": "Success, when redirect_uri present."
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
}
}
}
},
"/api/auth/v1/delete": {
"delete": {
Improve OpenAPI documentation.
2025-06-23 15:04:18 +00:00
"tags": ["auth"],
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
"summary": "Get public profile of the given user.",
"operationId": "delete_handler",
"responses": {
"200": {
"description": "User deleted."
}
}
}
},
"/api/auth/v1/login": {
"post": {
Improve OpenAPI documentation.
2025-06-23 15:04:18 +00:00
"tags": ["auth"],
"summary": "Log in users by email and password.",
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
"operationId": "login_handler",
"parameters": [
{
Rename `redirect_to` query parameter to `redirect_uri` in accordance with RFC 6749. Reference: https://datatracker.ietf.org/doc/html/rfc6749#appendix-A.6
2025-08-05 08:16:21 +00:00
"name": "redirect_uri",
"in": "query",
"required": false,
"schema": {
"type": ["string", "null"]
}
},
{
Update docs to astro6 and update JS dependencies.
2026-03-18 19:30:26 +00:00
"name": "mfa_redirect_uri",
Rename `redirect_to` query parameter to `redirect_uri` in accordance with RFC 6749. Reference: https://datatracker.ietf.org/doc/html/rfc6749#appendix-A.6
2025-08-05 08:16:21 +00:00
"in": "query",
"required": false,
"schema": {
"type": ["string", "null"]
}
},
Update docs to astro6 and update JS dependencies.
2026-03-18 19:30:26 +00:00
{
"name": "response_type",
"in": "query",
"required": false,
"schema": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ResponseType"
}
]
}
},
Rename `redirect_to` query parameter to `redirect_uri` in accordance with RFC 6749. Reference: https://datatracker.ietf.org/doc/html/rfc6749#appendix-A.6
2025-08-05 08:16:21 +00:00
{
"name": "pkce_code_challenge",
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
"in": "query",
"required": false,
"schema": {
"type": ["string", "null"]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoginRequest"
}
}
},
"required": true
},
Update docs to astro6 and update JS dependencies.
2026-03-18 19:30:26 +00:00
"responses": {
"200": {
"description": "Auth, refresh & CSRF tokens.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoginResponse"
}
}
}
},
"303": {
"description": "Form Fail OR Auth, refresh & CSRF tokens via cookies."
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden, when login succeeded but MFA is needed.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MfaTokenResponse"
}
}
}
}
}
}
},
"/api/auth/v1/login_mfa": {
"post": {
"tags": ["auth"],
"summary": "Log in users by email and password.",
"operationId": "login_mfa_handler",
"parameters": [
{
"name": "redirect_uri",
"in": "query",
"required": false,
"schema": {
"type": ["string", "null"]
}
},
{
"name": "mfa_redirect_uri",
"in": "query",
"required": false,
"schema": {
"type": ["string", "null"]
}
},
{
"name": "response_type",
"in": "query",
"required": false,
"schema": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ResponseType"
}
]
}
},
{
"name": "pkce_code_challenge",
"in": "query",
"required": false,
"schema": {
"type": ["string", "null"]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoginMfaRequest"
}
}
},
"required": true
},
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
"responses": {
"200": {
"description": "Auth & refresh tokens.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoginResponse"
}
}
}
}
}
}
},
"/api/auth/v1/logout": {
"get": {
Improve OpenAPI documentation.
2025-06-23 15:04:18 +00:00
"tags": ["auth"],
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
"summary": "Logs out the current user and delete **all** pending sessions for that user.",
"description": "Relies on the client to drop any auth tokens. We delete the session to avoid refresh tokens\nbringing a logged out session back to live.",
"operationId": "logout_handler",
"parameters": [
{
Rename `redirect_to` query parameter to `redirect_uri` in accordance with RFC 6749. Reference: https://datatracker.ietf.org/doc/html/rfc6749#appendix-A.6
2025-08-05 08:16:21 +00:00
"name": "redirect_uri",
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
"in": "query",
"required": false,
"schema": {
"type": ["string", "null"]
}
}
],
"responses": {
"200": {
"description": "Auth & refresh tokens."
}
}
Improve OpenAPI documentation.
2025-06-23 15:04:18 +00:00
},
"post": {
"tags": ["auth"],
"summary": "Logs out the current user and deletes the specific session for the given refresh token.",
"description": "Relies on the client to drop any auth tokens.",
"operationId": "post_logout_handler",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LogoutRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Auth & refresh tokens."
}
}
}
},
"/api/auth/v1/oauth/providers": {
"get": {
"tags": ["oauth"],
"summary": "List configured OAuth providers.",
"operationId": "list_configured_providers_handler",
"responses": {
"200": {
"description": "List of OAuth providers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfiguredOAuthProvidersResponse"
}
}
}
}
}
}
},
"/api/auth/v1/oauth/{provider}/callback": {
"get": {
"tags": ["oauth"],
"summary": "This handler receives the ?code=<>&state=<>, uses it to get an external oauth token, gets the\nuser's information, creates a new local user if needed, and finally mints our own tokens.",
"operationId": "callback_from_external_auth_provider",
"parameters": [
{
"name": "code",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "state",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "provider",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Redirect."
}
}
}
},
"/api/auth/v1/oauth/{provider}/login": {
"get": {
"tags": ["oauth"],
"summary": "Log in via external OAuth provider.",
"operationId": "login_with_external_auth_provider",
"parameters": [
{
Rename `redirect_to` query parameter to `redirect_uri` in accordance with RFC 6749. Reference: https://datatracker.ietf.org/doc/html/rfc6749#appendix-A.6
2025-08-05 08:16:21 +00:00
"name": "redirect_uri",
Improve OpenAPI documentation.
2025-06-23 15:04:18 +00:00
"in": "query",
"required": false,
"schema": {
"type": ["string", "null"]
}
},
{
Update docs to astro6 and update JS dependencies.
2026-03-18 19:30:26 +00:00
"name": "mfa_redirect_uri",
Improve OpenAPI documentation.
2025-06-23 15:04:18 +00:00
"in": "query",
"required": false,
"schema": {
"type": ["string", "null"]
}
},
Update docs to astro6 and update JS dependencies.
2026-03-18 19:30:26 +00:00
{
"name": "response_type",
"in": "query",
"required": false,
"schema": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ResponseType"
}
]
}
},
Improve OpenAPI documentation.
2025-06-23 15:04:18 +00:00
{
"name": "pkce_code_challenge",
"in": "query",
"required": false,
"schema": {
"type": ["string", "null"]
}
},
{
"name": "provider",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Redirect."
}
}
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
}
},
Update docs to astro6 and update JS dependencies.
2026-03-18 19:30:26 +00:00
"/api/auth/v1/otp/login": {
"post": {
"tags": ["auth"],
"operationId": "login_otp_handler",
"parameters": [
{
"name": "email",
"in": "query",
"required": false,
"schema": {
"type": ["string", "null"]
}
},
{
"name": "code",
"in": "query",
"required": false,
"schema": {
"type": ["string", "null"]
}
},
{
"name": "redirect_uri",
"in": "query",
"required": false,
"schema": {
"type": ["string", "null"]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoginOtpRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Auth tokens for JSONl logins.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoginResponse"
}
}
}
},
"303": {
"description": "For form logins."
},
"400": {
"description": "Bad request"
}
}
}
},
"/api/auth/v1/otp/request": {
"post": {
"tags": ["auth"],
"operationId": "request_otp_handler",
"parameters": [
{
"name": "redirect_uri",
"in": "query",
"required": false,
"schema": {
"type": ["string", "null"]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequestOtpRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OTP sent or user not found, when redirect_uri not present."
},
"303": {
"description": "OTP sent or user not found, when redirect_uri present."
},
"400": {
"description": "Bad request"
},
"429": {
"description": "Too many attempts"
}
}
}
},
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
"/api/auth/v1/refresh": {
"post": {
Improve OpenAPI documentation.
2025-06-23 15:04:18 +00:00
"tags": ["auth"],
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
"summary": "Refreshes auth tokens given a refresh token.",
"description": "NOTE: This is a json-only API, since cookies will be auto-refreshed.",
"operationId": "refresh_handler",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RefreshRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Refreshed auth tokens.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RefreshResponse"
}
}
}
}
}
}
},
"/api/auth/v1/register": {
"post": {
Improve OpenAPI documentation.
2025-06-23 15:04:18 +00:00
"tags": ["auth"],
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
"summary": "Registers a new user with email and password.",
"operationId": "register_user_handler",
Update docs to astro6 and update JS dependencies.
2026-03-18 19:30:26 +00:00
"parameters": [
{
"name": "redirect_uri",
"in": "query",
"required": false,
"schema": {
"type": ["string", "null"]
}
}
],
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RegisterUserRequest"
}
}
},
"required": true
},
"responses": {
Remap some auth error codes for user register, reset password, and verify email flows and fix OpenAPI docs. #211
2026-02-16 11:01:50 +00:00
"303": {
Update docs to astro6 and update JS dependencies.
2026-03-18 19:30:26 +00:00
"description": "Form fail OR success, new user registered, or user already exists."
Remap some auth error codes for user register, reset password, and verify email flows and fix OpenAPI docs. #211
2026-02-16 11:01:50 +00:00
},
"424": {
"description": "Failed to send verification Email."
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
}
}
}
},
"/api/auth/v1/reset_password/request": {
"post": {
Improve OpenAPI documentation.
2025-06-23 15:04:18 +00:00
"tags": ["auth"],
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
"summary": "Request a password reset.",
"operationId": "reset_password_request_handler",
Update docs to astro6 and update JS dependencies.
2026-03-18 19:30:26 +00:00
"parameters": [
{
"name": "redirect_uri",
"in": "query",
"required": false,
"schema": {
"type": ["string", "null"]
}
}
],
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResetPasswordRequest"
}
}
},
"required": true
},
"responses": {
Update docs to astro6 and update JS dependencies.
2026-03-18 19:30:26 +00:00
"200": {
"description": "Success or user not found, when redirect_uri not present."
},
Remap some auth error codes for user register, reset password, and verify email flows and fix OpenAPI docs. #211
2026-02-16 11:01:50 +00:00
"303": {
Update docs to astro6 and update JS dependencies.
2026-03-18 19:30:26 +00:00
"description": "Success or user not found, when redirect_uri present"
Remap some auth error codes for user register, reset password, and verify email flows and fix OpenAPI docs. #211
2026-02-16 11:01:50 +00:00
},
"400": {
"description": "Malformed email address."
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
}
}
}
},
Remap some auth error codes for user register, reset password, and verify email flows and fix OpenAPI docs. #211
2026-02-16 11:01:50 +00:00
"/api/auth/v1/reset_password/update": {
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
"post": {
Improve OpenAPI documentation.
2025-06-23 15:04:18 +00:00
"tags": ["auth"],
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
"summary": "Endpoint for setting a new password after the user has requested a reset and provided a\nreplacement password.",
"operationId": "reset_password_update_handler",
Update docs to astro6 and update JS dependencies.
2026-03-18 19:30:26 +00:00
"parameters": [
{
"name": "redirect_uri",
"in": "query",
"required": false,
"schema": {
"type": ["string", "null"]
}
}
],
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResetPasswordUpdateRequest"
}
}
},
"required": true
},
"responses": {
Remap some auth error codes for user register, reset password, and verify email flows and fix OpenAPI docs. #211
2026-02-16 11:01:50 +00:00
"303": {
"description": "Success. Redirect to provided `redirect_uri` or login page."
},
"400": {
"description": "Bad request: invalid redirect_uri."
},
"401": {
"description": "Unauthorized: invalid reset code."
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
}
}
}
},
"/api/auth/v1/status": {
"get": {
Improve OpenAPI documentation.
2025-06-23 15:04:18 +00:00
"tags": ["auth"],
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
"summary": "Check login status.",
"operationId": "login_status_handler",
"responses": {
"200": {
"description": "Auth & refresh tokens.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoginStatusResponse"
}
}
}
}
}
}
},
"/api/auth/v1/token": {
"post": {
Improve OpenAPI documentation.
2025-06-23 15:04:18 +00:00
"tags": ["auth"],
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
"summary": "Exchange authorization code for auth tokens.",
"description": "This API endpoint is meant for client-side applications (SPA, mobile, desktop, ...) using the\nweb-auth flow.",
"operationId": "auth_code_to_token_handler",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuthCodeToTokenRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Converts auth & pkce codes to tokens.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TokenResponse"
}
}
}
}
}
}
},
Update docs to astro6 and update JS dependencies.
2026-03-18 19:30:26 +00:00
"/api/auth/v1/totp/confirm": {
"post": {
"tags": ["auth"],
"summary": "Verify the current user's TOTP",
"operationId": "register_totp_confirm_handler",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfirmRegisterTotpRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "TOTP verified"
}
}
}
},
"/api/auth/v1/totp/register": {
"get": {
"tags": ["auth"],
"summary": "Sign-up user for TOTP second factor.",
"operationId": "register_totp_request_handler",
"responses": {
"200": {
"description": "TOTP secret and QR code URI.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RegisterTotpResponse"
}
}
}
}
}
}
},
"/api/auth/v1/totp/unregister": {
"post": {
"tags": ["auth"],
"operationId": "unregister_totp_handler",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DisableTotpRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "TOTP disabled successfully."
}
}
}
},
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
"/api/auth/v1/verify_email/confirm/:email_verification_code": {
"get": {
Improve OpenAPI documentation.
2025-06-23 15:04:18 +00:00
"tags": ["auth"],
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
"summary": "Request a new email to verify email address.",
"operationId": "verify_email_handler",
"responses": {
Update docs to astro6 and update JS dependencies.
2026-03-18 19:30:26 +00:00
"200": {
"description": "Email verified, when redirect_uri not present"
},
Remap some auth error codes for user register, reset password, and verify email flows and fix OpenAPI docs. #211
2026-02-16 11:01:50 +00:00
"303": {
Update docs to astro6 and update JS dependencies.
2026-03-18 19:30:26 +00:00
"description": "Email verified, when redirect_uri present"
Remap some auth error codes for user register, reset password, and verify email flows and fix OpenAPI docs. #211
2026-02-16 11:01:50 +00:00
},
"400": {
"description": "Bad request: invalid redirect_uri."
},
"401": {
"description": "Unauthorized: invalid reset code."
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
}
}
}
},
"/api/auth/v1/verify_email/trigger": {
"get": {
Improve OpenAPI documentation.
2025-06-23 15:04:18 +00:00
"tags": ["auth"],
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
"summary": "Request a new email to verify email address.",
"operationId": "request_email_verification_handler",
Update docs to astro6 and update JS dependencies.
2026-03-18 19:30:26 +00:00
"parameters": [
{
"name": "email",
"in": "query",
"required": true,
"schema": {
"type": "string"
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
}
},
Update docs to astro6 and update JS dependencies.
2026-03-18 19:30:26 +00:00
{
"name": "redirect_uri",
"in": "query",
"required": false,
"schema": {
"type": ["string", "null"]
}
}
],
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
"responses": {
Update docs to astro6 and update JS dependencies.
2026-03-18 19:30:26 +00:00
"200": {
"description": "Email verification sent or user not found, when redirect_uri not present."
},
Remap some auth error codes for user register, reset password, and verify email flows and fix OpenAPI docs. #211
2026-02-16 11:01:50 +00:00
"303": {
Update docs to astro6 and update JS dependencies.
2026-03-18 19:30:26 +00:00
"description": "Email verification sent or user not found, when redirect_uri present."
Remap some auth error codes for user register, reset password, and verify email flows and fix OpenAPI docs. #211
2026-02-16 11:01:50 +00:00
},
"400": {
"description": "Malformed email address."
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
}
}
}
Improve OpenAPI documentation.
2025-06-23 15:04:18 +00:00
},
"/api/records/v1/{name}": {
"get": {
"tags": ["records"],
"summary": "Lists records matching the given filters",
"operationId": "list_records_handler",
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Matching records."
}
}
},
"post": {
"tags": ["records"],
"summary": "Create new record.",
"operationId": "create_record_handler",
"parameters": [
{
Rename `redirect_to` query parameter to `redirect_uri` in accordance with RFC 6749. Reference: https://datatracker.ietf.org/doc/html/rfc6749#appendix-A.6
2025-08-05 08:16:21 +00:00
"name": "redirect_uri",
Improve OpenAPI documentation.
2025-06-23 15:04:18 +00:00
"in": "query",
"description": "Redirect user to this address upon successful record creation.\nThis only exists to support insertions via static HTML form actions.\n\nWe may want to have a different on-error redirect to better support the static HTML use-case.",
"required": false,
"schema": {
"type": ["string", "null"]
}
},
{
"name": "name",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {}
}
},
"required": true
},
"responses": {
"200": {
Create a new unique filename for uploads `{stem}_{rand#10}.{ext}` in accordance with e.g. vite or PB. Use this as the primary way of accessing files. Having a filename extension may be useful for some consumers and having a unique name helps with content-caching strategies. #155 Also strip/hide uuid. Not really secret but we don't want folks to rely on it over the unique filename.
2025-09-25 19:41:04 +00:00
"description": "Ids of successfully created records.",
Improve OpenAPI documentation.
2025-06-23 15:04:18 +00:00
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateRecordResponse"
}
}
}
}
}
}
},
"/api/records/v1/{name}/schema": {
"get": {
"tags": ["records"],
"summary": "Retrieve json schema associated with given record api.",
"operationId": "json_schema_handler",
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "JSON schema."
}
}
}
},
"/api/records/v1/{name}/subscribe/{record}": {
"get": {
"tags": ["records"],
"summary": "Read record.",
"operationId": "add_subscription_sse_handler",
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "record",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
Remap some auth error codes for user register, reset password, and verify email flows and fix OpenAPI docs. #211
2026-02-16 11:01:50 +00:00
"description": "Starts streaming changes to matching records via SSE/WebSocket"
Improve OpenAPI documentation.
2025-06-23 15:04:18 +00:00
}
}
}
},
"/api/records/v1/{name}/{record}": {
"get": {
"tags": ["records"],
"summary": "Read record.",
"operationId": "read_record_handler",
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "record",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Record contents.",
"content": {
"application/json": {
"schema": {}
}
}
}
}
},
"delete": {
"tags": ["records"],
"summary": "Delete record.",
"operationId": "delete_record_handler",
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "record",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful deletion."
}
}
},
"patch": {
"tags": ["records"],
"summary": "Update existing record.",
"operationId": "update_record_handler",
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "record",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful update."
}
}
}
},
"/api/records/v1/{name}/{record}/file/{column_name}": {
"get": {
"tags": ["records"],
"summary": "Read file associated with record.",
Create a new unique filename for uploads `{stem}_{rand#10}.{ext}` in accordance with e.g. vite or PB. Use this as the primary way of accessing files. Having a filename extension may be useful for some consumers and having a unique name helps with content-caching strategies. #155 Also strip/hide uuid. Not really secret but we don't want folks to rely on it over the unique filename.
2025-09-25 19:41:04 +00:00
"description": "You may prefer using the more general \"files\" (plural) handler below. Since using unique\nfilenames does help with the content lifecycle, such as caching.",
Improve OpenAPI documentation.
2025-06-23 15:04:18 +00:00
"operationId": "get_uploaded_file_from_record_handler",
"responses": {
"200": {
"description": "File contents."
}
}
}
},
Breaking change: remove support for getting files by index.
2025-10-07 11:52:33 +00:00
"/api/records/v1/{name}/{record}/files/{column_name}/{file_name}": {
Improve OpenAPI documentation.
2025-06-23 15:04:18 +00:00
"get": {
"tags": ["records"],
"summary": "Read single file from list associated with record.",
"operationId": "get_uploaded_files_from_record_handler",
"responses": {
"200": {
"description": "File contents."
}
}
}
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
}
},
"components": {
"schemas": {
"AuthCodeToTokenRequest": {
"type": "object",
"properties": {
"authorization_code": {
"type": ["string", "null"]
},
"pkce_code_verifier": {
"type": ["string", "null"]
}
}
},
"ChangeEmailRequest": {
"type": "object",
"required": ["csrf_token", "new_email"],
"properties": {
"csrf_token": {
"type": "string"
},
Update docs to astro6 and update JS dependencies.
2026-03-18 19:30:26 +00:00
"err_redirect_uri": {
"type": ["string", "null"],
"description": "Error redirect target for non-JSON requests."
},
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
"new_email": {
"type": "string"
},
"old_email": {
Update docs to astro6 and update JS dependencies.
2026-03-18 19:30:26 +00:00
"type": ["string", "null"],
"description": "Old email address. Only required in form mode."
},
"redirect_uri": {
"type": ["string", "null"],
"description": "Success (and error if err_redirect_uri not present) redirect target for non-JSON requests."
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
}
}
},
"ChangePasswordRequest": {
"type": "object",
"required": ["old_password", "new_password", "new_password_repeat"],
"properties": {
Update docs to astro6 and update JS dependencies.
2026-03-18 19:30:26 +00:00
"err_redirect_uri": {
"type": ["string", "null"],
"description": "Error redirect target for non-JSON requests."
},
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
"new_password": {
"type": "string"
},
"new_password_repeat": {
"type": "string"
},
"old_password": {
"type": "string"
Update docs to astro6 and update JS dependencies.
2026-03-18 19:30:26 +00:00
},
"redirect_uri": {
"type": ["string", "null"],
"description": "Success (and error if err_redirect_uri not present) redirect target for non-JSON requests."
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
}
}
},
Improve OpenAPI documentation.
2025-06-23 15:04:18 +00:00
"ConfiguredOAuthProvidersResponse": {
"type": "object",
"required": ["providers"],
"properties": {
"providers": {
"type": "array",
"items": {
"type": "array",
"items": false,
"prefixItems": [
{
"type": "string"
},
{
"type": "string"
}
]
},
"description": "List of tuples (<name>, <display_name>)."
}
}
},
Update docs to astro6 and update JS dependencies.
2026-03-18 19:30:26 +00:00
"ConfirmRegisterTotpRequest": {
"type": "object",
"required": ["totp_url", "totp"],
"properties": {
"totp": {
"type": "string"
},
"totp_url": {
"type": "string"
}
}
},
Improve OpenAPI documentation.
2025-06-23 15:04:18 +00:00
"CreateRecordResponse": {
"type": "object",
"required": ["ids"],
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string"
},
Create a new unique filename for uploads `{stem}_{rand#10}.{ext}` in accordance with e.g. vite or PB. Use this as the primary way of accessing files. Having a filename extension may be useful for some consumers and having a unique name helps with content-caching strategies. #155 Also strip/hide uuid. Not really secret but we don't want folks to rely on it over the unique filename.
2025-09-25 19:41:04 +00:00
"description": "Url-Safe base64 encoded ids of the newly created record."
Improve OpenAPI documentation.
2025-06-23 15:04:18 +00:00
}
}
},
Update docs to astro6 and update JS dependencies.
2026-03-18 19:30:26 +00:00
"DisableTotpRequest": {
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
"type": "object",
Update docs to astro6 and update JS dependencies.
2026-03-18 19:30:26 +00:00
"required": ["totp"],
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
"properties": {
Update docs to astro6 and update JS dependencies.
2026-03-18 19:30:26 +00:00
"totp": {
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
"type": "string"
}
}
},
Update docs to astro6 and update JS dependencies.
2026-03-18 19:30:26 +00:00
"LoginMfaRequest": {
"type": "object",
"required": ["mfa_token"],
"properties": {
"mfa_redirect_uri": {
"type": ["string", "null"]
},
"mfa_token": {
"type": "string"
},
"pkce_code_challenge": {
"type": ["string", "null"]
},
"redirect_uri": {
"type": ["string", "null"]
},
"response_type": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ResponseType"
}
]
},
"totp": {
"type": ["string", "null"]
}
}
},
"LoginOtpRequest": {
"type": "object",
"properties": {
"code": {
"type": ["string", "null"]
},
"email": {
"type": ["string", "null"]
},
"redirect_uri": {
"type": ["string", "null"]
}
}
},
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
"LoginRequest": {
"type": "object",
"required": ["email", "password"],
"properties": {
"email": {
"type": "string"
},
Update docs to astro6 and update JS dependencies.
2026-03-18 19:30:26 +00:00
"mfa_redirect_uri": {
"type": ["string", "null"]
},
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
"password": {
"type": "string"
},
"pkce_code_challenge": {
"type": ["string", "null"]
},
Rename `redirect_to` query parameter to `redirect_uri` in accordance with RFC 6749. Reference: https://datatracker.ietf.org/doc/html/rfc6749#appendix-A.6
2025-08-05 08:16:21 +00:00
"redirect_uri": {
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
"type": ["string", "null"]
},
"response_type": {
Update docs to astro6 and update JS dependencies.
2026-03-18 19:30:26 +00:00
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/ResponseType"
}
]
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
}
}
},
"LoginResponse": {
"type": "object",
"required": ["auth_token", "refresh_token", "csrf_token"],
"properties": {
"auth_token": {
"type": "string"
},
"csrf_token": {
"type": "string"
},
"refresh_token": {
"type": "string"
}
}
},
"LoginStatusResponse": {
"type": "object",
"properties": {
"auth_token": {
"type": ["string", "null"]
},
"csrf_token": {
"type": ["string", "null"]
},
"refresh_token": {
"type": ["string", "null"]
}
}
},
Improve OpenAPI documentation.
2025-06-23 15:04:18 +00:00
"LogoutRequest": {
"type": "object",
"required": ["refresh_token"],
"properties": {
"refresh_token": {
"type": "string"
}
}
},
Update docs to astro6 and update JS dependencies.
2026-03-18 19:30:26 +00:00
"MfaTokenResponse": {
"type": "object",
"required": ["mfa_token"],
"properties": {
"mfa_token": {
"type": "string"
}
}
},
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
"RefreshRequest": {
"type": "object",
"required": ["refresh_token"],
"properties": {
"refresh_token": {
"type": "string"
}
}
},
"RefreshResponse": {
"type": "object",
"required": ["auth_token", "csrf_token"],
"properties": {
"auth_token": {
"type": "string"
},
"csrf_token": {
"type": "string"
}
}
},
Update docs to astro6 and update JS dependencies.
2026-03-18 19:30:26 +00:00
"RegisterTotpResponse": {
"type": "object",
"required": ["totp_url"],
"properties": {
"png": {
"type": ["string", "null"]
},
"totp_url": {
"type": "string"
}
}
},
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
"RegisterUserRequest": {
"type": "object",
"required": ["email", "password", "password_repeat"],
"properties": {
"email": {
"type": "string"
},
"password": {
"type": "string"
},
"password_repeat": {
"type": "string"
Update docs to astro6 and update JS dependencies.
2026-03-18 19:30:26 +00:00
},
"redirect_uri": {
"type": ["string", "null"]
}
}
},
"RequestOtpRequest": {
"type": "object",
"required": ["email"],
"properties": {
"email": {
"type": "string"
},
"redirect_uri": {
"type": ["string", "null"]
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
}
}
},
"ResetPasswordRequest": {
"type": "object",
"required": ["email"],
"properties": {
"email": {
"type": "string"
Update docs to astro6 and update JS dependencies.
2026-03-18 19:30:26 +00:00
},
"redirect_uri": {
"type": ["string", "null"]
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
}
}
},
"ResetPasswordUpdateRequest": {
"type": "object",
Update docs to astro6 and update JS dependencies.
2026-03-18 19:30:26 +00:00
"required": ["password", "password_repeat", "password_reset_token"],
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
"properties": {
"password": {
"type": "string"
},
"password_repeat": {
"type": "string"
Create a new unique filename for uploads `{stem}_{rand#10}.{ext}` in accordance with e.g. vite or PB. Use this as the primary way of accessing files. Having a filename extension may be useful for some consumers and having a unique name helps with content-caching strategies. #155 Also strip/hide uuid. Not really secret but we don't want folks to rely on it over the unique filename.
2025-09-25 19:41:04 +00:00
},
Update docs to astro6 and update JS dependencies.
2026-03-18 19:30:26 +00:00
"password_reset_token": {
Create a new unique filename for uploads `{stem}_{rand#10}.{ext}` in accordance with e.g. vite or PB. Use this as the primary way of accessing files. Having a filename extension may be useful for some consumers and having a unique name helps with content-caching strategies. #155 Also strip/hide uuid. Not really secret but we don't want folks to rely on it over the unique filename.
2025-09-25 19:41:04 +00:00
"type": "string"
},
"redirect_uri": {
"type": ["string", "null"]
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
}
}
},
Update docs to astro6 and update JS dependencies.
2026-03-18 19:30:26 +00:00
"ResponseType": {
"type": "string",
"description": "https://www.rfc-editor.org/rfc/rfc6749#section-3.1.1",
"enum": ["token", "code"]
},
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
"TokenResponse": {
"type": "object",
"required": ["auth_token", "refresh_token", "csrf_token"],
"properties": {
"auth_token": {
"type": "string"
},
"csrf_token": {
"type": "string"
},
"refresh_token": {
"type": "string"
}
}
}
}
},
Improve OpenAPI documentation.
2025-06-23 15:04:18 +00:00
"tags": [
{
"name": "auth",
"description": "Auth-related APIs"
}
]
Include OpenApi schema exports (w/o swagger UI) into default build and add auth OpenAPI to docs.
2025-06-22 14:25:59 +00:00
}
Reference in a new issue Copy permalink