_Bastler/partey_workadventure
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Improving openapi doc

Browse Source
This commit is contained in:
David Négrier 2022-03-14 09:57:56 +01:00
parent 6540f15c5b
commit 6f4c3a89cd
1 changed files with 56 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

65
pusher/src/Controller/AuthenticateController.ts
View File

@ -84,30 +84,75 @@ export class AuthenticateController extends BaseHttpController {
* get: * get:
* description: TODO * description: TODO
* parameters: * parameters:
* - name: "code"
* in: "query"
* description: "todo"
* required: false
* type: "string"
* - name: "nonce" * - name: "nonce"
* in: "query" * in: "query"
* description: "todo" * description: "todo"
* required: true * required: false
* type: "string" * type: "string"
* - name: "state" * - name: "token"
* in: "query" * in: "query"
* description: "todo" * description: "todo"
* required: true * required: false
* type: "string" * type: "string"
* - name: "playUri" * - name: "playUri"
* in: "query" * in: "query"
* description: "todo" * description: "todo"
* required: false * required: true
* type: "string"
* - name: "redirect"
* in: "query"
* description: "todo"
* required: false
* type: "string" * type: "string"
* responses: * responses:
* 200: * 200:
* description: NOTE - THERE ARE ADDITIONAL PROPERTIES NOT DISPLAYED HERE. THEY COME FROM THE CALL TO openIDClient.checkTokenAuth
* content:
* application/json:
* schema:
* type: object
* properties:
* authToken:
* type: string
* description: A new JWT token (if no token was passed in parameter), or returns the token that was passed in parameter if one was supplied
* username:
* type: string|undefined
* description: Contains the username stored in the JWT token passed in parameter. If no token was passed, contains the data from OpenID.
* example: John Doe
* locale:
* type: string|undefined
* description: Contains the locale stored in the JWT token passed in parameter. If no token was passed, contains the data from OpenID.
* example: fr_FR
* email:
* type: string
* description: TODO * description: TODO
* * example: TODO
* userUuid:
* type: string
* description: TODO
* example: TODO
* visitCardUrl:
* type: string|null
* description: TODO
* example: TODO
* tags:
* type: array
* description: The list of tags of the user
* items:
* type: string
* example: speaker
* textures:
* type: array
* description: The list of textures of the user
* items:
* type: TODO
* example: TODO
* messages:
* type: array
* description: The list of messages to be displayed to the user
* items:
* type: TODO
* example: TODO
*/ */
//eslint-disable-next-line @typescript-eslint/no-misused-promises //eslint-disable-next-line @typescript-eslint/no-misused-promises
this.app.get("/login-callback", async (req, res) => { this.app.get("/login-callback", async (req, res) => {