v2.0.0: doc: add swagger from code

Signed-off-by: GnomeZworc <nicolas.boufidjeline@g3e.fr>
This commit is contained in:
GnomeZworc 2024-03-17 21:54:48 +01:00
commit ee4e2e3e31
Signed by: nicolas.boufideline
GPG key ID: 4406BBBF8845D632
8 changed files with 502 additions and 3 deletions

119
cmd/docs/swagger.json Normal file
View file

@ -0,0 +1,119 @@
{
"swagger": "2.0",
"info": {
"title": "Users",
"termsOfService": "http://swagger.io/terms/",
"contact": {
"name": "API Support",
"url": "http://www.swagger.io/support",
"email": "support@swagger.io"
},
"license": {
"name": "Apache 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
},
"version": "1.0"
},
"paths": {
"/": {
"get": {
"security": [
{
"ApiKeyAuth": []
}
],
"description": "Cette route de verifier que le token est toujours valide",
"tags": [
"auth"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
}
}
},
"post": {
"description": "Cette route permet d'obtenir un token user",
"consumes": [
"application/json"
],
"tags": [
"auth"
],
"parameters": [
{
"description": "request body",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/logins.RequestLogin"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/logins.ResponseLogin"
}
}
}
},
"delete": {
"security": [
{
"ApiKeyAuth": []
}
],
"description": "Cette route permet de revoker sont token",
"tags": [
"auth"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
}
}
}
}
},
"definitions": {
"logins.RequestLogin": {
"type": "object",
"properties": {
"password": {
"type": "string"
},
"username": {
"type": "string"
}
}
},
"logins.ResponseLogin": {
"type": "object",
"properties": {
"publickey": {
"type": "string"
},
"token": {
"type": "string"
}
}
}
},
"securityDefinitions": {
"ApiKeyAuth": {
"description": "Enter the token with the `Bearer: ` prefix, e.g. \"Bearer abcde12345\".",
"type": "apiKey",
"name": "Authorization",
"in": "header"
}
}
}