local-it/vikunja-api
0
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Fix swagger docs for create requests

Browse source
This commit is contained in:
kolaente 2021-05-26 21:56:31 +02:00
parent 8e65ffb99b
commit e23014dbe4
No known key found for this signature in database
GPG key ID: F40E70337AB24C9B
21 changed files with 80 additions and 80 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
pkg/models/label.go
View file

@ -61,7 +61,7 @@ func (Label) TableName() string {
// @Produce json
// @Security JWTKeyAuth
// @Param label body models.Label true "The label object"
// @Success 200 {object} models.Label "The created label object."
// @Success 201 {object} models.Label "The created label object."
// @Failure 400 {object} web.HTTPError "Invalid label object provided."
// @Failure 500 {object} models.Message "Internal error"
// @Router /labels [put]

4
pkg/models/label_task.go
View file

@ -75,7 +75,7 @@ func (lt *LabelTask) Delete(s *xorm.Session, a web.Auth) (err error) {
// @Security JWTKeyAuth
// @Param task path int true "Task ID"
// @Param label body models.LabelTask true "The label object"
// @Success 200 {object} models.LabelTask "The created label relation object."
// @Success 201 {object} models.LabelTask "The created label relation object."
// @Failure 400 {object} web.HTTPError "Invalid label object provided."
// @Failure 403 {object} web.HTTPError "Not allowed to add the label."
// @Failure 404 {object} web.HTTPError "The label does not exist."
@ -369,7 +369,7 @@ type LabelTaskBulk struct {
// @Security JWTKeyAuth
// @Param label body models.LabelTaskBulk true "The array of labels"
// @Param taskID path int true "Task ID"
// @Success 200 {object} models.LabelTaskBulk "The updated labels object."
// @Success 201 {object} models.LabelTaskBulk "The updated labels object."
// @Failure 400 {object} web.HTTPError "Invalid label object provided."
// @Failure 500 {object} models.Message "Internal error"
// @Router /tasks/{taskID}/labels/bulk [post]

2
pkg/models/link_sharing.go
View file

@ -120,7 +120,7 @@ func (share *LinkSharing) toUser() *user.User {
// @Security JWTKeyAuth
// @Param list path int true "List ID"
// @Param label body models.LinkSharing true "The new link share object"
// @Success 200 {object} models.LinkSharing "The created link share object."
// @Success 201 {object} models.LinkSharing "The created link share object."
// @Failure 400 {object} web.HTTPError "Invalid link share object provided."
// @Failure 403 {object} web.HTTPError "Not allowed to add the list share."
// @Failure 404 {object} web.HTTPError "The list does not exist."

2
pkg/models/list.go
View file

@ -640,7 +640,7 @@ func updateListByTaskID(s *xorm.Session, taskID int64) (err error) {
// @Security JWTKeyAuth
// @Param namespaceID path int true "Namespace ID"
// @Param list body models.List true "The list you want to create."
// @Success 200 {object} models.List "The created list."
// @Success 201 {object} models.List "The created list."
// @Failure 400 {object} web.HTTPError "Invalid list object provided."
// @Failure 403 {object} web.HTTPError "The user does not have access to the list"
// @Failure 500 {object} models.Message "Internal error"

2
pkg/models/list_duplicate.go
View file

@ -61,7 +61,7 @@ func (ld *ListDuplicate) CanCreate(s *xorm.Session, a web.Auth) (canCreate bool,
// @Security JWTKeyAuth
// @Param listID path int true "The list ID to duplicate"
// @Param list body models.ListDuplicate true "The target namespace which should hold the copied list."
// @Success 200 {object} models.ListDuplicate "The created list."
// @Success 201 {object} models.ListDuplicate "The created list."
// @Failure 400 {object} web.HTTPError "Invalid list duplicate object provided."
// @Failure 403 {object} web.HTTPError "The user does not have access to the list or namespace"
// @Failure 500 {object} models.Message "Internal error"

2
pkg/models/list_team.go
View file

@ -65,7 +65,7 @@ type TeamWithRight struct {
// @Security JWTKeyAuth
// @Param id path int true "List ID"
// @Param list body models.TeamList true "The team you want to add to the list."
// @Success 200 {object} models.TeamList "The created team<->list relation."
// @Success 201 {object} models.TeamList "The created team<->list relation."
// @Failure 400 {object} web.HTTPError "Invalid team list object provided."
// @Failure 404 {object} web.HTTPError "The team does not exist."
// @Failure 403 {object} web.HTTPError "The user does not have access to the list"

2
pkg/models/list_users.go
View file

@ -68,7 +68,7 @@ type UserWithRight struct {
// @Security JWTKeyAuth
// @Param id path int true "List ID"
// @Param list body models.ListUser true "The user you want to add to the list."
// @Success 200 {object} models.ListUser "The created user<->list relation."
// @Success 201 {object} models.ListUser "The created user<->list relation."
// @Failure 400 {object} web.HTTPError "Invalid user list object provided."
// @Failure 404 {object} web.HTTPError "The user does not exist."
// @Failure 403 {object} web.HTTPError "The user does not have access to the list"

2
pkg/models/namespace.go
View file

@ -578,7 +578,7 @@ func (n *Namespace) ReadAll(s *xorm.Session, a web.Auth, search string, page int
// @Produce json
// @Security JWTKeyAuth
// @Param namespace body models.Namespace true "The namespace you want to create."
// @Success 200 {object} models.Namespace "The created namespace."
// @Success 201 {object} models.Namespace "The created namespace."
// @Failure 400 {object} web.HTTPError "Invalid namespace object provided."
// @Failure 403 {object} web.HTTPError "The user does not have access to the namespace"
// @Failure 500 {object} models.Message "Internal error"

2
pkg/models/namespace_team.go
View file

@ -59,7 +59,7 @@ func (TeamNamespace) TableName() string {
// @Security JWTKeyAuth
// @Param id path int true "Namespace ID"
// @Param namespace body models.TeamNamespace true "The team you want to add to the namespace."
// @Success 200 {object} models.TeamNamespace "The created team<->namespace relation."
// @Success 201 {object} models.TeamNamespace "The created team<->namespace relation."
// @Failure 400 {object} web.HTTPError "Invalid team namespace object provided."
// @Failure 404 {object} web.HTTPError "The team does not exist."
// @Failure 403 {object} web.HTTPError "The team does not have access to the namespace"

2
pkg/models/namespace_users.go
View file

@ -61,7 +61,7 @@ func (NamespaceUser) TableName() string {
// @Security JWTKeyAuth
// @Param id path int true "Namespace ID"
// @Param namespace body models.NamespaceUser true "The user you want to add to the namespace."
// @Success 200 {object} models.NamespaceUser "The created user<->namespace relation."
// @Success 201 {object} models.NamespaceUser "The created user<->namespace relation."
// @Failure 400 {object} web.HTTPError "Invalid user namespace object provided."
// @Failure 404 {object} web.HTTPError "The user does not exist."
// @Failure 403 {object} web.HTTPError "The user does not have access to the namespace"

2
pkg/models/saved_filters.go
View file

@ -112,7 +112,7 @@ func (sf *SavedFilter) toList() *List {
// @Accept json
// @Produce json
// @Security JWTKeyAuth
// @Success 200 {object} models.SavedFilter "The Saved Filter"
// @Success 201 {object} models.SavedFilter "The Saved Filter"
// @Failure 403 {object} web.HTTPError "The user does not have access to that saved filter."
// @Failure 500 {object} models.Message "Internal error"
// @Router /filters [put]

2
pkg/models/subscription.go
View file

@ -114,7 +114,7 @@ func (et SubscriptionEntityType) validate() error {
// @Security JWTKeyAuth
// @Param entity path string true "The entity the user subscribes to. Can be either `namespace`, `list` or `task`."
// @Param entityID path string true "The numeric id of the entity to subscribe to."
// @Success 200 {object} models.Subscription "The subscription"
// @Success 201 {object} models.Subscription "The subscription"
// @Failure 403 {object} web.HTTPError "The user does not have access to subscribe to this entity."
// @Failure 412 {object} web.HTTPError "The subscription already exists."
// @Failure 412 {object} web.HTTPError "The subscription entity is invalid."

4
pkg/models/task_assignees.go
View file

@ -187,7 +187,7 @@ func (la *TaskAssginee) Delete(s *xorm.Session, a web.Auth) (err error) {
// @Security JWTKeyAuth
// @Param assignee body models.TaskAssginee true "The assingee object"
// @Param taskID path int true "Task ID"
// @Success 200 {object} models.TaskAssginee "The created assingee object."
// @Success 201 {object} models.TaskAssginee "The created assingee object."
// @Failure 400 {object} web.HTTPError "Invalid assignee object provided."
// @Failure 500 {object} models.Message "Internal error"
// @Router /tasks/{taskID}/assignees [put]
@ -308,7 +308,7 @@ type BulkAssignees struct {
// @Security JWTKeyAuth
// @Param assignee body models.BulkAssignees true "The array of assignees"
// @Param taskID path int true "Task ID"
// @Success 200 {object} models.TaskAssginee "The created assingees object."
// @Success 201 {object} models.TaskAssginee "The created assingees object."
// @Failure 400 {object} web.HTTPError "Invalid assignee object provided."
// @Failure 500 {object} models.Message "Internal error"
// @Router /tasks/{taskID}/assignees/bulk [post]

2
pkg/models/task_comments.go
View file

@ -56,7 +56,7 @@ func (tc *TaskComment) TableName() string {
// @Security JWTKeyAuth
// @Param relation body models.TaskComment true "The task comment object"
// @Param taskID path int true "Task ID"
// @Success 200 {object} models.TaskComment "The created task comment object."
// @Success 201 {object} models.TaskComment "The created task comment object."
// @Failure 400 {object} web.HTTPError "Invalid task comment object provided."
// @Failure 500 {object} models.Message "Internal error"
// @Router /tasks/{taskID}/comments [put]

2
pkg/models/task_relation.go
View file

@ -114,7 +114,7 @@ type RelatedTaskMap map[RelationKind][]*Task
// @Security JWTKeyAuth
// @Param relation body models.TaskRelation true "The relation object"
// @Param taskID path int true "Task ID"
// @Success 200 {object} models.TaskRelation "The created task relation object."
// @Success 201 {object} models.TaskRelation "The created task relation object."
// @Failure 400 {object} web.HTTPError "Invalid task relation object provided."
// @Failure 500 {object} models.Message "Internal error"
// @Router /tasks/{taskID}/relations [put]

2
pkg/models/tasks.go
View file

@ -801,7 +801,7 @@ func setTaskBucket(s *xorm.Session, task *Task, originalTask *Task, doCheckBucke
// @Security JWTKeyAuth
// @Param id path int true "List ID"
// @Param task body models.Task true "The task object"
// @Success 200 {object} models.Task "The created task object."
// @Success 201 {object} models.Task "The created task object."
// @Failure 400 {object} web.HTTPError "Invalid task object provided."
// @Failure 403 {object} web.HTTPError "The user does not have access to the list"
// @Failure 500 {object} models.Message "Internal error"

2
pkg/models/team_members.go
View file

@ -32,7 +32,7 @@ import (
// @Security JWTKeyAuth
// @Param id path int true "Team ID"
// @Param team body models.TeamMember true "The user to be added to a team."
// @Success 200 {object} models.TeamMember "The newly created member object"
// @Success 201 {object} models.TeamMember "The newly created member object"
// @Failure 400 {object} web.HTTPError "Invalid member object provided."
// @Failure 403 {object} web.HTTPError "The user does not have access to the team"
// @Failure 500 {object} models.Message "Internal error"

2
pkg/models/teams.go
View file

@ -247,7 +247,7 @@ func (t *Team) ReadAll(s *xorm.Session, a web.Auth, search string, page int, per
// @Produce json
// @Security JWTKeyAuth
// @Param team body models.Team true "The team you want to create."
// @Success 200 {object} models.Team "The created team."
// @Success 201 {object} models.Team "The created team."
// @Failure 400 {object} web.HTTPError "Invalid team object provided."
// @Failure 500 {object} models.Message "Internal error"
// @Router /teams [put]

40
pkg/swagger/docs.go
View file

@ -243,7 +243,7 @@ var doc = `{
],
"summary": "Creates a new saved filter",
"responses": {
"200": {
"201": {
"description": "The Saved Filter",
"schema": {
"$ref": "#/definitions/models.SavedFilter"
@ -524,7 +524,7 @@ var doc = `{
}
],
"responses": {
"200": {
"201": {
"description": "The created label object.",
"schema": {
"$ref": "#/definitions/models.Label"
@ -874,7 +874,7 @@ var doc = `{
}
],
"responses": {
"200": {
"201": {
"description": "The created task object.",
"schema": {
"$ref": "#/definitions/models.Task"
@ -1572,7 +1572,7 @@ var doc = `{
}
],
"responses": {
"200": {
"201": {
"description": "The created team\u003c-\u003elist relation.",
"schema": {
"$ref": "#/definitions/models.TeamList"
@ -1710,7 +1710,7 @@ var doc = `{
}
],
"responses": {
"200": {
"201": {
"description": "The created user\u003c-\u003elist relation.",
"schema": {
"$ref": "#/definitions/models.ListUser"
@ -1905,7 +1905,7 @@ var doc = `{
}
],
"responses": {
"200": {
"201": {
"description": "The created list.",
"schema": {
"$ref": "#/definitions/models.ListDuplicate"
@ -2393,7 +2393,7 @@ var doc = `{
}
],
"responses": {
"200": {
"201": {
"description": "The created link share object.",
"schema": {
"$ref": "#/definitions/models.LinkSharing"
@ -3189,7 +3189,7 @@ var doc = `{
}
],
"responses": {
"200": {
"201": {
"description": "The created namespace.",
"schema": {
"$ref": "#/definitions/models.Namespace"
@ -3478,7 +3478,7 @@ var doc = `{
}
],
"responses": {
"200": {
"201": {
"description": "The created team\u003c-\u003enamespace relation.",
"schema": {
"$ref": "#/definitions/models.TeamNamespace"
@ -3616,7 +3616,7 @@ var doc = `{
}
],
"responses": {
"200": {
"201": {
"description": "The created user\u003c-\u003enamespace relation.",
"schema": {
"$ref": "#/definitions/models.NamespaceUser"
@ -3686,7 +3686,7 @@ var doc = `{
}
],
"responses": {
"200": {
"201": {
"description": "The created list.",
"schema": {
"$ref": "#/definitions/models.List"
@ -4215,7 +4215,7 @@ var doc = `{
}
],
"responses": {
"200": {
"201": {
"description": "The subscription",
"schema": {
"$ref": "#/definitions/models.Subscription"
@ -4969,7 +4969,7 @@ var doc = `{
}
],
"responses": {
"200": {
"201": {
"description": "The created assingee object.",
"schema": {
"$ref": "#/definitions/models.TaskAssginee"
@ -5027,7 +5027,7 @@ var doc = `{
}
],
"responses": {
"200": {
"201": {
"description": "The created assingees object.",
"schema": {
"$ref": "#/definitions/models.TaskAssginee"
@ -5185,7 +5185,7 @@ var doc = `{
}
],
"responses": {
"200": {
"201": {
"description": "The created task comment object.",
"schema": {
"$ref": "#/definitions/models.TaskComment"
@ -5425,7 +5425,7 @@ var doc = `{
}
],
"responses": {
"200": {
"201": {
"description": "The updated labels object.",
"schema": {
"$ref": "#/definitions/models.LabelTaskBulk"
@ -5483,7 +5483,7 @@ var doc = `{
}
],
"responses": {
"200": {
"201": {
"description": "The created task relation object.",
"schema": {
"$ref": "#/definitions/models.TaskRelation"
@ -5680,7 +5680,7 @@ var doc = `{
}
],
"responses": {
"200": {
"201": {
"description": "The created label relation object.",
"schema": {
"$ref": "#/definitions/models.LabelTask"
@ -5860,7 +5860,7 @@ var doc = `{
}
],
"responses": {
"200": {
"201": {
"description": "The created team.",
"schema": {
"$ref": "#/definitions/models.Team"
@ -6067,7 +6067,7 @@ var doc = `{
}
],
"responses": {
"200": {
"201": {
"description": "The newly created member object",
"schema": {
"$ref": "#/definitions/models.TeamMember"

40
pkg/swagger/swagger.json
View file

@ -226,7 +226,7 @@
],
"summary": "Creates a new saved filter",
"responses": {
"200": {
"201": {
"description": "The Saved Filter",
"schema": {
"$ref": "#/definitions/models.SavedFilter"
@ -507,7 +507,7 @@
}
],
"responses": {
"200": {
"201": {
"description": "The created label object.",
"schema": {
"$ref": "#/definitions/models.Label"
@ -857,7 +857,7 @@
}
],
"responses": {
"200": {
"201": {
"description": "The created task object.",
"schema": {
"$ref": "#/definitions/models.Task"
@ -1555,7 +1555,7 @@
}
],
"responses": {
"200": {
"201": {
"description": "The created team\u003c-\u003elist relation.",
"schema": {
"$ref": "#/definitions/models.TeamList"
@ -1693,7 +1693,7 @@
}
],
"responses": {
"200": {
"201": {
"description": "The created user\u003c-\u003elist relation.",
"schema": {
"$ref": "#/definitions/models.ListUser"
@ -1888,7 +1888,7 @@
}
],
"responses": {
"200": {
"201": {
"description": "The created list.",
"schema": {
"$ref": "#/definitions/models.ListDuplicate"
@ -2376,7 +2376,7 @@
}
],
"responses": {
"200": {
"201": {
"description": "The created link share object.",
"schema": {
"$ref": "#/definitions/models.LinkSharing"
@ -3172,7 +3172,7 @@
}
],
"responses": {
"200": {
"201": {
"description": "The created namespace.",
"schema": {
"$ref": "#/definitions/models.Namespace"
@ -3461,7 +3461,7 @@
}
],
"responses": {
"200": {
"201": {
"description": "The created team\u003c-\u003enamespace relation.",
"schema": {
"$ref": "#/definitions/models.TeamNamespace"
@ -3599,7 +3599,7 @@
}
],
"responses": {
"200": {
"201": {
"description": "The created user\u003c-\u003enamespace relation.",
"schema": {
"$ref": "#/definitions/models.NamespaceUser"
@ -3669,7 +3669,7 @@
}
],
"responses": {
"200": {
"201": {
"description": "The created list.",
"schema": {
"$ref": "#/definitions/models.List"
@ -4198,7 +4198,7 @@
}
],
"responses": {
"200": {
"201": {
"description": "The subscription",
"schema": {
"$ref": "#/definitions/models.Subscription"
@ -4952,7 +4952,7 @@
}
],
"responses": {
"200": {
"201": {
"description": "The created assingee object.",
"schema": {
"$ref": "#/definitions/models.TaskAssginee"
@ -5010,7 +5010,7 @@
}
],
"responses": {
"200": {
"201": {
"description": "The created assingees object.",
"schema": {
"$ref": "#/definitions/models.TaskAssginee"
@ -5168,7 +5168,7 @@
}
],
"responses": {
"200": {
"201": {
"description": "The created task comment object.",
"schema": {
"$ref": "#/definitions/models.TaskComment"
@ -5408,7 +5408,7 @@
}
],
"responses": {
"200": {
"201": {
"description": "The updated labels object.",
"schema": {
"$ref": "#/definitions/models.LabelTaskBulk"
@ -5466,7 +5466,7 @@
}
],
"responses": {
"200": {
"201": {
"description": "The created task relation object.",
"schema": {
"$ref": "#/definitions/models.TaskRelation"
@ -5663,7 +5663,7 @@
}
],
"responses": {
"200": {
"201": {
"description": "The created label relation object.",
"schema": {
"$ref": "#/definitions/models.LabelTask"
@ -5843,7 +5843,7 @@
}
],
"responses": {
"200": {
"201": {
"description": "The created team.",
"schema": {
"$ref": "#/definitions/models.Team"
@ -6050,7 +6050,7 @@
}
],
"responses": {
"200": {
"201": {
"description": "The newly created member object",
"schema": {
"$ref": "#/definitions/models.TeamMember"

40
pkg/swagger/swagger.yaml
View file

@ -1462,7 +1462,7 @@ paths:
produces:
- application/json
responses:
"200":
"201":
description: The Saved Filter
schema:
$ref: '#/definitions/models.SavedFilter'
@ -1645,7 +1645,7 @@ paths:
produces:
- application/json
responses:
"200":
"201":
description: The created label object.
schema:
$ref: '#/definitions/models.Label'
@ -1945,7 +1945,7 @@ paths:
produces:
- application/json
responses:
"200":
"201":
description: The created task object.
schema:
$ref: '#/definitions/models.Task'
@ -2338,7 +2338,7 @@ paths:
produces:
- application/json
responses:
"200":
"201":
description: The created team<->list relation.
schema:
$ref: '#/definitions/models.TeamList'
@ -2429,7 +2429,7 @@ paths:
produces:
- application/json
responses:
"200":
"201":
description: The created user<->list relation.
schema:
$ref: '#/definitions/models.ListUser'
@ -2517,7 +2517,7 @@ paths:
produces:
- application/json
responses:
"200":
"201":
description: The created link share object.
schema:
$ref: '#/definitions/models.LinkSharing'
@ -2727,7 +2727,7 @@ paths:
produces:
- application/json
responses:
"200":
"201":
description: The created list.
schema:
$ref: '#/definitions/models.ListDuplicate'
@ -3422,7 +3422,7 @@ paths:
produces:
- application/json
responses:
"200":
"201":
description: The created namespace.
schema:
$ref: '#/definitions/models.Namespace'
@ -3610,7 +3610,7 @@ paths:
produces:
- application/json
responses:
"200":
"201":
description: The created team<->namespace relation.
schema:
$ref: '#/definitions/models.TeamNamespace'
@ -3702,7 +3702,7 @@ paths:
produces:
- application/json
responses:
"200":
"201":
description: The created user<->namespace relation.
schema:
$ref: '#/definitions/models.NamespaceUser'
@ -3748,7 +3748,7 @@ paths:
produces:
- application/json
responses:
"200":
"201":
description: The created list.
schema:
$ref: '#/definitions/models.List'
@ -4139,7 +4139,7 @@ paths:
produces:
- application/json
responses:
"200":
"201":
description: The subscription
schema:
$ref: '#/definitions/models.Subscription'
@ -4493,7 +4493,7 @@ paths:
produces:
- application/json
responses:
"200":
"201":
description: The created label relation object.
schema:
$ref: '#/definitions/models.LabelTask'
@ -4622,7 +4622,7 @@ paths:
produces:
- application/json
responses:
"200":
"201":
description: The created assingee object.
schema:
$ref: '#/definitions/models.TaskAssginee'
@ -4698,7 +4698,7 @@ paths:
produces:
- application/json
responses:
"200":
"201":
description: The created assingees object.
schema:
$ref: '#/definitions/models.TaskAssginee'
@ -4765,7 +4765,7 @@ paths:
produces:
- application/json
responses:
"200":
"201":
description: The created task comment object.
schema:
$ref: '#/definitions/models.TaskComment'
@ -4926,7 +4926,7 @@ paths:
produces:
- application/json
responses:
"200":
"201":
description: The updated labels object.
schema:
$ref: '#/definitions/models.LabelTaskBulk'
@ -4966,7 +4966,7 @@ paths:
produces:
- application/json
responses:
"200":
"201":
description: The created task relation object.
schema:
$ref: '#/definitions/models.TaskRelation'
@ -5206,7 +5206,7 @@ paths:
produces:
- application/json
responses:
"200":
"201":
description: The created team.
schema:
$ref: '#/definitions/models.Team'
@ -5339,7 +5339,7 @@ paths:
produces:
- application/json
responses:
"200":
"201":
description: The newly created member object
schema:
$ref: '#/definitions/models.TeamMember'