chatrpg-api/docs/openapi.yaml

openapi: 3.0.4
info:
  title: API Documentation | ChatRPG
  version: 1.0.0
  description: API fro ChatRPG

servers:
  - url: http://localhost:8000
    description: Development/local server

tags:
   - name: User
   - name: Game
   - name: Character
   - name: Session
   - name: Turn

components:
  schemas:
    User:
      $ref: "./components/schemas/user.yaml"
    Game:
      $ref: "./components/schemas/game.yaml"
    Character:
      $ref: "./components/schemas/character.yaml"
    Session:
      $ref: "./components/schemas/session.yaml"
    Turn:
      $ref: "./components/schemas/turn.yaml"
  responses:
    "400":
      $ref: "./components/responses/400.yaml"
    "401":
      $ref: "./components/responses/401.yaml"
    "403":
      $ref: "./components/responses/403.yaml"
    "404":
      $ref: "./components/responses/404.yaml"
    "500":
      $ref: "./components/responses/500.yaml"
  securitySchemes:
    $ref: "./components/security.yaml"

paths:
  #Users
  /user:
    post:
      $ref: "./paths/user/create.yaml"
    get:
      $ref: "./paths/user/get_one.yaml"
  /user/login:
    post:
      $ref: "./paths/user/login.yaml"
  /user/logout:
    get:
      $ref: "./paths/user/logout.yaml"
  /user/payment-intent:
    post:
      $ref: "./paths/user/payment_intent.yaml"

  #Game
  /game:
    get:
      $ref: "./paths/game/get_many.yaml"
    post:
      $ref: "./paths/game/create.yaml"
  /game/{game_id}:
    get:
      $ref: "./paths/game/get_one.yaml"
  /game/{game_id}/character:
    post:
      $ref: "./paths/game/character/create.yaml"
  /game/{game_id}/session:
    post:
      $ref: "./paths/game/session/create.yaml"
  /game/{game_id}/session/{session_id}/turn:
    post:
      $ref: "./paths/game/session/turn/create.yaml"