Fix: Make swagger doc compliant to OpenAPI (#3394)
This fixes issues in the swagger.json file. The motivation to do so is to be able to generate API clients using https://openapi-generator.tech Doing so will require further changes to the api spec, but this seems like a good first step since it is now "valid" according to editor.swagger.io and openapi-generator validate. Fixes #2806
This commit is contained in:
@@ -11,15 +11,16 @@ parameters:
|
||||
required: true
|
||||
schema:
|
||||
type: object
|
||||
required:
|
||||
- user_id
|
||||
- role
|
||||
properties:
|
||||
user_id:
|
||||
type: integer
|
||||
description: The ID of the user
|
||||
required: true
|
||||
role:
|
||||
type: string
|
||||
description: whether user is an administrator or agent
|
||||
required: true
|
||||
|
||||
responses:
|
||||
200:
|
||||
|
||||
@@ -11,11 +11,12 @@ parameters:
|
||||
required: true
|
||||
schema:
|
||||
type: object
|
||||
required:
|
||||
- user_id
|
||||
properties:
|
||||
user_id:
|
||||
type: integer
|
||||
description: The ID of the user
|
||||
required: true
|
||||
|
||||
responses:
|
||||
200:
|
||||
|
||||
@@ -1,21 +1,20 @@
|
||||
get:
|
||||
tags:
|
||||
- Users
|
||||
operationId: get-sso-url-of-a-user
|
||||
summary: Get User SSO Link
|
||||
description: Get the sso link of a user
|
||||
security:
|
||||
- platformAppApiKey: []
|
||||
responses:
|
||||
200:
|
||||
description: Success
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
url:
|
||||
type: string
|
||||
description: SSO url to autenticate the user
|
||||
401:
|
||||
description: Unauthorized
|
||||
404:
|
||||
description: The given user does not exist
|
||||
tags:
|
||||
- Users
|
||||
operationId: get-sso-url-of-a-user
|
||||
summary: Get User SSO Link
|
||||
description: Get the sso link of a user
|
||||
security:
|
||||
- platformAppApiKey: []
|
||||
responses:
|
||||
200:
|
||||
description: Success
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
url:
|
||||
type: string
|
||||
description: SSO url to autenticate the user
|
||||
401:
|
||||
description: Unauthorized
|
||||
404:
|
||||
description: The given user does not exist
|
||||
|
||||
Reference in New Issue
Block a user