actual-budget-rest-api/src/docs/paths/admin.yml at v2.0.0 · ZoneMix/actual-budget-rest-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
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
adminOAuthClients:
  get:
    summary: List all OAuth clients
    description: |
      Returns a list of all OAuth clients (without secrets).
      Requires admin authentication via JWT.
    tags: [Admin]
    security:
      - bearerAuth: []
    responses:
      200:
        description: List of OAuth clients
        content:
          application/json:
            schema:
              type: object
              properties:
                clients:
                  type: array
                  items:
                    type: object
                    properties:
                      client_id:
                        type: string
                      allowed_scopes:
                        type: string
                      redirect_uris:
                        type: string
                      created_at:
                        type: string
                        format: date-time
      401:
        description: Unauthorized
        content:
          application/json:
            schema:
              $ref: '../components/schemas.yml#/Error'
      403:
        description: Forbidden (not admin)
        content:
          application/json:
            schema:
              $ref: '../components/schemas.yml#/Error'
  post:
    summary: Create a new OAuth client
    description: |
      Creates a new OAuth client. If client_secret is not provided, a secure secret will be auto-generated.
      The plain secret is only returned once on creation - save it immediately.
      Requires admin authentication via JWT.
    tags: [Admin]
    security:
      - bearerAuth: []
    requestBody:
      required: true
      content:
        application/json:
          schema:
            type: object
            required: [client_id]
            properties:
              client_id:
                type: string
                minLength: 1
                maxLength: 255
              client_secret:
                type: string
                minLength: 32
                description: Optional. If not provided, a secure secret will be auto-generated.
              allowed_scopes:
                type: string
                default: api
              redirect_uris:
                oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                      format: uri
                description: Comma-separated string or array of redirect URIs
    responses:
      201:
        description: OAuth client created
        content:
          application/json:
            schema:
              type: object
              properties:
                client:
                  type: object
                  properties:
                    client_id:
                      type: string
                    client_secret:
                      type: string
                      description: Only returned on creation - save this immediately!
                    allowed_scopes:
                      type: string
                    redirect_uris:
                      type: string
                    created_at:
                      type: string
                      format: date-time
                message:
                  type: string
      400:
        description: Bad request (e.g., client already exists)
        content:
          application/json:
            schema:
              $ref: '../components/schemas.yml#/Error'
      401:
        description: Unauthorized
        content:
          application/json:
            schema:
              $ref: '../components/schemas.yml#/Error'
      403:
        description: Forbidden (not admin)
        content:
          application/json:
            schema:
              $ref: '../components/schemas.yml#/Error'

adminOAuthClientById:
  get:
    summary: Get a specific OAuth client
    description: |
      Returns information about a specific OAuth client (without secret).
      Requires admin authentication via JWT.
    tags: [Admin]
    security:
      - bearerAuth: []
    parameters:
      - in: path
        name: clientId
        required: true
        schema:
          type: string
          minLength: 1
          maxLength: 255
    responses:
      200:
        description: OAuth client information
        content:
          application/json:
            schema:
              type: object
              properties:
                client:
                  type: object
                  properties:
                    client_id:
                      type: string
                    allowed_scopes:
                      type: string
                    redirect_uris:
                      type: string
                    created_at:
                      type: string
                      format: date-time
      404:
        description: Client not found
        content:
          application/json:
            schema:
              $ref: '../components/schemas.yml#/Error'
      401:
        description: Unauthorized
        content:
          application/json:
            schema:
              $ref: '../components/schemas.yml#/Error'
      403:
        description: Forbidden (not admin)
        content:
          application/json:
            schema:
              $ref: '../components/schemas.yml#/Error'
  put:
    summary: Update an OAuth client
    description: |
      Updates an existing OAuth client. If client_secret is provided, it will be hashed and stored.
      Requires admin authentication via JWT.
    tags: [Admin]
    security:
      - bearerAuth: []
    parameters:
      - in: path
        name: clientId
        required: true
        schema:
          type: string
          minLength: 1
          maxLength: 255
    requestBody:
      required: true
      content:
        application/json:
          schema:
            type: object
            properties:
              client_secret:
                type: string
                minLength: 32
                description: New client secret (will be hashed)
              allowed_scopes:
                type: string
              redirect_uris:
                oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
                      format: uri
            description: At least one field must be provided
    responses:
      200:
        description: OAuth client updated
        content:
          application/json:
            schema:
              type: object
              properties:
                client:
                  type: object
                  properties:
                    client_id:
                      type: string
                    allowed_scopes:
                      type: string
                    redirect_uris:
                      type: string
                    created_at:
                      type: string
                      format: date-time
                message:
                  type: string
      400:
        description: Bad request
        content:
          application/json:
            schema:
              $ref: '../components/schemas.yml#/Error'
      404:
        description: Client not found
        content:
          application/json:
            schema:
              $ref: '../components/schemas.yml#/Error'
      401:
        description: Unauthorized
        content:
          application/json:
            schema:
              $ref: '../components/schemas.yml#/Error'
      403:
        description: Forbidden (not admin)
        content:
          application/json:
            schema:
              $ref: '../components/schemas.yml#/Error'
  delete:
    summary: Delete an OAuth client
    description: |
      Deletes an OAuth client. This action cannot be undone.
      Requires admin authentication via JWT.
    tags: [Admin]
    security:
      - bearerAuth: []
    parameters:
      - in: path
        name: clientId
        required: true
        schema:
          type: string
          minLength: 1
          maxLength: 255
    responses:
      200:
        description: OAuth client deleted
        content:
          application/json:
            schema:
              type: object
              properties:
                message:
                  type: string
      404:
        description: Client not found
        content:
          application/json:
            schema:
              $ref: '../components/schemas.yml#/Error'
      401:
        description: Unauthorized
        content:
          application/json:
            schema:
              $ref: '../components/schemas.yml#/Error'
      403:
        description: Forbidden (not admin)
        content:
          application/json:
            schema:
              $ref: '../components/schemas.yml#/Error'

adminDashboard:
  get:
    summary: Display admin dashboard
    description: |
      Returns the admin dashboard HTML page for managing OAuth clients.
    tags: [Admin]
    responses:
      200:
        description: Admin dashboard HTML page
        content:
          text/html:
            schema:
              type: string