the-darkvoid
/
vikunja-api
forked from vikunja/vikunja
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix: swagger docs

This commit is contained in:
kolaente 2022-11-11 15:34:26 +01:00
parent 87c2e442f2
commit 96b5e93379
Signed by untrusted user: konrad
GPG Key ID: F40E70337AB24C9B
5 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
pkg/models/task_relation.go
View File

@ -202,7 +202,7 @@ func (rel *TaskRelation) Create(s *xorm.Session, a web.Auth) error {
// @Param relation body models.TaskRelation true "The relation object"
// @Param taskID path int true "Task ID"
// @Param relationKind path string true "The kind of the relation. See the TaskRelation type for more info."
// @Param otherTaskID path int true "The id of the other task."
// @Param otherTaskId path int true "The id of the other task."
// @Success 200 {object} models.Message "The task relation was successfully deleted."
// @Failure 400 {object} web.HTTPError "Invalid task relation object provided."
// @Failure 404 {object} web.HTTPError "The task relation was not found."

4
pkg/modules/background/unsplash/proxy.go
View File

@ -47,7 +47,7 @@ func unsplashImage(url string, c echo.Context) error {
// @Description Get an unsplash image. **Returns json on error.**
// @tags list
// @Produce octet-stream
// @Param thumb path int true "Unsplash Image ID"
// @Param image path int true "Unsplash Image ID"
// @Security JWTKeyAuth
// @Success 200 {} string "The image"
// @Failure 404 {object} models.Message "The image does not exist."
@ -67,7 +67,7 @@ func ProxyUnsplashImage(c echo.Context) error {
// @Description Get an unsplash thumbnail image. The thumbnail is cropped to a max width of 200px. **Returns json on error.**
// @tags list
// @Produce octet-stream
// @Param thumb path int true "Unsplash Image ID"
// @Param image path int true "Unsplash Image ID"
// @Security JWTKeyAuth
// @Success 200 {} string "The thumbnail"
// @Failure 404 {object} models.Message "The image does not exist."

6
pkg/swagger/docs.go
View File

@ -95,7 +95,7 @@ const docTemplate = `{
{
"type": "integer",
"description": "Unsplash Image ID",
"name": "thumb",
"name": "image",
"in": "path",
"required": true
}
@ -141,7 +141,7 @@ const docTemplate = `{
{
"type": "integer",
"description": "Unsplash Image ID",
"name": "thumb",
"name": "image",
"in": "path",
"required": true
}
@ -5688,7 +5688,7 @@ const docTemplate = `{
{
"type": "integer",
"description": "The id of the other task.",
"name": "otherTaskID",
"name": "otherTaskId",
"in": "path",
"required": true
}

6
pkg/swagger/swagger.json
View File

@ -86,7 +86,7 @@
{
"type": "integer",
"description": "Unsplash Image ID",
"name": "thumb",
"name": "image",
"in": "path",
"required": true
}
@ -132,7 +132,7 @@
{
"type": "integer",
"description": "Unsplash Image ID",
"name": "thumb",
"name": "image",
"in": "path",
"required": true
}
@ -5679,7 +5679,7 @@
{
"type": "integer",
"description": "The id of the other task.",
"name": "otherTaskID",
"name": "otherTaskId",
"in": "path",
"required": true
}

6
pkg/swagger/swagger.yaml
View File

@ -1509,7 +1509,7 @@ paths:
parameters:
- description: Unsplash Image ID
in: path
name: thumb
name: image
required: true
type: integer
produces:
@ -1539,7 +1539,7 @@ paths:
parameters:
- description: Unsplash Image ID
in: path
name: thumb
name: image
required: true
type: integer
produces:
@ -5247,7 +5247,7 @@ paths:
type: string
- description: The id of the other task.
in: path
name: otherTaskID
name: otherTaskId
required: true
type: integer
produces: