source: TFP-WebServer/WebServer/src/UrlHandlers/UserStatusHandler.openapi.yaml@ 498

Last change on this file since 498 was 463, checked in by alloc, 15 months ago

21.1.16.0 release
Completed OpenAPI specs
Add support to path handlers to register OpenAPI specs
Fixed ItemIconHandler throwing error when requested path contains no dot
File size: 2.1 KB
Line 
1openapi: 3.1.0
2info:
3 title: UserStatusHandler
4 version: '1'
5
6components:
7 schemas:
8 UserStatusElement:
9 type: object
10 properties:
11 loggedIn:
12 type: boolean
13 examples:
14 - true
15 username:
16 type: string
17 examples:
18 - TheFunPimp
19 permissionLevel:
20 type: integer
21 examples:
22 - 0
23 permissions:
24 type: array
25 items:
26 type: object
27 properties:
28 module:
29 type: string
30 examples:
31 - webapi.markers
32 allowed:
33 type: object
34 properties:
35 GET:
36 type: boolean
37 examples:
38 - true
39 POST:
40 type: boolean
41 examples:
42 - true
43 PUT:
44 type: boolean
45 examples:
46 - false
47 DELETE:
48 type: boolean
49 examples:
50 - false
51 required:
52 - GET
53 required:
54 - loggedIn
55 - username
56 - permissionLevel
57 - permissions
58
59
60paths:
61 /BASEPATH/:
62 get:
63 tags:
64 - Session
65 summary: User status info
66 description: Get information about the currently logged in user
67 operationId: UserStatusHandler.get
68 responses:
69 200:
70 description: User status
71 content:
72 application/json:
73 schema:
74 type: object
75 properties:
76 data:
77 $ref: '#/components/schemas/UserStatusElement'
78 meta:
79 $ref: './openapi.yaml#/components/schemas/ResultEnvelopeMeta'
80 required:
81 - data
82 - meta
83 security:
84 - {}
85 - apiTokenName: [ ]
86 apiTokenSecret: [ ]
87 - sessionCookie: [ ]
Note: See TracBrowser for help on using the repository browser.