1
0
mirror of https://github.com/raseels-repos/golang-saas-starter-kit.git synced 2025-06-15 00:15:15 +02:00

fix api route for app page for docs

This commit is contained in:
Lee Brown
2019-08-05 19:49:30 -08:00
parent 74c0223fe6
commit 6523cbc481
15 changed files with 699 additions and 579 deletions

View File

@ -1,27 +1,24 @@
// GENERATED BY THE COMMAND ABOVE; DO NOT EDIT
// This file was generated by swaggo/swag at
// 2019-06-27 04:56:45.692511 -0800 AKDT m=+325.727343639
// 2019-08-05 19:25:44.265503 -0800 AKDT m=+407.181284601
package docs
import (
"bytes"
"encoding/json"
"github.com/alecthomas/template"
"github.com/swaggo/swag"
)
var doc = `{
"schemes": {{ marshal .Schemes }},
"swagger": "2.0",
"info": {
"description": "This is a sample server celler server.",
"description": "{{.Description}}",
"title": "SaaS Example API",
"termsOfService": "http://example.com/terms",
"contact": {
"name": "API Support",
"url": "http://example.com/support",
"email": "support@geeksinthewoods.com"
},
"contact": {},
"license": {
"name": "Apache 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
@ -67,21 +64,21 @@ var doc = `{
"description": "Bad Request",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
},
"403": {
"description": "Forbidden",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
}
}
@ -126,21 +123,21 @@ var doc = `{
"description": "Bad Request",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
},
"404": {
"description": "Not Found",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
}
}
@ -182,21 +179,21 @@ var doc = `{
"description": "Bad Request",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
}
}
@ -248,7 +245,7 @@ var doc = `{
{
"type": "boolean",
"description": "Included Archived, example: false",
"name": "included-archived",
"name": "include-archived",
"in": "query"
}
],
@ -266,21 +263,21 @@ var doc = `{
"description": "Bad Request",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
},
"403": {
"description": "Forbidden",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
}
}
@ -328,28 +325,28 @@ var doc = `{
"description": "Bad Request",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
},
"403": {
"description": "Forbidden",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
},
"404": {
"description": "Not Found",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
}
}
@ -389,21 +386,21 @@ var doc = `{
"description": "Bad Request",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
},
"403": {
"description": "Forbidden",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
}
}
@ -445,21 +442,21 @@ var doc = `{
"description": "Bad Request",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
},
"403": {
"description": "Forbidden",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
}
}
@ -504,21 +501,21 @@ var doc = `{
"description": "Bad Request",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
},
"404": {
"description": "Not Found",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
}
}
@ -555,21 +552,21 @@ var doc = `{
"description": "Bad Request",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
},
"403": {
"description": "Forbidden",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
}
}
@ -612,14 +609,14 @@ var doc = `{
"description": "Bad Request",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
}
}
@ -671,7 +668,7 @@ var doc = `{
{
"type": "boolean",
"description": "Included Archived, example: false",
"name": "included-archived",
"name": "include-archived",
"in": "query"
}
],
@ -689,21 +686,21 @@ var doc = `{
"description": "Bad Request",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
},
"403": {
"description": "Forbidden",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
}
}
@ -749,28 +746,28 @@ var doc = `{
"description": "Bad Request",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
},
"403": {
"description": "Forbidden",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
},
"404": {
"description": "Not Found",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
}
}
@ -807,21 +804,21 @@ var doc = `{
"description": "Bad Request",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
},
"403": {
"description": "Forbidden",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
}
}
@ -861,21 +858,21 @@ var doc = `{
"description": "Bad Request",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
},
"403": {
"description": "Forbidden",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
}
}
@ -917,27 +914,27 @@ var doc = `{
"description": "Bad Request",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
},
"403": {
"description": "Forbidden",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
}
}
}
},
"/user_accounts/{id}": {
"/user_accounts/{user_id}/{account_id}": {
"get": {
"security": [
{
@ -976,21 +973,21 @@ var doc = `{
"description": "Bad Request",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
},
"404": {
"description": "Not Found",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
}
}
@ -1042,7 +1039,7 @@ var doc = `{
{
"type": "boolean",
"description": "Included Archived, example: false",
"name": "included-archived",
"name": "include-archived",
"in": "query"
}
],
@ -1060,14 +1057,14 @@ var doc = `{
"description": "Bad Request",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
}
}
@ -1113,21 +1110,21 @@ var doc = `{
"description": "Bad Request",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
},
"403": {
"description": "Forbidden",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
}
}
@ -1167,21 +1164,21 @@ var doc = `{
"description": "Bad Request",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
},
"403": {
"description": "Forbidden",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
}
}
@ -1223,21 +1220,21 @@ var doc = `{
"description": "Bad Request",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
},
"403": {
"description": "Forbidden",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
}
}
@ -1279,21 +1276,21 @@ var doc = `{
"description": "Bad Request",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
},
"403": {
"description": "Forbidden",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
}
}
@ -1332,21 +1329,21 @@ var doc = `{
"description": "Bad Request",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
}
}
@ -1391,21 +1388,21 @@ var doc = `{
"description": "Bad Request",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
},
"404": {
"description": "Not Found",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
}
}
@ -1442,21 +1439,21 @@ var doc = `{
"description": "Bad Request",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
},
"403": {
"description": "Forbidden",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
"$ref": "#/definitions/weberror.ErrorResponse"
}
}
}
@ -1571,15 +1568,6 @@ var doc = `{
"type": "string",
"example": "d69bdef7-173f-4d29-b52c-3edc60baf6a2"
},
"status": {
"type": "string",
"enum": [
"active",
"pending",
"disabled"
],
"example": "disabled"
},
"timezone": {
"type": "string",
"example": "America/Anchorage"
@ -1616,14 +1604,6 @@ var doc = `{
"name": {
"type": "string",
"example": "Rocket Launch"
},
"status": {
"type": "string",
"enum": [
"active",
"disabled"
],
"example": "active"
}
}
},
@ -1678,14 +1658,6 @@ var doc = `{
"name": {
"type": "string",
"example": "Rocket Launch to Moon"
},
"status": {
"type": "string",
"enum": [
"active",
"disabled"
],
"example": "disabled"
}
}
},
@ -1764,17 +1736,23 @@ var doc = `{
"type": "object",
"required": [
"email",
"name",
"password"
"first_name",
"last_name",
"password",
"password_confirm"
],
"properties": {
"email": {
"type": "string",
"example": "{RANDOM_EMAIL}"
},
"name": {
"first_name": {
"type": "string",
"example": "Gabi May"
"example": "Gabi"
},
"last_name": {
"type": "string",
"example": "May"
},
"password": {
"type": "string",
@ -1792,6 +1770,9 @@ var doc = `{
"id"
],
"properties": {
"force": {
"type": "boolean"
},
"id": {
"type": "string",
"example": "d69bdef7-173f-4d29-b52c-3edc60baf6a2"
@ -1802,17 +1783,23 @@ var doc = `{
"type": "object",
"required": [
"email",
"name",
"password"
"first_name",
"last_name",
"password",
"password_confirm"
],
"properties": {
"email": {
"type": "string",
"example": "gabi@geeksinthewoods.com"
},
"name": {
"first_name": {
"type": "string",
"example": "Gabi May"
"example": "Gabi"
},
"last_name": {
"type": "string",
"example": "May"
},
"password": {
"type": "string",
@ -1843,13 +1830,24 @@ var doc = `{
"type": "string",
"example": "gabi@geeksinthewoods.com"
},
"first_name": {
"type": "string",
"example": "Gabi"
},
"gravatar": {
"type": "string"
},
"id": {
"type": "string",
"example": "d69bdef7-173f-4d29-b52c-3edc60baf6a2"
},
"last_name": {
"type": "string",
"example": "May"
},
"name": {
"type": "string",
"example": "Gabi May"
"example": "Gabi"
},
"timezone": {
"type": "string",
@ -1865,7 +1863,8 @@ var doc = `{
"type": "object",
"required": [
"id",
"password"
"password",
"password_confirm"
],
"properties": {
"id": {
@ -1892,11 +1891,15 @@ var doc = `{
"type": "string",
"example": "gabi.may@geeksinthewoods.com"
},
"first_name": {
"type": "string",
"example": "Gabi May Not"
},
"id": {
"type": "string",
"example": "d69bdef7-173f-4d29-b52c-3edc60baf6a2"
},
"name": {
"last_name": {
"type": "string",
"example": "Gabi May Not"
},
@ -1948,15 +1951,6 @@ var doc = `{
"admin"
]
},
"status": {
"type": "string",
"enum": [
"active",
"invited",
"disabled"
],
"example": "active"
},
"user_id": {
"type": "string",
"example": "d69bdef7-173f-4d29-b52c-3edc60baf6a2"
@ -1981,10 +1975,6 @@ var doc = `{
"type": "object",
"$ref": "#/definitions/web.TimeResponse"
},
"id": {
"type": "string",
"example": "d69bdef7-173f-4d29-b52c-3edc60baf6a2"
},
"roles": {
"type": "array",
"items": {
@ -2036,21 +2026,32 @@ var doc = `{
"user"
]
},
"status": {
"type": "string",
"enum": [
"active",
"invited",
"disabled"
],
"example": "disabled"
},
"user_id": {
"type": "string",
"example": "d69bdef7-173f-4d29-b52c-3edc60baf6a2"
}
}
},
"web.EnumMultiResponse": {
"type": "object",
"properties": {
"options": {
"type": "array",
"items": {
"$ref": "#/definitions/web.EnumOption"
}
},
"values": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"active_etc"
]
}
}
},
"web.EnumOption": {
"type": "object",
"properties": {
@ -2087,31 +2088,6 @@ var doc = `{
}
}
},
"web.ErrorResponse": {
"type": "object",
"properties": {
"error": {
"type": "string"
},
"fields": {
"type": "array",
"items": {
"$ref": "#/definitions/web.FieldError"
}
}
}
},
"web.FieldError": {
"type": "object",
"properties": {
"error": {
"type": "string"
},
"field": {
"type": "string"
}
}
},
"web.TimeResponse": {
"type": "object",
"properties": {
@ -2131,6 +2107,10 @@ var doc = `{
"type": "string",
"example": "Tue Jun 25"
},
"local_time": {
"type": "string",
"example": "3:00AM"
},
"now_rel_time": {
"type": "string",
"example": "15 hours from now"
@ -2160,6 +2140,49 @@ var doc = `{
"example": "2019-06-25T11:00:53.284Z"
}
}
},
"weberror.ErrorResponse": {
"type": "object",
"properties": {
"details": {
"type": "string"
},
"error": {
"type": "string"
},
"fields": {
"type": "array",
"items": {
"$ref": "#/definitions/weberror.FieldError"
}
},
"stack_trace": {
"type": "string"
},
"status_code": {
"type": "integer"
}
}
},
"weberror.FieldError": {
"type": "object",
"properties": {
"display": {
"type": "string"
},
"error": {
"type": "string"
},
"field": {
"type": "string"
},
"tag": {
"type": "string"
},
"value": {
"type": "object"
}
}
}
},
"securityDefinitions": {
@ -2182,17 +2205,23 @@ type swaggerInfo struct {
Version string
Host string
BasePath string
Schemes []string
Title string
Description string
}
// SwaggerInfo holds exported Swagger Info so clients can modify it
var SwaggerInfo swaggerInfo
var SwaggerInfo = swaggerInfo{Schemes: []string{}}
type s struct{}
func (s *s) ReadDoc() string {
t, err := template.New("swagger_info").Parse(doc)
t, err := template.New("swagger_info").Funcs(template.FuncMap{
"marshal": func(v interface{}) string {
a, _ := json.Marshal(v)
return string(a)
},
}).Parse(doc)
if err != nil {
return doc
}