get_one.yaml 1.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950
  1. operationId: gameGetOne
  2. summary: Get One
  3. security:
  4. - UserAuth: [tokens]
  5. description: Retrieve all necessary data for a single game
  6. tags: [Game]
  7. parameters:
  8. - name: game_id
  9. in: path
  10. description: Game ID
  11. required: true
  12. schema:
  13. type: string
  14. format: uuid
  15. example: 019ec246-dd08-7e1b-ba4e-e941d8ba2206
  16. responses:
  17. "200":
  18. description: Data fetched
  19. content:
  20. application/json:
  21. schema:
  22. type: object
  23. properties:
  24. game:
  25. $ref: "#/components/schemas/Game"
  26. character:
  27. $ref: "#/components/schemas/Character"
  28. sessions:
  29. type: array
  30. items:
  31. $ref: "#/components/schemas/Session"
  32. turns:
  33. type: array
  34. items:
  35. $ref: "#/components/schemas/Turn"
  36. remaining_tokens:
  37. type: number
  38. description: Number of tokens remaining for user
  39. example: 873042
  40. "400":
  41. $ref: "#/components/responses/400"
  42. "401":
  43. $ref: "#/components/responses/401"
  44. "403":
  45. $ref: "#/components/responses/403"
  46. "404":
  47. $ref: "#/components/responses/404"
  48. "500":
  49. $ref: "#/components/responses/500"