Skip to content

Commit 600355b

Browse files
0x0elliot0x0elliot
committed
Merge branch 'master' of github.com:ArgusOSS/urNode
2 parents 4219d43 + 498546a commit 600355b

1 file changed

Lines changed: 158 additions & 0 deletions

File tree

‎docs/schema.yml‎

Lines changed: 158 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,158 @@
1+
openapi: 3.0.2
2+
info:
3+
title: urNode
4+
version: ''
5+
description: Documentation
6+
paths:
7+
/authentication/me:
8+
get:
9+
operationId: listUsers
10+
description: ''
11+
parameters: []
12+
responses:
13+
'200':
14+
content:
15+
application/json:
16+
schema:
17+
type: array
18+
items:
19+
$ref: '#/components/schemas/User'
20+
description: ''
21+
tags:
22+
- authentication
23+
/authentication/login:
24+
post:
25+
operationId: createLogin
26+
description: ''
27+
parameters: []
28+
requestBody:
29+
content:
30+
application/json:
31+
schema:
32+
$ref: '#/components/schemas/Login'
33+
application/x-www-form-urlencoded:
34+
schema:
35+
$ref: '#/components/schemas/Login'
36+
multipart/form-data:
37+
schema:
38+
$ref: '#/components/schemas/Login'
39+
responses:
40+
'201':
41+
content:
42+
application/json:
43+
schema:
44+
$ref: '#/components/schemas/Login'
45+
description: ''
46+
tags:
47+
- authentication
48+
/authentication/logout:
49+
post:
50+
operationId: createLogout
51+
description: ''
52+
parameters: []
53+
requestBody:
54+
content:
55+
application/json:
56+
schema:
57+
$ref: '#/components/schemas/Logout'
58+
application/x-www-form-urlencoded:
59+
schema:
60+
$ref: '#/components/schemas/Logout'
61+
multipart/form-data:
62+
schema:
63+
$ref: '#/components/schemas/Logout'
64+
responses:
65+
'201':
66+
content:
67+
application/json:
68+
schema:
69+
$ref: '#/components/schemas/Logout'
70+
description: ''
71+
tags:
72+
- authentication
73+
/authentication/token/refresh:
74+
post:
75+
operationId: createTokenRefresh
76+
description: 'Takes a refresh type JSON web token and returns an access type
77+
JSON web
78+
79+
token if the refresh token is valid.'
80+
parameters: []
81+
requestBody:
82+
content:
83+
application/json:
84+
schema:
85+
$ref: '#/components/schemas/TokenRefresh'
86+
application/x-www-form-urlencoded:
87+
schema:
88+
$ref: '#/components/schemas/TokenRefresh'
89+
multipart/form-data:
90+
schema:
91+
$ref: '#/components/schemas/TokenRefresh'
92+
responses:
93+
'201':
94+
content:
95+
application/json:
96+
schema:
97+
$ref: '#/components/schemas/TokenRefresh'
98+
description: ''
99+
tags:
100+
- authentication
101+
components:
102+
schemas:
103+
User:
104+
type: object
105+
properties:
106+
id:
107+
type: integer
108+
readOnly: true
109+
email:
110+
type: string
111+
format: email
112+
maxLength: 255
113+
username:
114+
type: string
115+
maxLength: 255
116+
created_at:
117+
type: string
118+
format: date-time
119+
readOnly: true
120+
updated_at:
121+
type: string
122+
format: date-time
123+
readOnly: true
124+
required:
125+
- email
126+
- username
127+
Login:
128+
type: object
129+
properties:
130+
email:
131+
type: string
132+
format: email
133+
maxLength: 255
134+
minLength: 3
135+
password:
136+
type: string
137+
writeOnly: true
138+
maxLength: 68
139+
minLength: 6
140+
tokens:
141+
type: string
142+
readOnly: true
143+
required:
144+
- email
145+
- password
146+
Logout:
147+
type: object
148+
properties: {}
149+
TokenRefresh:
150+
type: object
151+
properties:
152+
refresh:
153+
type: string
154+
access:
155+
type: string
156+
readOnly: true
157+
required:
158+
- refresh

0 commit comments

Comments
 (0)