Mirrors/wg-portal
1
0
Fork 0
mirror of https://github.com/h44z/wg-portal.git synced 2025-08-25 14:31:14 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

use query params throughout the whole rest api (#11)

Browse Source
This commit is contained in:
Christoph Haas
2021-05-03 11:40:06 +02:00
parent d794f807ad
commit edfecd536a
3 changed files with 106 additions and 108 deletions
Download Patch File Download Diff File Expand all files Collapse all files

130
internal/server/docs/docs.go
View File

@@ -31,7 +31,7 @@ var doc = `{
"host": "{{.Host}}",
"basePath": "{{.BasePath}}",
"paths": {
"/backend/device/{device}": {
"/backend/device": {
"get": {
"security": [
{
@@ -50,7 +50,7 @@ var doc = `{
"type": "string",
"description": "Device Name",
"name": "device",
"in": "path",
"in": "query",
"required": true
}
],
@@ -108,7 +108,7 @@ var doc = `{
"type": "string",
"description": "Device Name",
"name": "device",
"in": "path",
"in": "query",
"required": true
},
{
@@ -181,7 +181,7 @@ var doc = `{
"type": "string",
"description": "Device Name",
"name": "device",
"in": "path",
"in": "query",
"required": true
},
{
@@ -540,7 +540,7 @@ var doc = `{
}
}
},
"/backend/peers/{device}": {
"/backend/peers": {
"get": {
"security": [
{
@@ -559,7 +559,7 @@ var doc = `{
"type": "string",
"description": "Device Name",
"name": "device",
"in": "path",
"in": "query",
"required": true
}
],
@@ -614,7 +614,7 @@ var doc = `{
"type": "string",
"description": "Device Name",
"name": "device",
"in": "path",
"in": "query",
"required": true
},
{
@@ -667,7 +667,7 @@ var doc = `{
}
}
},
"/backend/user/{email}": {
"/backend/user": {
"get": {
"security": [
{
@@ -686,7 +686,7 @@ var doc = `{
"type": "string",
"description": "User Email",
"name": "email",
"in": "path",
"in": "query",
"required": true
}
],
@@ -744,7 +744,7 @@ var doc = `{
"type": "string",
"description": "User Email",
"name": "email",
"in": "path",
"in": "query",
"required": true
},
{
@@ -814,7 +814,7 @@ var doc = `{
"type": "string",
"description": "User Email",
"name": "email",
"in": "path",
"in": "query",
"required": true
}
],
@@ -875,7 +875,7 @@ var doc = `{
"type": "string",
"description": "User Email",
"name": "email",
"in": "path",
"in": "query",
"required": true
},
{
@@ -1091,6 +1091,58 @@ var doc = `{
}
},
"/provisioning/peers": {
"get": {
"security": [
{
"GeneralBasicAuth": []
}
],
"produces": [
"application/json"
],
"tags": [
"Provisioning"
],
"summary": "Retrieves all active peers for the given email address",
"parameters": [
{
"type": "string",
"description": "Email Address",
"name": "email",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "All active WireGuard peers",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/server.PeerDeploymentInformation"
}
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/server.ApiError"
}
},
"403": {
"description": "Forbidden",
"schema": {
"$ref": "#/definitions/server.ApiError"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/server.ApiError"
}
}
}
},
"post": {
"security": [
{
@@ -1145,60 +1197,6 @@ var doc = `{
}
}
}
},
"/provisioning/peers/{email}": {
"get": {
"security": [
{
"GeneralBasicAuth": []
}
],
"produces": [
"application/json"
],
"tags": [
"Provisioning"
],
"summary": "Retrieves all active peers for the given email address",
"parameters": [
{
"type": "string",
"description": "Email Address",
"name": "email",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "All active WireGuard peers",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/server.PeerDeploymentInformation"
}
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/server.ApiError"
}
},
"403": {
"description": "Forbidden",
"schema": {
"$ref": "#/definitions/server.ApiError"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/server.ApiError"
}
}
}
}
}
},
"definitions": {