Skip to content
This repository was archived by the owner on Apr 2, 2026. It is now read-only.

Commit 43b5e1c

Browse files
committed
docs: auto-update swagger documentation
1 parent 98ed949 commit 43b5e1c

2 files changed

Lines changed: 20 additions & 300 deletions

File tree

README.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -18,28 +18,28 @@ ortelius-ms-validate-user
1818

1919
## Path Table
2020

21-
| Method | Path | Description |
22-
|--------|----------------------------------------------|-------------------------|
23-
| GET | [/health](#gethealth) | Health |
24-
| GET | [/msapi/validateuser](#getmsapivalidateuser) | Validateuser |
25-
| GET | [/loginhelp](#getloginhelp) | Get Login Help Page |
26-
| POST | [/forgot-username](#postforgot-username) | Forgot Username |
27-
| POST | [/forgot-password](#postforgot-password) | Forgot Password |
28-
| GET | [/reset-password](#getreset-password) | Get Reset Password Page |
29-
| POST | [/reset-password](#postreset-password) | Reset Password |
21+
| Method | Path | Description |
22+
| --- | --- | --- |
23+
| GET | [/health](#gethealth) | Health |
24+
| GET | [/msapi/validateuser](#getmsapivalidateuser) | Validateuser |
25+
| GET | [/loginhelp](#getloginhelp) | Get Login Help Page |
26+
| POST | [/forgot-username](#postforgot-username) | Forgot Username |
27+
| POST | [/forgot-password](#postforgot-password) | Forgot Password |
28+
| GET | [/reset-password](#getreset-password) | Get Reset Password Page |
29+
| POST | [/reset-password](#postreset-password) | Reset Password |
3030

3131
## Reference Table
3232

33-
| Name | Path | Description |
34-
|-----------------------|---------------------------------------------------------------------------------------|-------------|
35-
| DomainList | [#/components/schemas/DomainList](#componentsschemasdomainlist) | |
36-
| ForgotPasswordPayload | [#/components/schemas/ForgotPasswordPayload](#componentsschemasforgotpasswordpayload) | |
37-
| ForgotUsernamePayload | [#/components/schemas/ForgotUsernamePayload](#componentsschemasforgotusernamepayload) | |
38-
| HTTPValidationError | [#/components/schemas/HTTPValidationError](#componentsschemashttpvalidationerror) | |
39-
| Message | [#/components/schemas/Message](#componentsschemasmessage) | |
40-
| ResetPasswordPayload | [#/components/schemas/ResetPasswordPayload](#componentsschemasresetpasswordpayload) | |
41-
| StatusMsg | [#/components/schemas/StatusMsg](#componentsschemasstatusmsg) | |
42-
| ValidationError | [#/components/schemas/ValidationError](#componentsschemasvalidationerror) | |
33+
| Name | Path | Description |
34+
| --- | --- | --- |
35+
| DomainList | [#/components/schemas/DomainList](#componentsschemasdomainlist) | |
36+
| ForgotPasswordPayload | [#/components/schemas/ForgotPasswordPayload](#componentsschemasforgotpasswordpayload) | |
37+
| ForgotUsernamePayload | [#/components/schemas/ForgotUsernamePayload](#componentsschemasforgotusernamepayload) | |
38+
| HTTPValidationError | [#/components/schemas/HTTPValidationError](#componentsschemashttpvalidationerror) | |
39+
| Message | [#/components/schemas/Message](#componentsschemasmessage) | |
40+
| ResetPasswordPayload | [#/components/schemas/ResetPasswordPayload](#componentsschemasresetpasswordpayload) | |
41+
| StatusMsg | [#/components/schemas/StatusMsg](#componentsschemasstatusmsg) | |
42+
| ValidationError | [#/components/schemas/ValidationError](#componentsschemasvalidationerror) | |
4343

4444
## Path Details
4545

openapi.json

Lines changed: 1 addition & 281 deletions
Original file line numberDiff line numberDiff line change
@@ -1,281 +1 @@
1-
{
2-
"openapi": "3.1.0",
3-
"info": {
4-
"title": "ortelius-ms-validate-user",
5-
"description": "ortelius-ms-validate-user",
6-
"version": "0.1.0"
7-
},
8-
"paths": {
9-
"/health": {
10-
"get": {
11-
"summary": "Health",
12-
"operationId": "health_health_get",
13-
"responses": {
14-
"200": {
15-
"description": "Successful Response",
16-
"content": {
17-
"application/json": {
18-
"schema": { "$ref": "#/components/schemas/StatusMsg" }
19-
}
20-
}
21-
}
22-
}
23-
}
24-
},
25-
"/msapi/validateuser": {
26-
"get": {
27-
"summary": "Validateuser",
28-
"operationId": "validateuser_msapi_validateuser_get",
29-
"parameters": [
30-
{
31-
"name": "domains",
32-
"in": "query",
33-
"required": false,
34-
"schema": {
35-
"anyOf": [
36-
{ "type": "string", "pattern": "^[y|Y|n|N]$" },
37-
{ "type": "null" }
38-
],
39-
"title": "Domains"
40-
}
41-
}
42-
],
43-
"responses": {
44-
"200": {
45-
"description": "Successful Response",
46-
"content": {
47-
"application/json": {
48-
"schema": { "$ref": "#/components/schemas/DomainList" }
49-
}
50-
}
51-
},
52-
"422": {
53-
"description": "Validation Error",
54-
"content": {
55-
"application/json": {
56-
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
57-
}
58-
}
59-
}
60-
}
61-
}
62-
},
63-
"/loginhelp": {
64-
"get": {
65-
"summary": "Get Login Help Page",
66-
"operationId": "get_login_help_page_loginhelp_get",
67-
"responses": {
68-
"200": {
69-
"description": "Successful Response",
70-
"content": { "text/html": { "schema": { "type": "string" } } }
71-
}
72-
}
73-
}
74-
},
75-
"/forgot-username": {
76-
"post": {
77-
"summary": "Forgot Username",
78-
"operationId": "forgot_username_forgot_username_post",
79-
"requestBody": {
80-
"content": {
81-
"application/json": {
82-
"schema": { "$ref": "#/components/schemas/ForgotUsernamePayload" }
83-
}
84-
},
85-
"required": true
86-
},
87-
"responses": {
88-
"200": {
89-
"description": "Successful Response",
90-
"content": {
91-
"application/json": {
92-
"schema": { "$ref": "#/components/schemas/Message" }
93-
}
94-
}
95-
},
96-
"422": {
97-
"description": "Validation Error",
98-
"content": {
99-
"application/json": {
100-
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
101-
}
102-
}
103-
}
104-
}
105-
}
106-
},
107-
"/forgot-password": {
108-
"post": {
109-
"summary": "Forgot Password",
110-
"operationId": "forgot_password_forgot_password_post",
111-
"requestBody": {
112-
"content": {
113-
"application/json": {
114-
"schema": { "$ref": "#/components/schemas/ForgotPasswordPayload" }
115-
}
116-
},
117-
"required": true
118-
},
119-
"responses": {
120-
"200": {
121-
"description": "Successful Response",
122-
"content": {
123-
"application/json": {
124-
"schema": { "$ref": "#/components/schemas/Message" }
125-
}
126-
}
127-
},
128-
"422": {
129-
"description": "Validation Error",
130-
"content": {
131-
"application/json": {
132-
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
133-
}
134-
}
135-
}
136-
}
137-
}
138-
},
139-
"/reset-password": {
140-
"get": {
141-
"summary": "Get Reset Password Page",
142-
"operationId": "get_reset_password_page_reset_password_get",
143-
"parameters": [
144-
{
145-
"name": "token",
146-
"in": "query",
147-
"required": true,
148-
"schema": { "type": "string", "title": "Token" }
149-
}
150-
],
151-
"responses": {
152-
"200": {
153-
"description": "Successful Response",
154-
"content": { "text/html": { "schema": { "type": "string" } } }
155-
},
156-
"422": {
157-
"description": "Validation Error",
158-
"content": {
159-
"application/json": {
160-
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
161-
}
162-
}
163-
}
164-
}
165-
},
166-
"post": {
167-
"summary": "Reset Password",
168-
"operationId": "reset_password_reset_password_post",
169-
"requestBody": {
170-
"required": true,
171-
"content": {
172-
"application/json": {
173-
"schema": { "$ref": "#/components/schemas/ResetPasswordPayload" }
174-
}
175-
}
176-
},
177-
"responses": {
178-
"200": {
179-
"description": "Successful Response",
180-
"content": {
181-
"application/json": {
182-
"schema": { "$ref": "#/components/schemas/Message" }
183-
}
184-
}
185-
},
186-
"422": {
187-
"description": "Validation Error",
188-
"content": {
189-
"application/json": {
190-
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
191-
}
192-
}
193-
}
194-
}
195-
}
196-
}
197-
},
198-
"components": {
199-
"schemas": {
200-
"DomainList": {
201-
"properties": {
202-
"domains": {
203-
"items": { "type": "integer" },
204-
"type": "array",
205-
"title": "Domains",
206-
"default": []
207-
}
208-
},
209-
"type": "object",
210-
"title": "DomainList"
211-
},
212-
"ForgotPasswordPayload": {
213-
"properties": { "username": { "type": "string", "title": "Username" } },
214-
"type": "object",
215-
"required": ["username"],
216-
"title": "ForgotPasswordPayload"
217-
},
218-
"ForgotUsernamePayload": {
219-
"properties": {
220-
"email": { "type": "string", "format": "email", "title": "Email" }
221-
},
222-
"type": "object",
223-
"required": ["email"],
224-
"title": "ForgotUsernamePayload"
225-
},
226-
"HTTPValidationError": {
227-
"properties": {
228-
"detail": {
229-
"items": { "$ref": "#/components/schemas/ValidationError" },
230-
"type": "array",
231-
"title": "Detail"
232-
}
233-
},
234-
"type": "object",
235-
"title": "HTTPValidationError"
236-
},
237-
"Message": {
238-
"properties": {
239-
"detail": { "type": "string", "title": "Detail", "default": "" }
240-
},
241-
"type": "object",
242-
"title": "Message"
243-
},
244-
"ResetPasswordPayload": {
245-
"properties": {
246-
"token": { "type": "string", "title": "Token" },
247-
"new_password": { "type": "string", "title": "New Password" }
248-
},
249-
"type": "object",
250-
"required": ["token", "new_password"],
251-
"title": "ResetPasswordPayload"
252-
},
253-
"StatusMsg": {
254-
"properties": {
255-
"status": { "type": "string", "title": "Status", "default": "" },
256-
"service_name": {
257-
"type": "string",
258-
"title": "Service Name",
259-
"default": ""
260-
}
261-
},
262-
"type": "object",
263-
"title": "StatusMsg"
264-
},
265-
"ValidationError": {
266-
"properties": {
267-
"loc": {
268-
"items": { "anyOf": [{ "type": "string" }, { "type": "integer" }] },
269-
"type": "array",
270-
"title": "Location"
271-
},
272-
"msg": { "type": "string", "title": "Message" },
273-
"type": { "type": "string", "title": "Error Type" }
274-
},
275-
"type": "object",
276-
"required": ["loc", "msg", "type"],
277-
"title": "ValidationError"
278-
}
279-
}
280-
}
281-
}
1+
{"openapi":"3.1.0","info":{"title":"ortelius-ms-validate-user","description":"ortelius-ms-validate-user","version":"0.1.0"},"paths":{"/health":{"get":{"summary":"Health","operationId":"health_health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusMsg"}}}}}}},"/msapi/validateuser":{"get":{"summary":"Validateuser","operationId":"validateuser_msapi_validateuser_get","parameters":[{"name":"domains","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^[y|Y|n|N]$"},{"type":"null"}],"title":"Domains"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainList"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/loginhelp":{"get":{"summary":"Get Login Help Page","operationId":"get_login_help_page_loginhelp_get","responses":{"200":{"description":"Successful Response","content":{"text/html":{"schema":{"type":"string"}}}}}}},"/forgot-username":{"post":{"summary":"Forgot Username","operationId":"forgot_username_forgot_username_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForgotUsernamePayload"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Message"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/forgot-password":{"post":{"summary":"Forgot Password","operationId":"forgot_password_forgot_password_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForgotPasswordPayload"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Message"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/reset-password":{"get":{"summary":"Get Reset Password Page","operationId":"get_reset_password_page_reset_password_get","parameters":[{"name":"token","in":"query","required":true,"schema":{"type":"string","title":"Token"}}],"responses":{"200":{"description":"Successful Response","content":{"text/html":{"schema":{"type":"string"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"summary":"Reset Password","operationId":"reset_password_reset_password_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResetPasswordPayload"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Message"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"DomainList":{"properties":{"domains":{"items":{"type":"integer"},"type":"array","title":"Domains","default":[]}},"type":"object","title":"DomainList"},"ForgotPasswordPayload":{"properties":{"username":{"type":"string","title":"Username"}},"type":"object","required":["username"],"title":"ForgotPasswordPayload"},"ForgotUsernamePayload":{"properties":{"email":{"type":"string","format":"email","title":"Email"}},"type":"object","required":["email"],"title":"ForgotUsernamePayload"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"Message":{"properties":{"detail":{"type":"string","title":"Detail","default":""}},"type":"object","title":"Message"},"ResetPasswordPayload":{"properties":{"token":{"type":"string","title":"Token"},"new_password":{"type":"string","title":"New Password"}},"type":"object","required":["token","new_password"],"title":"ResetPasswordPayload"},"StatusMsg":{"properties":{"status":{"type":"string","title":"Status","default":""},"service_name":{"type":"string","title":"Service Name","default":""}},"type":"object","title":"StatusMsg"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}

0 commit comments

Comments
 (0)