ami/tl-vikunja
1
0
Fork 0
Code Activity

Fixed swaggerdocs of description fields

Browse Source
This commit is contained in:
kolaente
2019-07-21 23:57:19 +02:00
parent 8d76280811
commit 208eb4e68c
8 changed files with 61 additions and 92 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
pkg/swagger/swagger.yaml
View File

@ -46,7 +46,6 @@ definitions:
type: object
description:
description: The task description.
maxLength: 250
type: string
done:
description: Whether a task is done or not.
@ -134,7 +133,6 @@ definitions:
type: object
description:
description: The label description.
maxLength: 250
type: string
hex_color:
description: The color this label has
@ -180,7 +178,6 @@ definitions:
type: integer
description:
description: The description of the list.
maxLength: 1000
type: string
id:
description: The unique, numeric id of this list.
@ -221,7 +218,6 @@ definitions:
type: object
description:
description: The task description.
maxLength: 250
type: string
done:
description: Whether a task is done or not.
@ -330,7 +326,6 @@ definitions:
type: integer
description:
description: The description of the namespace
maxLength: 250
type: string
id:
description: The unique, numeric id of this namespace.
@ -380,7 +375,6 @@ definitions:
type: integer
description:
description: The description of the namespace
maxLength: 250
type: string
id:
description: The unique, numeric id of this namespace.
@ -430,8 +424,6 @@ definitions:
type: object
description:
description: The team's description.
maxLength: 250
minLength: 0
type: string
id:
description: The unique, numeric id of this team.
@ -558,8 +550,6 @@ definitions:
type: object
description:
description: The team's description.
maxLength: 250
minLength: 0
type: string
id:
description: The unique, numeric id of this team.
@ -704,15 +694,14 @@ paths:
get:
consumes:
- application/json
description: Returns all labels which are either created by the user or associated
with a task the user has at least read-access to.
description: Returns an array with all assignees for this task.
parameters:
- description: The page number. Used for pagination. If not provided, the first
page of results is returned.
in: query
name: p
type: integer
- description: Search labels by label text.
- description: Search assignees by their username.
in: query
name: s
type: string
@ -720,10 +709,10 @@ paths:
- application/json
responses:
"200":
description: The labels
description: The assignees
schema:
items:
$ref: '#/definitions/models.Label'
$ref: '#/definitions/models.User'
type: array
"500":
description: Internal error
@ -732,9 +721,9 @@ paths:
type: object
security:
- JWTKeyAuth: []
summary: Get all labels a user has access to
summary: Get all assignees for a task
tags:
- labels
- assignees
put:
consumes:
- application/json
@ -978,9 +967,9 @@ paths:
get:
consumes:
- application/json
description: Returns a team by its ID.
description: Returns a list by its ID.
parameters:
- description: Team ID
- description: List ID
in: path
name: id
required: true
@ -989,12 +978,12 @@ paths:
- application/json
responses:
"200":
description: The team
description: The list
schema:
$ref: '#/definitions/models.Team'
$ref: '#/definitions/models.List'
type: object
"403":
description: The user does not have access to the team
description: The user does not have access to the list
schema:
$ref: '#/definitions/code.vikunja.io/web.HTTPError'
type: object
@ -1005,9 +994,9 @@ paths:
type: object
security:
- JWTKeyAuth: []
summary: Gets one team
summary: Gets one list
tags:
- team
- list
post:
consumes:
- application/json