ami/tl-vikunja
1
0
Fork 0
Code Activity

/info endpoint (#85)

Browse Source
This commit is contained in:
konrad
2019-07-15 22:54:38 +00:00
committed by Gitea
parent c3ea45d900
commit e2d9de191d
11 changed files with 200 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

51
pkg/swagger/docs.go
View File

@ -1,6 +1,6 @@
// GENERATED BY THE COMMAND ABOVE; DO NOT EDIT
// This file was generated by swaggo/swag at
// 2019-06-04 19:35:31.322131656 +0200 CEST m=+0.130618199
// 2019-07-16 00:32:48.008049583 +0200 CEST m=+0.169009519
package swagger
@ -30,6 +30,27 @@ var doc = `{
"host": "{{.Host}}",
"basePath": "/api/v1",
"paths": {
"/info": {
"get": {
"description": "Returns the version, frontendurl and motd of Vikunja",
"produces": [
"application/json"
],
"tags": [
"service"
],
"summary": "Info",
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"$ref": "#/definitions/v1.vikunjaInfos"
}
}
}
}
},
"/labels": {
"get": {
"security": [
@ -37,7 +58,7 @@ var doc = `{
"JWTKeyAuth": []
}
],
"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.",
"consumes": [
"application/json"
],
@ -45,9 +66,9 @@ var doc = `{
"application/json"
],
"tags": [
"labels"
"assignees"
],
"summary": "Get all labels a user has access to",
"summary": "Get all assignees for a task",
"parameters": [
{
"type": "integer",
@ -57,18 +78,18 @@ var doc = `{
},
{
"type": "string",
"description": "Search labels by label text.",
"description": "Search assignees by their username.",
"name": "s",
"in": "query"
}
],
"responses": {
"200": {
"description": "The labels",
"description": "The assignees",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/models.Label"
"$ref": "#/definitions/models.User"
}
}
},
@ -3984,7 +4005,7 @@ var doc = `{
"description": "A unix timestamp when this relation was last updated. You cannot change this value.",
"type": "integer"
},
"username": {
"userID": {
"description": "The username.",
"type": "string"
}
@ -4414,6 +4435,20 @@ var doc = `{
"type": "string"
}
}
},
"v1.vikunjaInfos": {
"type": "object",
"properties": {
"frontend_url": {
"type": "string"
},
"motd": {
"type": "string"
},
"version": {
"type": "string"
}
}
}
},
"securityDefinitions": {

49
pkg/swagger/swagger.json
View File

@ -17,6 +17,27 @@
"host": "{{.Host}}",
"basePath": "/api/v1",
"paths": {
"/info": {
"get": {
"description": "Returns the version, frontendurl and motd of Vikunja",
"produces": [
"application/json"
],
"tags": [
"service"
],
"summary": "Info",
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"$ref": "#/definitions/v1.vikunjaInfos"
}
}
}
}
},
"/labels": {
"get": {
"security": [
@ -24,7 +45,7 @@
"JWTKeyAuth": []
}
],
"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.",
"consumes": [
"application/json"
],
@ -32,9 +53,9 @@
"application/json"
],
"tags": [
"labels"
"assignees"
],
"summary": "Get all labels a user has access to",
"summary": "Get all assignees for a task",
"parameters": [
{
"type": "integer",
@ -44,18 +65,18 @@
},
{
"type": "string",
"description": "Search labels by label text.",
"description": "Search assignees by their username.",
"name": "s",
"in": "query"
}
],
"responses": {
"200": {
"description": "The labels",
"description": "The assignees",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/models.Label"
"$ref": "#/definitions/models.User"
}
}
},
@ -3970,7 +3991,7 @@
"description": "A unix timestamp when this relation was last updated. You cannot change this value.",
"type": "integer"
},
"username": {
"userID": {
"description": "The username.",
"type": "string"
}
@ -4400,6 +4421,20 @@
"type": "string"
}
}
},
"v1.vikunjaInfos": {
"type": "object",
"properties": {
"frontend_url": {
"type": "string"
},
"motd": {
"type": "string"
},
"version": {
"type": "string"
}
}
}
},
"securityDefinitions": {

38
pkg/swagger/swagger.yaml
View File

@ -312,7 +312,7 @@ definitions:
description: A unix timestamp when this relation was last updated. You cannot
change this value.
type: integer
username:
userID:
description: The username.
type: string
type: object
@ -658,6 +658,15 @@ definitions:
old_password:
type: string
type: object
v1.vikunjaInfos:
properties:
frontend_url:
type: string
motd:
type: string
version:
type: string
type: object
host: '{{.Host}}'
info:
contact:
@ -677,19 +686,32 @@ info:
title: Vikunja API
version: '{{.Version}}'
paths:
/info:
get:
description: Returns the version, frontendurl and motd of Vikunja
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/v1.vikunjaInfos'
type: object
summary: Info
tags:
- service
/labels:
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
@ -697,10 +719,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
@ -709,9 +731,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