vikunja
/
vikunja
6
43
Fork 71
Code Issues 150 Pull Requests 18 Packages Releases 32 Activity

Add docs
continuous-integration/drone/pr Build is failing Details

This commit is contained in:
kolaente 2020-11-28 21:42:46 +01:00
parent 789a8bf8d8
commit 246bc04ea8
Signed by: konrad
GPG Key ID: F40E70337AB24C9B
4 changed files with 119 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
pkg/routes/api/v1/testing.go
View File

@ -25,6 +25,16 @@ import (
"net/http"
)
// HandleTesting is the web handler to reset the db
// @Summary Reset the db to a defined state
// @Description Fills the specified table with the content provided in the payload. You need to enable the testing endpoint before doing this and provide the `Authorization: <token>` secret when making requests to this endpoint. See docs for more details.
// @tags testing
// @Accept json
// @Produce json
// @Param table path string true "The table to reset"
// @Success 201 {array} user.User "Everything has been imported successfully."
// @Failure 500 {object} models.Message "Internal server error."
// @Router /test/{table} [patch]
func HandleTesting(c echo.Context) error {
token := c.Request().Header.Get("Authorization")
if token != config.ServiceTestingtoken.GetString() {

41
pkg/swagger/docs.go
View File

@ -5605,6 +5605,47 @@ var doc = `{
}
}
},
"/test/{table}": {
"patch": {
"description": "Fills the specified table with the content provided in the payload. You need to enable the testing endpoint before doing this and provide the ` + "`" + `Authorization: \u003ctoken\u003e` + "`" + ` secret when making requests to this endpoint. See docs for more details.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"testing"
],
"summary": "Reset the db to a defined state",
"parameters": [
{
"type": "string",
"description": "The table to reset",
"name": "table",
"in": "path",
"required": true
}
],
"responses": {
"201": {
"description": "Everything has been imported successfully.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/user.User"
}
}
},
"500": {
"description": "Internal server error.",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/user": {
"get": {
"security": [

41
pkg/swagger/swagger.json
View File

@ -5588,6 +5588,47 @@
}
}
},
"/test/{table}": {
"patch": {
"description": "Fills the specified table with the content provided in the payload. You need to enable the testing endpoint before doing this and provide the `Authorization: \u003ctoken\u003e` secret when making requests to this endpoint. See docs for more details.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"testing"
],
"summary": "Reset the db to a defined state",
"parameters": [
{
"type": "string",
"description": "The table to reset",
"name": "table",
"in": "path",
"required": true
}
],
"responses": {
"201": {
"description": "Everything has been imported successfully.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/user.User"
}
}
},
"500": {
"description": "Internal server error.",
"schema": {
"$ref": "#/definitions/models.Message"
}
}
}
}
},
"/user": {
"get": {
"security": [

27
pkg/swagger/swagger.yaml
View File

@ -4653,6 +4653,33 @@ paths:
summary: Toggle a team member's admin status
tags:
- team
/test/{table}:
patch:
consumes:
- application/json
description: 'Fills the specified table with the content provided in the payload. You need to enable the testing endpoint before doing this and provide the `Authorization: <token>` secret when making requests to this endpoint. See docs for more details.'
parameters:
- description: The table to reset
in: path
name: table
required: true
type: string
produces:
- application/json
responses:
"201":
description: Everything has been imported successfully.
schema:
items:
$ref: '#/definitions/user.User'
type: array
"500":
description: Internal server error.
schema:
$ref: '#/definitions/models.Message'
summary: Reset the db to a defined state
tags:
- testing
/user:
get:
consumes: