mirror of
https://github.com/raseels-repos/golang-saas-starter-kit.git
synced 2025-06-06 23:46:29 +02:00
546 lines
17 KiB
Go
546 lines
17 KiB
Go
// GENERATED BY THE COMMAND ABOVE; DO NOT EDIT
|
|
// This file was generated by swaggo/swag at
|
|
// 2019-06-25 06:15:54.005963 -0800 AKDT m=+73.603716546
|
|
|
|
package docs
|
|
|
|
import (
|
|
"bytes"
|
|
|
|
"github.com/alecthomas/template"
|
|
"github.com/swaggo/swag"
|
|
)
|
|
|
|
var doc = `{
|
|
"swagger": "2.0",
|
|
"info": {
|
|
"description": "This is a sample server celler server.",
|
|
"title": "SaaS Example API",
|
|
"termsOfService": "http://example.com/terms",
|
|
"contact": {
|
|
"name": "API Support",
|
|
"url": "http://example.com/support",
|
|
"email": "support@geeksinthewoods.com"
|
|
},
|
|
"license": {
|
|
"name": "Apache 2.0",
|
|
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
|
|
},
|
|
"version": "{{.Version}}"
|
|
},
|
|
"host": "{{.Host}}",
|
|
"basePath": "{{.BasePath}}",
|
|
"paths": {
|
|
"/accounts/{id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"OAuth2Password": []
|
|
}
|
|
],
|
|
"description": "get string by ID",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"tags": [
|
|
"account"
|
|
],
|
|
"summary": "Read returns the specified account from the system.",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Account ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/definitions/account.Account"
|
|
},
|
|
"headers": {
|
|
"Token": {
|
|
"type": "string",
|
|
"description": "qwerty"
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/definitions/web.Error"
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Forbidden",
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/definitions/web.Error"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/definitions/web.Error"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/oauth/token": {
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"BasicAuth": []
|
|
}
|
|
],
|
|
"description": "Token generates an oauth2 accessToken using Basic Auth with a user's email and password.",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"tags": [
|
|
"user"
|
|
],
|
|
"summary": "Token handles a request to authenticate a user.",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/definitions/user.Token"
|
|
},
|
|
"headers": {
|
|
"Token": {
|
|
"type": "string",
|
|
"description": "qwerty"
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/definitions/web.Error"
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Forbidden",
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/definitions/web.Error"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/definitions/web.Error"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/signup": {
|
|
"post": {
|
|
"description": "Signup creates a new account and user in the system.",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"tags": [
|
|
"signup"
|
|
],
|
|
"summary": "Signup handles new account creation.",
|
|
"parameters": [
|
|
{
|
|
"description": "Signup details",
|
|
"name": "data",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/definitions/signup.SignupRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/definitions/signup.SignupResponse"
|
|
},
|
|
"headers": {
|
|
"Token": {
|
|
"type": "string",
|
|
"description": "qwerty"
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/definitions/web.Error"
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Forbidden",
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/definitions/web.Error"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/users/{id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"OAuth2Password": []
|
|
}
|
|
],
|
|
"description": "get string by ID",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"tags": [
|
|
"user"
|
|
],
|
|
"summary": "Read returns the specified user from the system.",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "User ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Authentication header",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/definitions/user.User"
|
|
},
|
|
"headers": {
|
|
"Token": {
|
|
"type": "string",
|
|
"description": "qwerty"
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/definitions/web.Error"
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Forbidden",
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/definitions/web.Error"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"schema": {
|
|
"type": "object",
|
|
"$ref": "#/definitions/web.Error"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"definitions": {
|
|
"account.Account": {
|
|
"type": "object",
|
|
"properties": {
|
|
"address1": {
|
|
"type": "string",
|
|
"example": "221 Tatitlek Ave"
|
|
},
|
|
"address2": {
|
|
"type": "string",
|
|
"example": "Box #1832"
|
|
},
|
|
"archived_at": {
|
|
"type": "string"
|
|
},
|
|
"billing_user_id": {
|
|
"type": "string"
|
|
},
|
|
"city": {
|
|
"type": "string",
|
|
"example": "Valdez"
|
|
},
|
|
"country": {
|
|
"type": "string",
|
|
"example": "USA"
|
|
},
|
|
"created_at": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"example": "c4653bf9-5978-48b7-89c5-95704aebb7e2"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Company Name"
|
|
},
|
|
"region": {
|
|
"type": "string",
|
|
"example": "AK"
|
|
},
|
|
"signup_user_id": {
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"type": "string",
|
|
"example": "active"
|
|
},
|
|
"timezone": {
|
|
"type": "string",
|
|
"example": "America/Anchorage"
|
|
},
|
|
"updated_at": {
|
|
"type": "string"
|
|
},
|
|
"zipcode": {
|
|
"type": "string",
|
|
"example": "99686"
|
|
}
|
|
}
|
|
},
|
|
"signup.SignupRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"account": {
|
|
"type": "object",
|
|
"required": [
|
|
"name",
|
|
"address1",
|
|
"city",
|
|
"region",
|
|
"country",
|
|
"zipcode"
|
|
],
|
|
"properties": {
|
|
"address1": {
|
|
"type": "string",
|
|
"example": "221 Tatitlek Ave"
|
|
},
|
|
"address2": {
|
|
"type": "string",
|
|
"example": "Box #1832"
|
|
},
|
|
"city": {
|
|
"type": "string",
|
|
"example": "Valdez"
|
|
},
|
|
"country": {
|
|
"type": "string",
|
|
"example": "USA"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Company {RANDOM_UUID}"
|
|
},
|
|
"region": {
|
|
"type": "string",
|
|
"example": "AK"
|
|
},
|
|
"timezone": {
|
|
"type": "string",
|
|
"example": "America/Anchorage"
|
|
},
|
|
"zipcode": {
|
|
"type": "string",
|
|
"example": "99686"
|
|
}
|
|
}
|
|
},
|
|
"user": {
|
|
"type": "object",
|
|
"required": [
|
|
"name",
|
|
"email",
|
|
"password"
|
|
],
|
|
"properties": {
|
|
"email": {
|
|
"type": "string",
|
|
"example": "{RANDOM_EMAIL}"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Gabi May"
|
|
},
|
|
"password": {
|
|
"type": "string",
|
|
"example": "SecretString"
|
|
},
|
|
"password_confirm": {
|
|
"type": "string",
|
|
"example": "SecretString"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"signup.SignupResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"account": {
|
|
"type": "object",
|
|
"$ref": "#/definitions/account.Account"
|
|
},
|
|
"user": {
|
|
"type": "object",
|
|
"$ref": "#/definitions/user.User"
|
|
}
|
|
}
|
|
},
|
|
"user.Token": {
|
|
"type": "object",
|
|
"properties": {
|
|
"access_token": {
|
|
"type": "string"
|
|
},
|
|
"expiry": {
|
|
"type": "string"
|
|
},
|
|
"token_type": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"user.User": {
|
|
"type": "object",
|
|
"required": [
|
|
"name"
|
|
],
|
|
"properties": {
|
|
"archived_at": {
|
|
"type": "string"
|
|
},
|
|
"created_at": {
|
|
"type": "string"
|
|
},
|
|
"email": {
|
|
"type": "string",
|
|
"example": "gabi@geeksinthewoods.com"
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"example": "d69bdef7-173f-4d29-b52c-3edc60baf6a2"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"example": "Gabi May"
|
|
},
|
|
"timezone": {
|
|
"type": "string",
|
|
"example": "America/Anchorage"
|
|
},
|
|
"updated_at": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"web.Error": {
|
|
"type": "object",
|
|
"properties": {
|
|
"err": {
|
|
"type": "error"
|
|
},
|
|
"fields": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "FieldError"
|
|
}
|
|
},
|
|
"status": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"securityDefinitions": {
|
|
"BasicAuth": {
|
|
"type": "basic"
|
|
},
|
|
"OAuth2Password": {
|
|
"type": "oauth2",
|
|
"flow": "password",
|
|
"tokenUrl": "/v1/oauth/token",
|
|
"scopes": {
|
|
"admin": " Grants read and write access to administrative information",
|
|
"read": " Grants read access",
|
|
"write": " Grants write access"
|
|
}
|
|
}
|
|
}
|
|
}`
|
|
|
|
type swaggerInfo struct {
|
|
Version string
|
|
Host string
|
|
BasePath string
|
|
Title string
|
|
Description string
|
|
}
|
|
|
|
// SwaggerInfo holds exported Swagger Info so clients can modify it
|
|
var SwaggerInfo swaggerInfo
|
|
|
|
type s struct{}
|
|
|
|
func (s *s) ReadDoc() string {
|
|
t, err := template.New("swagger_info").Parse(doc)
|
|
if err != nil {
|
|
return doc
|
|
}
|
|
|
|
var tpl bytes.Buffer
|
|
if err := t.Execute(&tpl, SwaggerInfo); err != nil {
|
|
return doc
|
|
}
|
|
|
|
return tpl.String()
|
|
}
|
|
|
|
func init() {
|
|
swag.Register(swag.Name, &s{})
|
|
}
|