Add docs
continuous-integration/drone/pr Build is failing
Details
continuous-integration/drone/pr Build is failing
Details
This commit is contained in:
parent
789a8bf8d8
commit
246bc04ea8
|
@ -25,6 +25,16 @@ import (
|
||||||
"net/http"
|
"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 {
|
func HandleTesting(c echo.Context) error {
|
||||||
token := c.Request().Header.Get("Authorization")
|
token := c.Request().Header.Get("Authorization")
|
||||||
if token != config.ServiceTestingtoken.GetString() {
|
if token != config.ServiceTestingtoken.GetString() {
|
||||||
|
|
|
@ -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": {
|
"/user": {
|
||||||
"get": {
|
"get": {
|
||||||
"security": [
|
"security": [
|
||||||
|
|
|
@ -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": {
|
"/user": {
|
||||||
"get": {
|
"get": {
|
||||||
"security": [
|
"security": [
|
||||||
|
|
|
@ -4653,6 +4653,33 @@ paths:
|
||||||
summary: Toggle a team member's admin status
|
summary: Toggle a team member's admin status
|
||||||
tags:
|
tags:
|
||||||
- team
|
- 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:
|
/user:
|
||||||
get:
|
get:
|
||||||
consumes:
|
consumes:
|
||||||
|
|
Loading…
Reference in New Issue