zrok/rest_server_zrok/embedded_spec.go

1605 lines
32 KiB
Go
Raw Normal View History

2022-07-22 16:52:36 +02:00
// Code generated by go-swagger; DO NOT EDIT.
package rest_server_zrok
2022-07-22 16:52:36 +02:00
// This file was generated by the swagger tool.
// Editing this file might prove futile when you re-run the swagger generate command
import (
"encoding/json"
)
var (
// SwaggerJSON embedded version of the swagger document used at generation time
SwaggerJSON json.RawMessage
// FlatSwaggerJSON embedded flattened version of the swagger document used at generation time
FlatSwaggerJSON json.RawMessage
)
func init() {
SwaggerJSON = json.RawMessage([]byte(`{
"consumes": [
2022-07-22 17:45:37 +02:00
"application/zrok.v1+json"
2022-07-22 16:52:36 +02:00
],
"produces": [
2022-07-22 17:45:37 +02:00
"application/zrok.v1+json"
2022-07-22 16:52:36 +02:00
],
"schemes": [
"http"
],
"swagger": "2.0",
"info": {
"description": "zrok client access",
"title": "zrok",
2022-11-30 17:43:00 +01:00
"version": "0.3.0"
2022-07-22 16:52:36 +02:00
},
"basePath": "/api/v1",
2022-07-22 16:52:36 +02:00
"paths": {
2022-11-23 18:12:11 +01:00
"/access": {
"post": {
"security": [
{
"key": []
}
],
"tags": [
"service"
],
"operationId": "access",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"$ref": "#/definitions/accessRequest"
}
}
],
"responses": {
"201": {
"description": "access created",
"schema": {
"$ref": "#/definitions/accessResponse"
}
2022-11-23 18:12:11 +01:00
},
"401": {
"description": "unauthorized"
},
2022-11-23 18:24:35 +01:00
"404": {
"description": "not found"
},
2022-11-23 18:12:11 +01:00
"500": {
"description": "internal server error"
}
}
}
},
"/disable": {
"post": {
"security": [
{
"key": []
}
],
"tags": [
2022-11-30 17:43:00 +01:00
"environment"
],
"operationId": "disable",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"$ref": "#/definitions/disableRequest"
}
}
],
"responses": {
"200": {
"description": "environment disabled"
},
"401": {
"description": "invalid environment"
},
"500": {
2022-11-30 17:43:00 +01:00
"description": "internal server error"
}
}
}
},
2022-07-25 23:05:44 +02:00
"/enable": {
"post": {
"security": [
{
"key": []
}
],
2022-07-25 23:05:44 +02:00
"tags": [
2022-11-30 17:43:00 +01:00
"environment"
2022-07-25 23:05:44 +02:00
],
"operationId": "enable",
2022-08-03 20:25:27 +02:00
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"$ref": "#/definitions/enableRequest"
}
}
],
2022-07-25 23:05:44 +02:00
"responses": {
"201": {
"description": "environment enabled",
"schema": {
"$ref": "#/definitions/enableResponse"
}
},
2022-07-27 20:50:46 +02:00
"401": {
2022-11-30 17:43:00 +01:00
"description": "unauthorized"
2022-07-27 20:50:46 +02:00
},
"404": {
"description": "account not found"
},
2022-07-25 23:05:44 +02:00
"500": {
2022-11-30 17:43:00 +01:00
"description": "internal server error"
}
}
}
},
"/invite": {
"post": {
"tags": [
"account"
],
"operationId": "invite",
"parameters": [
{
"name": "body",
"in": "body",
2022-07-27 19:38:35 +02:00
"schema": {
2022-11-30 17:43:00 +01:00
"$ref": "#/definitions/inviteRequest"
2022-07-27 19:38:35 +02:00
}
2022-07-25 23:05:44 +02:00
}
2022-11-30 17:43:00 +01:00
],
"responses": {
"201": {
"description": "invitation created"
},
"400": {
"description": "invitation not created (already exists)"
},
"500": {
"description": "internal server error"
}
2022-07-25 23:05:44 +02:00
}
}
},
2022-08-02 19:23:31 +02:00
"/login": {
"post": {
"tags": [
2022-11-30 17:43:00 +01:00
"account"
2022-08-02 19:23:31 +02:00
],
"operationId": "login",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"$ref": "#/definitions/loginRequest"
}
}
],
"responses": {
"200": {
"description": "login successful",
"schema": {
"$ref": "#/definitions/loginResponse"
}
},
"401": {
"description": "invalid login"
}
}
}
},
2022-08-03 20:36:40 +02:00
"/overview": {
"get": {
2022-08-03 20:58:11 +02:00
"security": [
{
"key": []
}
],
2022-08-03 20:36:40 +02:00
"tags": [
"metadata"
],
"operationId": "overview",
"responses": {
"200": {
"description": "overview returned",
"schema": {
2022-08-03 21:05:28 +02:00
"$ref": "#/definitions/environmentServicesList"
2022-08-03 20:36:40 +02:00
}
},
"500": {
"description": "internal server error",
"schema": {
"$ref": "#/definitions/errorMessage"
}
}
}
}
},
2022-09-20 19:42:34 +02:00
"/register": {
"post": {
"tags": [
2022-11-30 17:43:00 +01:00
"account"
2022-09-20 19:42:34 +02:00
],
"operationId": "register",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"$ref": "#/definitions/registerRequest"
}
}
],
"responses": {
"200": {
"description": "account created",
"schema": {
"$ref": "#/definitions/registerResponse"
}
2022-09-20 19:42:34 +02:00
},
"404": {
"description": "request not found"
},
"500": {
2022-11-30 17:43:00 +01:00
"description": "internal server error"
2022-09-20 19:42:34 +02:00
}
}
}
},
2022-11-30 17:17:09 +01:00
"/service": {
"get": {
"security": [
{
"key": []
}
],
"tags": [
"service"
],
"operationId": "getService",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"$ref": "#/definitions/serviceRequest"
}
}
],
"responses": {
"200": {
"description": "ok",
"schema": {
"$ref": "#/definitions/service"
}
},
"401": {
"description": "unauthorized"
},
"404": {
"description": "not found"
},
"500": {
"description": "internal server error"
}
}
}
},
"/share": {
2022-07-26 21:38:35 +02:00
"post": {
"security": [
{
"key": []
}
],
2022-07-26 21:38:35 +02:00
"tags": [
"service"
2022-07-26 21:38:35 +02:00
],
"operationId": "share",
2022-07-26 21:38:35 +02:00
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"$ref": "#/definitions/shareRequest"
2022-07-26 21:38:35 +02:00
}
}
],
"responses": {
"201": {
"description": "service created",
2022-07-26 21:38:35 +02:00
"schema": {
"$ref": "#/definitions/shareResponse"
2022-07-26 21:38:35 +02:00
}
2022-07-27 19:17:47 +02:00
},
2022-08-01 21:44:26 +02:00
"401": {
"description": "unauthorized"
2022-08-01 21:44:26 +02:00
},
2022-07-27 19:17:47 +02:00
"500": {
2022-07-27 19:38:35 +02:00
"description": "internal server error",
"schema": {
"$ref": "#/definitions/errorMessage"
}
2022-07-26 21:38:35 +02:00
}
}
}
},
2022-11-23 18:12:11 +01:00
"/unaccess": {
"delete": {
"security": [
{
"key": []
}
],
"tags": [
"service"
],
"operationId": "unaccess",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"$ref": "#/definitions/unaccessRequest"
}
}
],
"responses": {
"200": {
"description": "access removed"
},
"401": {
"description": "unauthorized"
},
"404": {
"description": "not found"
},
"500": {
"description": "internal server error"
}
}
}
},
"/unshare": {
2022-07-27 17:35:28 +02:00
"delete": {
"security": [
{
"key": []
}
],
2022-07-27 17:35:28 +02:00
"tags": [
"service"
2022-07-27 17:35:28 +02:00
],
"operationId": "unshare",
2022-07-27 17:35:28 +02:00
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"$ref": "#/definitions/unshareRequest"
2022-07-27 17:35:28 +02:00
}
}
],
"responses": {
"200": {
"description": "service removed"
},
"401": {
"description": "unauthorized"
2022-07-27 17:35:28 +02:00
},
2022-08-01 21:44:26 +02:00
"404": {
"description": "not found"
2022-08-01 21:44:26 +02:00
},
2022-07-27 17:35:28 +02:00
"500": {
2022-07-27 19:38:35 +02:00
"description": "internal server error",
"schema": {
"$ref": "#/definitions/errorMessage"
}
2022-07-27 17:35:28 +02:00
}
}
}
},
2022-09-19 21:58:52 +02:00
"/verify": {
2022-09-19 22:26:54 +02:00
"post": {
2022-09-19 21:58:52 +02:00
"tags": [
2022-11-30 17:43:00 +01:00
"account"
2022-09-19 21:58:52 +02:00
],
"operationId": "verify",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"$ref": "#/definitions/verifyRequest"
}
}
],
"responses": {
"200": {
"description": "token ready",
"schema": {
"$ref": "#/definitions/verifyResponse"
}
},
"404": {
"description": "token not found"
},
"500": {
2022-11-30 17:43:00 +01:00
"description": "internal server error"
2022-09-19 21:58:52 +02:00
}
}
}
},
2022-07-25 17:51:23 +02:00
"/version": {
"get": {
"tags": [
"metadata"
],
"operationId": "version",
"responses": {
"200": {
2022-09-19 21:58:52 +02:00
"description": "current server version",
2022-07-25 17:51:23 +02:00
"schema": {
"$ref": "#/definitions/version"
}
}
}
}
2022-07-22 16:52:36 +02:00
}
},
"definitions": {
2022-11-23 18:12:11 +01:00
"accessRequest": {
"type": "object",
"properties": {
"svcName": {
"type": "string"
},
"zId": {
"type": "string"
}
}
},
"accessResponse": {
"type": "object",
"properties": {
"frontendName": {
"type": "string"
}
}
},
"authUser": {
"type": "object",
"properties": {
"password": {
"type": "string"
},
"username": {
"type": "string"
}
}
},
"disableRequest": {
"type": "object",
"properties": {
"identity": {
"type": "string"
}
}
},
2022-08-03 20:25:27 +02:00
"enableRequest": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"host": {
"type": "string"
}
}
},
2022-07-25 22:42:06 +02:00
"enableResponse": {
"type": "object",
"properties": {
"cfg": {
"type": "string"
},
2022-07-25 22:42:06 +02:00
"identity": {
"type": "string"
}
}
},
2022-08-03 17:54:11 +02:00
"environment": {
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
2022-08-03 19:48:17 +02:00
"address": {
"type": "string"
},
"createdAt": {
"type": "integer"
},
2022-08-03 19:48:17 +02:00
"description": {
"type": "string"
},
"host": {
"type": "string"
},
"updatedAt": {
"type": "integer"
},
2022-10-19 18:35:29 +02:00
"zId": {
"type": "string"
}
}
},
2022-08-03 20:36:40 +02:00
"environmentServices": {
"type": "object",
"properties": {
"environment": {
"$ref": "#/definitions/environment"
},
"services": {
"$ref": "#/definitions/services"
}
}
},
2022-08-03 21:05:28 +02:00
"environmentServicesList": {
"type": "array",
"items": {
"$ref": "#/definitions/environmentServices"
}
},
2022-08-03 17:54:11 +02:00
"environments": {
"type": "array",
"items": {
"$ref": "#/definitions/environment"
}
},
"errorMessage": {
"type": "string"
},
2022-11-30 17:43:00 +01:00
"inviteRequest": {
"type": "object",
"properties": {
"email": {
"type": "string"
}
}
},
2022-08-02 19:23:31 +02:00
"loginRequest": {
"type": "object",
"properties": {
"email": {
"type": "string"
},
"password": {
"type": "string"
}
}
},
"loginResponse": {
"type": "string"
},
"principal": {
2022-07-28 18:12:50 +02:00
"type": "object",
"properties": {
2022-09-09 16:20:05 +02:00
"email": {
"type": "string"
},
2022-07-28 18:12:50 +02:00
"id": {
"type": "integer"
},
"token": {
"type": "string"
}
}
},
2022-09-20 19:42:34 +02:00
"registerRequest": {
"type": "object",
"properties": {
"password": {
"type": "string"
},
"token": {
"type": "string"
}
}
},
"registerResponse": {
"type": "object",
"properties": {
"token": {
"type": "string"
}
}
},
2022-08-03 20:36:40 +02:00
"service": {
"type": "object",
"properties": {
"backend": {
"type": "string"
},
2022-08-03 20:36:40 +02:00
"createdAt": {
"type": "integer"
2022-08-03 20:36:40 +02:00
},
"frontend": {
2022-08-03 20:36:40 +02:00
"type": "string"
},
"metrics": {
"$ref": "#/definitions/serviceMetrics"
},
2022-10-19 18:35:29 +02:00
"name": {
2022-08-03 20:36:40 +02:00
"type": "string"
},
2022-10-19 18:35:29 +02:00
"updatedAt": {
"type": "integer"
},
2022-10-19 18:35:29 +02:00
"zId": {
"type": "string"
2022-08-03 20:36:40 +02:00
}
}
},
2022-11-30 17:17:09 +01:00
"service03": {
"type": "object",
"properties": {
"backendMode": {
"type": "string"
},
"backendProxyEndpoint": {
"type": "string"
},
"frontendEndpoint": {
"type": "string"
},
"frontendSelection": {
"type": "string"
},
"reserved": {
"type": "boolean"
},
"shareMode": {
"type": "string"
},
"token": {
"type": "string"
},
"zId": {
"type": "string"
}
}
},
"serviceMetrics": {
"type": "array",
"items": {
"type": "integer"
}
},
2022-11-30 17:17:09 +01:00
"serviceRequest": {
"type": "object",
"properties": {
"svcToken": {
"type": "string"
}
}
},
2022-08-03 20:36:40 +02:00
"services": {
"type": "array",
"items": {
"$ref": "#/definitions/service"
}
},
"shareRequest": {
2022-07-26 21:38:35 +02:00
"type": "object",
"properties": {
"authScheme": {
"type": "string"
},
"authUsers": {
"type": "array",
"items": {
"$ref": "#/definitions/authUser"
}
},
"backendMode": {
"type": "string",
"enum": [
"proxy",
"web",
"dav"
]
},
"backendProxyEndpoint": {
2022-07-26 21:38:35 +02:00
"type": "string"
},
"envZId": {
"type": "string"
},
"frontendSelection": {
"type": "array",
"items": {
"type": "string"
}
},
"shareMode": {
"type": "string",
"enum": [
"public",
"private"
]
2022-07-26 21:38:35 +02:00
}
}
},
"shareResponse": {
2022-07-26 21:38:35 +02:00
"type": "object",
"properties": {
"frontendProxyEndpoint": {
"type": "string"
},
"svcToken": {
2022-07-26 21:38:35 +02:00
"type": "string"
}
}
},
2022-11-23 18:12:11 +01:00
"unaccessRequest": {
"type": "object",
"properties": {
"frontendName": {
"type": "string"
},
2022-11-23 18:12:11 +01:00
"svcName": {
"type": "string"
},
"zId": {
"type": "string"
}
}
},
"unshareRequest": {
2022-07-27 17:35:28 +02:00
"type": "object",
"properties": {
2022-10-19 18:35:29 +02:00
"svcName": {
2022-07-27 17:35:28 +02:00
"type": "string"
2022-08-03 20:58:11 +02:00
},
2022-10-19 18:35:29 +02:00
"zId": {
2022-08-03 20:58:11 +02:00
"type": "string"
2022-07-27 17:35:28 +02:00
}
}
},
2022-09-19 21:58:52 +02:00
"verifyRequest": {
"type": "object",
"properties": {
"token": {
"type": "string"
}
}
},
"verifyResponse": {
"type": "object",
"properties": {
"email": {
"type": "string"
}
}
},
2022-07-22 16:52:36 +02:00
"version": {
"type": "string"
}
},
"securityDefinitions": {
"key": {
"type": "apiKey",
"name": "x-token",
"in": "header"
2022-07-22 16:52:36 +02:00
}
}
}`))
FlatSwaggerJSON = json.RawMessage([]byte(`{
"consumes": [
2022-07-22 17:45:37 +02:00
"application/zrok.v1+json"
2022-07-22 16:52:36 +02:00
],
"produces": [
2022-07-22 17:45:37 +02:00
"application/zrok.v1+json"
2022-07-22 16:52:36 +02:00
],
"schemes": [
"http"
],
"swagger": "2.0",
"info": {
"description": "zrok client access",
"title": "zrok",
2022-11-30 17:43:00 +01:00
"version": "0.3.0"
2022-07-22 16:52:36 +02:00
},
"basePath": "/api/v1",
2022-07-22 16:52:36 +02:00
"paths": {
2022-11-23 18:12:11 +01:00
"/access": {
"post": {
"security": [
{
"key": []
}
],
"tags": [
"service"
],
"operationId": "access",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"$ref": "#/definitions/accessRequest"
}
}
],
"responses": {
"201": {
"description": "access created",
"schema": {
"$ref": "#/definitions/accessResponse"
}
2022-11-23 18:12:11 +01:00
},
"401": {
"description": "unauthorized"
},
2022-11-23 18:24:35 +01:00
"404": {
"description": "not found"
},
2022-11-23 18:12:11 +01:00
"500": {
"description": "internal server error"
}
}
}
},
"/disable": {
"post": {
"security": [
{
"key": []
}
],
"tags": [
2022-11-30 17:43:00 +01:00
"environment"
],
"operationId": "disable",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"$ref": "#/definitions/disableRequest"
}
}
],
"responses": {
"200": {
"description": "environment disabled"
},
"401": {
"description": "invalid environment"
},
"500": {
2022-11-30 17:43:00 +01:00
"description": "internal server error"
}
}
}
},
2022-07-25 23:05:44 +02:00
"/enable": {
"post": {
"security": [
{
"key": []
}
],
2022-07-25 23:05:44 +02:00
"tags": [
2022-11-30 17:43:00 +01:00
"environment"
2022-07-25 23:05:44 +02:00
],
"operationId": "enable",
2022-08-03 20:25:27 +02:00
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"$ref": "#/definitions/enableRequest"
}
}
],
2022-07-25 23:05:44 +02:00
"responses": {
"201": {
"description": "environment enabled",
"schema": {
"$ref": "#/definitions/enableResponse"
}
},
2022-07-27 20:50:46 +02:00
"401": {
2022-11-30 17:43:00 +01:00
"description": "unauthorized"
2022-07-27 20:50:46 +02:00
},
"404": {
"description": "account not found"
},
2022-07-25 23:05:44 +02:00
"500": {
2022-11-30 17:43:00 +01:00
"description": "internal server error"
}
}
}
},
"/invite": {
"post": {
"tags": [
"account"
],
"operationId": "invite",
"parameters": [
{
"name": "body",
"in": "body",
2022-07-27 19:38:35 +02:00
"schema": {
2022-11-30 17:43:00 +01:00
"$ref": "#/definitions/inviteRequest"
2022-07-27 19:38:35 +02:00
}
2022-07-25 23:05:44 +02:00
}
2022-11-30 17:43:00 +01:00
],
"responses": {
"201": {
"description": "invitation created"
},
"400": {
"description": "invitation not created (already exists)"
},
"500": {
"description": "internal server error"
}
2022-07-25 23:05:44 +02:00
}
}
},
2022-08-02 19:23:31 +02:00
"/login": {
"post": {
"tags": [
2022-11-30 17:43:00 +01:00
"account"
2022-08-02 19:23:31 +02:00
],
"operationId": "login",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"$ref": "#/definitions/loginRequest"
}
}
],
"responses": {
"200": {
"description": "login successful",
"schema": {
"$ref": "#/definitions/loginResponse"
}
},
"401": {
"description": "invalid login"
}
}
}
},
2022-08-03 20:36:40 +02:00
"/overview": {
"get": {
2022-08-03 20:58:11 +02:00
"security": [
{
"key": []
}
],
2022-08-03 20:36:40 +02:00
"tags": [
"metadata"
],
"operationId": "overview",
"responses": {
"200": {
"description": "overview returned",
"schema": {
2022-08-03 21:05:28 +02:00
"$ref": "#/definitions/environmentServicesList"
2022-08-03 20:36:40 +02:00
}
},
"500": {
"description": "internal server error",
"schema": {
"$ref": "#/definitions/errorMessage"
}
}
}
}
},
2022-09-20 19:42:34 +02:00
"/register": {
"post": {
"tags": [
2022-11-30 17:43:00 +01:00
"account"
2022-09-20 19:42:34 +02:00
],
"operationId": "register",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"$ref": "#/definitions/registerRequest"
}
}
],
"responses": {
"200": {
"description": "account created",
"schema": {
"$ref": "#/definitions/registerResponse"
}
2022-09-20 19:42:34 +02:00
},
"404": {
"description": "request not found"
},
"500": {
2022-11-30 17:43:00 +01:00
"description": "internal server error"
2022-09-20 19:42:34 +02:00
}
}
}
},
2022-11-30 17:17:09 +01:00
"/service": {
"get": {
"security": [
{
"key": []
}
],
"tags": [
"service"
],
"operationId": "getService",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"$ref": "#/definitions/serviceRequest"
}
}
],
"responses": {
"200": {
"description": "ok",
"schema": {
"$ref": "#/definitions/service"
}
},
"401": {
"description": "unauthorized"
},
"404": {
"description": "not found"
},
"500": {
"description": "internal server error"
}
}
}
},
"/share": {
2022-07-26 21:38:35 +02:00
"post": {
"security": [
{
"key": []
}
],
2022-07-26 21:38:35 +02:00
"tags": [
"service"
2022-07-26 21:38:35 +02:00
],
"operationId": "share",
2022-07-26 21:38:35 +02:00
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"$ref": "#/definitions/shareRequest"
2022-07-26 21:38:35 +02:00
}
}
],
"responses": {
"201": {
"description": "service created",
2022-07-26 21:38:35 +02:00
"schema": {
"$ref": "#/definitions/shareResponse"
2022-07-26 21:38:35 +02:00
}
2022-07-27 19:17:47 +02:00
},
2022-08-01 21:44:26 +02:00
"401": {
"description": "unauthorized"
2022-08-01 21:44:26 +02:00
},
2022-07-27 19:17:47 +02:00
"500": {
2022-07-27 19:38:35 +02:00
"description": "internal server error",
"schema": {
"$ref": "#/definitions/errorMessage"
}
2022-07-26 21:38:35 +02:00
}
}
}
},
2022-11-23 18:12:11 +01:00
"/unaccess": {
"delete": {
"security": [
{
"key": []
}
],
"tags": [
"service"
],
"operationId": "unaccess",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"$ref": "#/definitions/unaccessRequest"
}
}
],
"responses": {
"200": {
"description": "access removed"
},
"401": {
"description": "unauthorized"
},
"404": {
"description": "not found"
},
"500": {
"description": "internal server error"
}
}
}
},
"/unshare": {
2022-07-27 17:35:28 +02:00
"delete": {
"security": [
{
"key": []
}
],
2022-07-27 17:35:28 +02:00
"tags": [
"service"
2022-07-27 17:35:28 +02:00
],
"operationId": "unshare",
2022-07-27 17:35:28 +02:00
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"$ref": "#/definitions/unshareRequest"
2022-07-27 17:35:28 +02:00
}
}
],
"responses": {
"200": {
"description": "service removed"
},
"401": {
"description": "unauthorized"
2022-07-27 17:35:28 +02:00
},
2022-08-01 21:44:26 +02:00
"404": {
"description": "not found"
2022-08-01 21:44:26 +02:00
},
2022-07-27 17:35:28 +02:00
"500": {
2022-07-27 19:38:35 +02:00
"description": "internal server error",
"schema": {
"$ref": "#/definitions/errorMessage"
}
2022-07-27 17:35:28 +02:00
}
}
}
},
2022-09-19 21:58:52 +02:00
"/verify": {
2022-09-19 22:26:54 +02:00
"post": {
2022-09-19 21:58:52 +02:00
"tags": [
2022-11-30 17:43:00 +01:00
"account"
2022-09-19 21:58:52 +02:00
],
"operationId": "verify",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"$ref": "#/definitions/verifyRequest"
}
}
],
"responses": {
"200": {
"description": "token ready",
"schema": {
"$ref": "#/definitions/verifyResponse"
}
},
"404": {
"description": "token not found"
},
"500": {
2022-11-30 17:43:00 +01:00
"description": "internal server error"
2022-09-19 21:58:52 +02:00
}
}
}
},
2022-07-25 17:51:23 +02:00
"/version": {
"get": {
"tags": [
"metadata"
],
"operationId": "version",
"responses": {
"200": {
2022-09-19 21:58:52 +02:00
"description": "current server version",
2022-07-25 17:51:23 +02:00
"schema": {
"$ref": "#/definitions/version"
}
}
}
}
2022-07-22 16:52:36 +02:00
}
},
"definitions": {
2022-11-23 18:12:11 +01:00
"accessRequest": {
"type": "object",
"properties": {
"svcName": {
"type": "string"
},
"zId": {
"type": "string"
}
}
},
"accessResponse": {
"type": "object",
"properties": {
"frontendName": {
"type": "string"
}
}
},
"authUser": {
"type": "object",
"properties": {
"password": {
"type": "string"
},
"username": {
"type": "string"
}
}
},
"disableRequest": {
"type": "object",
"properties": {
"identity": {
"type": "string"
}
}
},
2022-08-03 20:25:27 +02:00
"enableRequest": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"host": {
"type": "string"
}
}
},
2022-07-25 22:42:06 +02:00
"enableResponse": {
"type": "object",
"properties": {
"cfg": {
"type": "string"
},
2022-07-25 22:42:06 +02:00
"identity": {
"type": "string"
}
}
},
2022-08-03 17:54:11 +02:00
"environment": {
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
2022-08-03 19:48:17 +02:00
"address": {
"type": "string"
},
"createdAt": {
"type": "integer"
},
2022-08-03 19:48:17 +02:00
"description": {
"type": "string"
},
"host": {
"type": "string"
},
"updatedAt": {
"type": "integer"
},
2022-10-19 18:35:29 +02:00
"zId": {
"type": "string"
}
}
},
2022-08-03 20:36:40 +02:00
"environmentServices": {
"type": "object",
"properties": {
"environment": {
"$ref": "#/definitions/environment"
},
"services": {
"$ref": "#/definitions/services"
}
}
},
2022-08-03 21:05:28 +02:00
"environmentServicesList": {
"type": "array",
"items": {
"$ref": "#/definitions/environmentServices"
}
},
2022-08-03 17:54:11 +02:00
"environments": {
"type": "array",
"items": {
"$ref": "#/definitions/environment"
}
},
"errorMessage": {
"type": "string"
},
2022-11-30 17:43:00 +01:00
"inviteRequest": {
"type": "object",
"properties": {
"email": {
"type": "string"
}
}
},
2022-08-02 19:23:31 +02:00
"loginRequest": {
"type": "object",
"properties": {
"email": {
"type": "string"
},
"password": {
"type": "string"
}
}
},
"loginResponse": {
"type": "string"
},
"principal": {
2022-07-28 18:12:50 +02:00
"type": "object",
"properties": {
2022-09-09 16:20:05 +02:00
"email": {
"type": "string"
},
2022-07-28 18:12:50 +02:00
"id": {
"type": "integer"
},
"token": {
"type": "string"
}
}
},
2022-09-20 19:42:34 +02:00
"registerRequest": {
"type": "object",
"properties": {
"password": {
"type": "string"
},
"token": {
"type": "string"
}
}
},
"registerResponse": {
"type": "object",
"properties": {
"token": {
"type": "string"
}
}
},
2022-08-03 20:36:40 +02:00
"service": {
"type": "object",
"properties": {
"backend": {
"type": "string"
},
2022-08-03 20:36:40 +02:00
"createdAt": {
"type": "integer"
2022-08-03 20:36:40 +02:00
},
"frontend": {
2022-08-03 20:36:40 +02:00
"type": "string"
},
"metrics": {
"$ref": "#/definitions/serviceMetrics"
},
2022-10-19 18:35:29 +02:00
"name": {
2022-08-03 20:36:40 +02:00
"type": "string"
},
2022-10-19 18:35:29 +02:00
"updatedAt": {
"type": "integer"
},
2022-10-19 18:35:29 +02:00
"zId": {
"type": "string"
2022-08-03 20:36:40 +02:00
}
}
},
2022-11-30 17:17:09 +01:00
"service03": {
"type": "object",
"properties": {
"backendMode": {
"type": "string"
},
"backendProxyEndpoint": {
"type": "string"
},
"frontendEndpoint": {
"type": "string"
},
"frontendSelection": {
"type": "string"
},
"reserved": {
"type": "boolean"
},
"shareMode": {
"type": "string"
},
"token": {
"type": "string"
},
"zId": {
"type": "string"
}
}
},
"serviceMetrics": {
"type": "array",
"items": {
"type": "integer"
}
},
2022-11-30 17:17:09 +01:00
"serviceRequest": {
"type": "object",
"properties": {
"svcToken": {
"type": "string"
}
}
},
2022-08-03 20:36:40 +02:00
"services": {
"type": "array",
"items": {
"$ref": "#/definitions/service"
}
},
"shareRequest": {
2022-07-26 21:38:35 +02:00
"type": "object",
"properties": {
"authScheme": {
"type": "string"
},
"authUsers": {
"type": "array",
"items": {
"$ref": "#/definitions/authUser"
}
},
"backendMode": {
"type": "string",
"enum": [
"proxy",
"web",
"dav"
]
},
"backendProxyEndpoint": {
2022-07-26 21:38:35 +02:00
"type": "string"
},
"envZId": {
"type": "string"
},
"frontendSelection": {
"type": "array",
"items": {
"type": "string"
}
},
"shareMode": {
"type": "string",
"enum": [
"public",
"private"
]
2022-07-26 21:38:35 +02:00
}
}
},
"shareResponse": {
2022-07-26 21:38:35 +02:00
"type": "object",
"properties": {
"frontendProxyEndpoint": {
"type": "string"
},
"svcToken": {
2022-07-26 21:38:35 +02:00
"type": "string"
}
}
},
2022-11-23 18:12:11 +01:00
"unaccessRequest": {
"type": "object",
"properties": {
"frontendName": {
"type": "string"
},
2022-11-23 18:12:11 +01:00
"svcName": {
"type": "string"
},
"zId": {
"type": "string"
}
}
},
"unshareRequest": {
2022-07-27 17:35:28 +02:00
"type": "object",
"properties": {
2022-10-19 18:35:29 +02:00
"svcName": {
2022-07-27 17:35:28 +02:00
"type": "string"
2022-08-03 20:58:11 +02:00
},
2022-10-19 18:35:29 +02:00
"zId": {
2022-08-03 20:58:11 +02:00
"type": "string"
2022-07-27 17:35:28 +02:00
}
}
},
2022-09-19 21:58:52 +02:00
"verifyRequest": {
"type": "object",
"properties": {
"token": {
"type": "string"
}
}
},
"verifyResponse": {
"type": "object",
"properties": {
"email": {
"type": "string"
}
}
},
2022-07-22 16:52:36 +02:00
"version": {
"type": "string"
}
},
"securityDefinitions": {
"key": {
"type": "apiKey",
"name": "x-token",
"in": "header"
2022-07-22 16:52:36 +02:00
}
}
}`))
}