aboutsummaryrefslogtreecommitdiffhomepage
path: root/openapi.yaml
blob: 217c4f1b62cfe138d918ffa5d8136051295fbb3b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
openapi: 3.0.0
info:
  title: Albatross internal web API
  version: 0.1.0
paths:
  /api/login:
    post:
      summary: User login
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                username:
                  type: string
                  example: "john"
                password:
                  type: string
                  example: "password123"
              required:
                - username
                - password
      responses:
        '200':
          description: Successfully authenticated
          content:
            application/json:
              schema:
                type: object
                properties:
                  token:
                    type: string
                    example: "xxxxx.xxxxx.xxxxx"
                required:
                  - token
        '401':
          description: Invalid username or password
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: "Invalid credentials"
                required:
                  - message
components:
  schemas:
    JwtPayload:
      type: object
      properties:
        user_id:
          type: number
          example: 123
        username:
          type: string
          example: "john"
        display_username:
          type: string
          example: "John Doe"
        icon_path:
          type: string
          nullable: true
          example: "/images/john.jpg"
        is_admin:
          type: boolean
          example: false
      required:
        - user_id
        - username
        - display_username
        - is_admin