Skip to main content
Version: 0.2.1

AFCT Dashboard API

Auto-generated reference for the AFCT Dashboard API. Paths and methods are inferred from the route files so the docs stay in step with the code; individual endpoints are enriched with an @openapi block in the source.

Authentication​

The API authenticates with the NextAuth session cookie. Most endpoints require a signed-in session; some additionally require an ADMIN, FACULTY, or TA role, and the requirement is stated on each operation. A few endpoints (health, signup, login, public settings) need no session.

Conventions​

  • Base URL: same-origin, relative to the deployed app.
  • Errors: failures return a JSON body with an error or message string (see the Error schema).
  • Dates: datetime-local strings (YYYY-MM-DDTHH:MM) are interpreted in the actor's timezone and stored as UTC.
  • Every operation links to its source on GitHub.

Authentication​

NextAuth session cookie (__Secure-next-auth.session-token over HTTPS). Role requirements, where they apply, are noted in each operation description.

Security Scheme Type:

apiKey

Cookie parameter name:

next-auth.session-token