Generic-API/openAPI.yml at main · david-benistant/Generic-API · 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
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
openapi: 3.0.0
info:
  title: generic-api
  version: 1.0.0
servers:
  - url: http://{{api_url}}
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
tags:
  - name: Auth
  - name: Generic
  - name: Files
paths:
  /auth/login:
    post:
      tags:
        - Auth
      summary: Login
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                email: test@email.com
                password: password
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /auth/register:
    post:
      tags:
        - Auth
      summary: Register
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                email: test2@email.com
                password: password
                adminToken: OAyqXOlc7x8jT9P5sOKw3yLE#Ftt#ZKe7Q2dFAOJAN71O!ZlRxBE%oFht%8ocD
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /generic:
    post:
      tags:
        - Generic
      summary: Create generic
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                title: test
                metadata:
                  test: oui
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    get:
      tags:
        - Generic
      summary: List generic
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /generic/search:
    get:
      tags:
        - Generic
      summary: Search generic
      parameters:
        - name: search
          in: query
          schema:
            type: string
          example: o
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /generic/{id}:
    get:
      tags:
        - Generic
      summary: Get generic
      parameters:
        - name: id
          in: path
          schema:
            type: string
          required: true
          example: e245df1c-0ddd-442a-9a22-9ce8558b0fa7
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    patch:
      tags:
        - Generic
      summary: Update generic
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                title: updated
                metadata:
                  test: oui
      parameters:
        - name: id
          in: path
          schema:
            type: string
          required: true
          example: 6ee7f74a-17ed-4044-a62a-847e5ae46193
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    delete:
      tags:
        - Generic
      summary: Delete generic
      parameters:
        - name: id
          in: path
          schema:
            type: string
          required: true
          example: 7b9dcba3-4d70-4d84-a7fa-93cbf1ecdfdb
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /file:
    post:
      tags:
        - Files
      summary: Put file
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                fileName: test.txt
      security:
        - bearerAuth: []
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /file/{fileKey}:
    get:
      tags:
        - Files
      summary: Get file
      parameters:
        - name: fileKey
          in: path
          schema:
            type: string
          required: true
          example: MjhkNWUxMWYtMzcwZi00MTJkLTgwMjItNWNhNDJkZjkzYjNiL3Rlc3QudHh0
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    delete:
      tags:
        - Files
      summary: Delete file
      parameters:
        - name: fileKey
          in: path
          schema:
            type: string
          required: true
          example: MjhkNWUxMWYtMzcwZi00MTJkLTgwMjItNWNhNDJkZjkzYjNiL3Rlc3QudHh0
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /file/{fileKey}/download:
    get:
      tags:
        - Files
      summary: Download file
      parameters:
        - name: fileKey
          in: path
          schema:
            type: string
          required: true
          example: MjhkNWUxMWYtMzcwZi00MTJkLTgwMjItNWNhNDJkZjkzYjNiL3Rlc3QudHh0
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}