aboutsummaryrefslogtreecommitdiffhomepage
path: root/openapi/fortee.yaml
blob: 7e27f30fde0b85389d1db0686d1b7c295d76a74d (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
76
77
78
79
openapi: 3.0.0
info:
  title: fortee API
  version: 0.1.0
paths:
  /api/user/login:
    post:
      operationId: postLogin
      summary: User login
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            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:
                  loggedIn:
                    type: boolean
                    example: true
                  user:
                    type: object
                    properties:
                      username:
                        type: string
                        example: "john"
                    required:
                      - username
                required:
                  - loggedIn
  /api/user/view/{username}:
    get:
      operationId: getUser
      summary: Get a user
      parameters:
        - in: path
          name: username
          schema:
            type: string
          required: true
      responses:
        '200':
          description: User found
          content:
            application/json:
              schema:
                type: object
                properties:
                  uuid:
                    type: string
                    example: "11111111-1111-1111-1111-111111111111"
                  username:
                    type: string
                    example: "john"
                  avatar_url:
                    type: string
                    example: "/files/_user/11111111-1111-1111-1111-111111111111.jpg"
                required:
                  - uuid
                  - username
                  - avatar_url
        '404':
          description: User not found