HATS-Tools/swagger.yaml at main · sthetix/HATS-Tools · GitHub

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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
openapi: 3.0.2
info:
  description: Cheat Slips
  title: Cheat Slips API
  version: 0.0.2

servers:
  - url: https://www.cheatslips.com/api/v1
    description: Production server

security:
  - ApiKeyAuth: [ ]

paths:
  /token:
    post:
      description: Get the api token for the user
      security: [ ]
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Token'
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Token'
        401:
          description: Error

  /cheats/{titleId}:
    get:
      tags:
        - Cheats
      description: Get all available cheats for a given game
      parameters:
        - in: path
          name: titleId
          schema:
            type: string
          required: true
          description: TitleId of the game

      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Game'

  /cheats/{titleId}/{buildId}:
    get:
      tags:
        - Cheats
      description: get all available cheats for a given game and revision
      parameters:
        - in: path
          name: titleId
          schema:
            type: string
          required: true
          description: TitleId of the game
        - in: path
          name: buildId
          schema:
            type: string
          required: true
          description: BuildId of the game

      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Game'

  /cheats/count:
    get:
      tags:
        - Cheats
      description: Return the total number of cheats in the database
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheatCount'


  /cheats/find/{name}:
    get:
      tags:
        - Cheats
      description: Get all cheats for a given game's name
      parameters:
        - in: path
          name: name
          schema:
            type: string
          required: true
          description: Name of the game

      responses:
        200:
          description: OK


components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      name: X-API-TOKEN
      description: Api token for the user
      in: header
  schemas:

    Game:
      properties:
        slug:
          type: string
          description: Slug of the game
        name:
          type: string
          description: Official name of the game
        image:
          type: string
          description: URL for the cover of the game
        titleId:
          type: string
          description: Game title id
        cheats:
          type: array
          description: Available cheats
          items:
            $ref: '#/components/schemas/Cheat'

    Cheat:
      properties:
        id:
          description: Unique identifier for the cheat
          type: integer
          readOnly: true
        buildId:
          description: BuildId of the game
          type: string
        content:
          description: Content of the cheat
          type: string
        credits:
          description: Credits of the cheat
          type: string


    CheatCount:
      properties:
        count:
          type: integer

    Token:
      properties:
        email:
          description: Email of the user
          type: string
          writeOnly: true
        password:
          description: Password of the user
          type: string
          writeOnly: true
        token:
          description: Token for the user (keep it secret !!)
          type: string
          readOnly: true