go/golang-saas-starter-kit
1
0
Fork 0
mirror of https://github.com/raseels-repos/golang-saas-starter-kit.git synced 2025-06-06 23:46:29 +02:00
Code Issues Releases Activity
golang-saas-starter-kit/example-project/cmd/web-api/docs/docs.go

2211 lines
74 KiB
Go
Raw Normal View History

authenticator storage engines Created a storage interface used by authenticator to support multiple types of storage types for private keys. Added a new file storage engine which is now the default for web-api. Migrated aws secrets manager to be optional.
2019-06-24 17:36:42 -08:00
// GENERATED BY THE COMMAND ABOVE; DO NOT EDIT
// This file was generated by swaggo/swag at
checkpoint
2019-07-07 12:52:55 -08:00
// 2019-06-27 04:56:45.692511 -0800 AKDT m=+325.727343639
authenticator storage engines Created a storage interface used by authenticator to support multiple types of storage types for private keys. Added a new file storage engine which is now the default for web-api. Migrated aws secrets manager to be optional.
2019-06-24 17:36:42 -08:00
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",
Completed signup package and hooked up to web-api. Can use the swagger ui to signup a new account.
2019-06-25 02:40:29 -08:00
"termsOfService": "http://example.com/terms",
authenticator storage engines Created a storage interface used by authenticator to support multiple types of storage types for private keys. Added a new file storage engine which is now the default for web-api. Migrated aws secrets manager to be optional.
2019-06-24 17:36:42 -08:00
"contact": {
"name": "API Support",
Completed signup package and hooked up to web-api. Can use the swagger ui to signup a new account.
2019-06-25 02:40:29 -08:00
"url": "http://example.com/support",
authenticator storage engines Created a storage interface used by authenticator to support multiple types of storage types for private keys. Added a new file storage engine which is now the default for web-api. Migrated aws secrets manager to be optional.
2019-06-24 17:36:42 -08:00
"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}}",
fixed internal package unittests
2019-06-24 22:41:21 -08:00
"paths": {
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"/accounts": {
"patch": {
"security": [
{
"OAuth2Password": []
}
],
"description": "Update updates the specified account in the system.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"account"
],
"summary": "Update account by ID",
"parameters": [
{
"description": "Update fields",
"name": "data",
"in": "body",
"required": true,
"schema": {
"type": "object",
"$ref": "#/definitions/account.AccountUpdateRequest"
}
}
],
"responses": {
checkpoint
2019-07-07 12:52:55 -08:00
"204": {},
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"400": {
"description": "Bad Request",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
},
"403": {
"description": "Forbidden",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
}
}
}
},
fixed internal package unittests
2019-06-24 22:41:21 -08:00
"/accounts/{id}": {
"get": {
completed API from signup to auth token with swagger UI.
2019-06-25 06:25:55 -08:00
"security": [
{
"OAuth2Password": []
}
],
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"description": "Read returns the specified account from the system.",
fixed internal package unittests
2019-06-24 22:41:21 -08:00
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
Completed signup package and hooked up to web-api. Can use the swagger ui to signup a new account.
2019-06-25 02:40:29 -08:00
"tags": [
"account"
],
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"summary": "Get account by ID",
fixed internal package unittests
2019-06-24 22:41:21 -08:00
"parameters": [
{
completed API from signup to auth token with swagger UI.
2019-06-25 06:25:55 -08:00
"type": "string",
fixed internal package unittests
2019-06-24 22:41:21 -08:00
"description": "Account ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"$ref": "#/definitions/account.AccountResponse"
fixed internal package unittests
2019-06-24 22:41:21 -08:00
}
},
"400": {
"description": "Bad Request",
"schema": {
"type": "object",
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"$ref": "#/definitions/web.ErrorResponse"
fixed internal package unittests
2019-06-24 22:41:21 -08:00
}
},
"404": {
"description": "Not Found",
"schema": {
"type": "object",
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"$ref": "#/definitions/web.ErrorResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
fixed internal package unittests
2019-06-24 22:41:21 -08:00
}
}
}
}
Completed signup package and hooked up to web-api. Can use the swagger ui to signup a new account.
2019-06-25 02:40:29 -08:00
},
completed API from signup to auth token with swagger UI.
2019-06-25 06:25:55 -08:00
"/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.",
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"parameters": [
{
"enum": [
"user",
"admin"
],
"type": "string",
"description": "Scope",
"name": "scope",
"in": "query"
}
],
completed API from signup to auth token with swagger UI.
2019-06-25 06:25:55 -08:00
"responses": {
checkpoint
2019-07-07 12:52:55 -08:00
"200": {},
completed API from signup to auth token with swagger UI.
2019-06-25 06:25:55 -08:00
"400": {
"description": "Bad Request",
"schema": {
"type": "object",
checkpoint
2019-07-07 12:52:55 -08:00
"$ref": "#/definitions/web.ErrorResponse"
completed API from signup to auth token with swagger UI.
2019-06-25 06:25:55 -08:00
}
},
checkpoint
2019-07-07 12:52:55 -08:00
"401": {
"description": "Unauthorized",
completed API from signup to auth token with swagger UI.
2019-06-25 06:25:55 -08:00
"schema": {
"type": "object",
checkpoint
2019-07-07 12:52:55 -08:00
"$ref": "#/definitions/web.ErrorResponse"
completed API from signup to auth token with swagger UI.
2019-06-25 06:25:55 -08:00
}
},
checkpoint
2019-07-07 12:52:55 -08:00
"500": {
"description": "Internal Server Error",
completed API from signup to auth token with swagger UI.
2019-06-25 06:25:55 -08:00
"schema": {
"type": "object",
checkpoint
2019-07-07 12:52:55 -08:00
"$ref": "#/definitions/web.ErrorResponse"
completed API from signup to auth token with swagger UI.
2019-06-25 06:25:55 -08:00
}
}
}
}
},
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"/project": {
"get": {
"security": [
{
"OAuth2Password": []
}
],
"description": "Find returns the existing projects in the system.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"project"
],
"summary": "List projects",
"parameters": [
{
"type": "string",
"description": "Filter string, example: name = 'Moon Launch'",
"name": "where",
"in": "query"
},
{
"type": "string",
"description": "Order columns separated by comma, example: created_at desc",
"name": "order",
"in": "query"
},
{
"type": "integer",
"description": "Limit, example: 10",
"name": "limit",
"in": "query"
},
{
"type": "integer",
"description": "Offset, example: 20",
"name": "offset",
"in": "query"
},
{
"type": "boolean",
"description": "Included Archived, example: false",
"name": "included-archived",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/project.ProjectResponse"
}
}
},
"400": {
"description": "Bad Request",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
},
"403": {
"description": "Forbidden",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
}
}
}
},
"/projects": {
Completed signup package and hooked up to web-api. Can use the swagger ui to signup a new account.
2019-06-25 02:40:29 -08:00
"post": {
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"security": [
{
"OAuth2Password": []
}
],
"description": "Create inserts a new project into the system.",
Completed signup package and hooked up to web-api. Can use the swagger ui to signup a new account.
2019-06-25 02:40:29 -08:00
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"project"
Completed signup package and hooked up to web-api. Can use the swagger ui to signup a new account.
2019-06-25 02:40:29 -08:00
],
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"summary": "Create new project.",
Completed signup package and hooked up to web-api. Can use the swagger ui to signup a new account.
2019-06-25 02:40:29 -08:00
"parameters": [
{
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"description": "Project details",
Completed signup package and hooked up to web-api. Can use the swagger ui to signup a new account.
2019-06-25 02:40:29 -08:00
"name": "data",
"in": "body",
"required": true,
"schema": {
"type": "object",
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"$ref": "#/definitions/project.ProjectCreateRequest"
Completed signup package and hooked up to web-api. Can use the swagger ui to signup a new account.
2019-06-25 02:40:29 -08:00
}
}
],
"responses": {
checkpoint
2019-07-07 12:52:55 -08:00
"201": {
"description": "Created",
Completed signup package and hooked up to web-api. Can use the swagger ui to signup a new account.
2019-06-25 02:40:29 -08:00
"schema": {
"type": "object",
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"$ref": "#/definitions/project.ProjectResponse"
Completed signup package and hooked up to web-api. Can use the swagger ui to signup a new account.
2019-06-25 02:40:29 -08:00
}
},
"400": {
"description": "Bad Request",
"schema": {
"type": "object",
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"$ref": "#/definitions/web.ErrorResponse"
Completed signup package and hooked up to web-api. Can use the swagger ui to signup a new account.
2019-06-25 02:40:29 -08:00
}
},
"403": {
"description": "Forbidden",
"schema": {
"type": "object",
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"$ref": "#/definitions/web.ErrorResponse"
}
},
"404": {
"description": "Not Found",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
Completed signup package and hooked up to web-api. Can use the swagger ui to signup a new account.
2019-06-25 02:40:29 -08:00
}
}
}
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
},
"patch": {
completed API from signup to auth token with swagger UI.
2019-06-25 06:25:55 -08:00
"security": [
{
"OAuth2Password": []
}
],
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"description": "Update updates the specified project in the system.",
Completed signup package and hooked up to web-api. Can use the swagger ui to signup a new account.
2019-06-25 02:40:29 -08:00
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"project"
Completed signup package and hooked up to web-api. Can use the swagger ui to signup a new account.
2019-06-25 02:40:29 -08:00
],
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"summary": "Update project by ID",
Completed signup package and hooked up to web-api. Can use the swagger ui to signup a new account.
2019-06-25 02:40:29 -08:00
"parameters": [
{
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"description": "Update fields",
"name": "data",
"in": "body",
"required": true,
"schema": {
"type": "object",
"$ref": "#/definitions/project.ProjectUpdateRequest"
}
Completed signup package and hooked up to web-api. Can use the swagger ui to signup a new account.
2019-06-25 02:40:29 -08:00
}
],
"responses": {
checkpoint
2019-07-07 12:52:55 -08:00
"204": {},
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"400": {
"description": "Bad Request",
Completed signup package and hooked up to web-api. Can use the swagger ui to signup a new account.
2019-06-25 02:40:29 -08:00
"schema": {
"type": "object",
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"$ref": "#/definitions/web.ErrorResponse"
}
},
"403": {
"description": "Forbidden",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
}
}
}
},
"/projects/archive": {
"patch": {
"security": [
{
"OAuth2Password": []
}
],
"description": "Archive soft-deletes the specified project from the system.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"project"
],
"summary": "Archive project by ID",
"parameters": [
{
"description": "Update fields",
"name": "data",
"in": "body",
"required": true,
"schema": {
"type": "object",
"$ref": "#/definitions/project.ProjectArchiveRequest"
}
}
],
"responses": {
checkpoint
2019-07-07 12:52:55 -08:00
"204": {},
Completed signup package and hooked up to web-api. Can use the swagger ui to signup a new account.
2019-06-25 02:40:29 -08:00
"400": {
"description": "Bad Request",
"schema": {
"type": "object",
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"$ref": "#/definitions/web.ErrorResponse"
Completed signup package and hooked up to web-api. Can use the swagger ui to signup a new account.
2019-06-25 02:40:29 -08:00
}
},
"403": {
"description": "Forbidden",
"schema": {
"type": "object",
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"$ref": "#/definitions/web.ErrorResponse"
Completed signup package and hooked up to web-api. Can use the swagger ui to signup a new account.
2019-06-25 02:40:29 -08:00
}
},
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"500": {
"description": "Internal Server Error",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
Completed signup package and hooked up to web-api. Can use the swagger ui to signup a new account.
2019-06-25 02:40:29 -08:00
}
}
}
}
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
},
"/projects/{id}": {
"get": {
"security": [
{
"OAuth2Password": []
}
],
"description": "Read returns the specified project from the system.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"project"
],
"summary": "Get project by ID.",
"parameters": [
{
"type": "string",
"description": "Project ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"$ref": "#/definitions/project.ProjectResponse"
}
},
"400": {
"description": "Bad Request",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
},
"404": {
"description": "Not Found",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
}
}
},
"delete": {
"security": [
{
"OAuth2Password": []
}
],
"description": "Delete removes the specified project from the system.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"project"
],
"summary": "Delete project by ID",
"parameters": [
{
"type": "string",
"description": "Project ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
checkpoint
2019-07-07 12:52:55 -08:00
"204": {},
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"400": {
"description": "Bad Request",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
},
"403": {
"description": "Forbidden",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
}
}
}
},
"/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": {
checkpoint
2019-07-07 12:52:55 -08:00
"201": {
"description": "Created",
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"schema": {
"type": "object",
"$ref": "#/definitions/signup.SignupResponse"
}
},
"400": {
"description": "Bad Request",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
}
}
}
},
checkpoint
2019-07-07 12:52:55 -08:00
"/user_accounts": {
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"get": {
"security": [
{
"OAuth2Password": []
}
],
checkpoint
2019-07-07 12:52:55 -08:00
"description": "Find returns the existing user accounts in the system.",
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
checkpoint
2019-07-07 12:52:55 -08:00
"user_account"
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
],
checkpoint
2019-07-07 12:52:55 -08:00
"summary": "List user accounts",
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"parameters": [
{
"type": "string",
checkpoint
2019-07-07 12:52:55 -08:00
"description": "Filter string, example: account_id = 'c4653bf9-5978-48b7-89c5-95704aebb7e2'",
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"name": "where",
"in": "query"
},
{
"type": "string",
"description": "Order columns separated by comma, example: created_at desc",
"name": "order",
"in": "query"
},
{
"type": "integer",
"description": "Limit, example: 10",
"name": "limit",
"in": "query"
},
{
"type": "integer",
"description": "Offset, example: 20",
"name": "offset",
"in": "query"
},
{
"type": "boolean",
"description": "Included Archived, example: false",
"name": "included-archived",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
checkpoint
2019-07-07 12:52:55 -08:00
"$ref": "#/definitions/user_account.UserAccountResponse"
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
}
}
},
"400": {
"description": "Bad Request",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
},
"403": {
"description": "Forbidden",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
}
}
},
"post": {
"security": [
{
"OAuth2Password": []
}
],
checkpoint
2019-07-07 12:52:55 -08:00
"description": "Create inserts a new user account into the system.",
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
checkpoint
2019-07-07 12:52:55 -08:00
"user_account"
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
],
checkpoint
2019-07-07 12:52:55 -08:00
"summary": "Create new user account.",
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"parameters": [
{
checkpoint
2019-07-07 12:52:55 -08:00
"description": "User Account details",
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"name": "data",
"in": "body",
"required": true,
"schema": {
"type": "object",
checkpoint
2019-07-07 12:52:55 -08:00
"$ref": "#/definitions/user_account.UserAccountCreateRequest"
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
}
}
],
"responses": {
checkpoint
2019-07-07 12:52:55 -08:00
"201": {
"description": "Created",
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"schema": {
"type": "object",
checkpoint
2019-07-07 12:52:55 -08:00
"$ref": "#/definitions/user_account.UserAccountResponse"
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
}
},
"400": {
"description": "Bad Request",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
},
"403": {
"description": "Forbidden",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
},
"404": {
"description": "Not Found",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
}
}
},
checkpoint
2019-07-07 12:52:55 -08:00
"delete": {
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"security": [
{
"OAuth2Password": []
}
],
checkpoint
2019-07-07 12:52:55 -08:00
"description": "Delete removes the specified user account from the system.",
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"user"
],
checkpoint
2019-07-07 12:52:55 -08:00
"summary": "Delete user account by user ID and account ID",
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"parameters": [
{
checkpoint
2019-07-07 12:52:55 -08:00
"type": "string",
"description": "UserAccount ID",
"name": "id",
"in": "path",
"required": true
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
}
],
"responses": {
checkpoint
2019-07-07 12:52:55 -08:00
"204": {},
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"400": {
"description": "Bad Request",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
},
"403": {
"description": "Forbidden",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
}
}
checkpoint
2019-07-07 12:52:55 -08:00
},
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"patch": {
"security": [
{
"OAuth2Password": []
}
],
checkpoint
2019-07-07 12:52:55 -08:00
"description": "Update updates the specified user account in the system.",
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"user"
],
checkpoint
2019-07-07 12:52:55 -08:00
"summary": "Update user account by user ID and account ID",
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"parameters": [
{
"description": "Update fields",
"name": "data",
"in": "body",
"required": true,
"schema": {
"type": "object",
checkpoint
2019-07-07 12:52:55 -08:00
"$ref": "#/definitions/user_account.UserAccountUpdateRequest"
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
}
}
],
"responses": {
checkpoint
2019-07-07 12:52:55 -08:00
"204": {},
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"400": {
"description": "Bad Request",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
},
"403": {
"description": "Forbidden",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
}
}
}
},
checkpoint
2019-07-07 12:52:55 -08:00
"/user_accounts/archive": {
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"patch": {
"security": [
{
"OAuth2Password": []
}
],
checkpoint
2019-07-07 12:52:55 -08:00
"description": "Archive soft-deletes the specified user account from the system.",
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"user"
],
checkpoint
2019-07-07 12:52:55 -08:00
"summary": "Archive user account by user ID and account ID",
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"parameters": [
{
"description": "Update fields",
"name": "data",
"in": "body",
"required": true,
"schema": {
"type": "object",
checkpoint
2019-07-07 12:52:55 -08:00
"$ref": "#/definitions/user_account.UserAccountArchiveRequest"
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
}
}
],
"responses": {
checkpoint
2019-07-07 12:52:55 -08:00
"204": {},
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"400": {
"description": "Bad Request",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
},
"403": {
"description": "Forbidden",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
}
}
}
},
checkpoint
2019-07-07 12:52:55 -08:00
"/user_accounts/{id}": {
"get": {
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"security": [
{
"OAuth2Password": []
}
],
checkpoint
2019-07-07 12:52:55 -08:00
"description": "Read returns the specified user account from the system.",
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
checkpoint
2019-07-07 12:52:55 -08:00
"user_account"
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
],
checkpoint
2019-07-07 12:52:55 -08:00
"summary": "Get user account by ID",
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"parameters": [
{
checkpoint
2019-07-07 12:52:55 -08:00
"type": "string",
"description": "UserAccount ID",
"name": "id",
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"in": "path",
"required": true
}
],
"responses": {
checkpoint
2019-07-07 12:52:55 -08:00
"200": {
"description": "OK",
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"schema": {
"type": "object",
checkpoint
2019-07-07 12:52:55 -08:00
"$ref": "#/definitions/user_account.UserAccountResponse"
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
}
},
checkpoint
2019-07-07 12:52:55 -08:00
"400": {
"description": "Bad Request",
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
},
"404": {
"description": "Not Found",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
}
}
}
},
checkpoint
2019-07-07 12:52:55 -08:00
"/users": {
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"get": {
"security": [
{
"OAuth2Password": []
}
],
checkpoint
2019-07-07 12:52:55 -08:00
"description": "Find returns the existing users in the system.",
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"user"
],
checkpoint
2019-07-07 12:52:55 -08:00
"summary": "List users",
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"parameters": [
{
"type": "string",
checkpoint
2019-07-07 12:52:55 -08:00
"description": "Filter string, example: name = 'Company Name' and email = 'gabi.may@geeksinthewoods.com'",
"name": "where",
"in": "query"
},
{
"type": "string",
"description": "Order columns separated by comma, example: created_at desc",
"name": "order",
"in": "query"
},
{
"type": "integer",
"description": "Limit, example: 10",
"name": "limit",
"in": "query"
},
{
"type": "integer",
"description": "Offset, example: 20",
"name": "offset",
"in": "query"
},
{
"type": "boolean",
"description": "Included Archived, example: false",
"name": "included-archived",
"in": "query"
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
checkpoint
2019-07-07 12:52:55 -08:00
"type": "array",
"items": {
"$ref": "#/definitions/user.UserResponse"
}
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
}
},
"400": {
"description": "Bad Request",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
}
}
},
checkpoint
2019-07-07 12:52:55 -08:00
"post": {
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"security": [
{
"OAuth2Password": []
}
],
checkpoint
2019-07-07 12:52:55 -08:00
"description": "Create inserts a new user into the system.",
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"user"
],
checkpoint
2019-07-07 12:52:55 -08:00
"summary": "Create new user.",
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"parameters": [
{
checkpoint
2019-07-07 12:52:55 -08:00
"description": "User details",
"name": "data",
"in": "body",
"required": true,
"schema": {
"type": "object",
"$ref": "#/definitions/user.UserCreateRequest"
}
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
}
],
"responses": {
checkpoint
2019-07-07 12:52:55 -08:00
"201": {
"description": "Created",
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"schema": {
"type": "object",
checkpoint
2019-07-07 12:52:55 -08:00
"$ref": "#/definitions/user.UserResponse"
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
}
},
checkpoint
2019-07-07 12:52:55 -08:00
"400": {
"description": "Bad Request",
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
},
checkpoint
2019-07-07 12:52:55 -08:00
"403": {
"description": "Forbidden",
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
}
}
checkpoint
2019-07-07 12:52:55 -08:00
},
"patch": {
"security": [
{
"OAuth2Password": []
}
],
"description": "Update updates the specified user in the system.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "Update user by ID",
"parameters": [
{
"description": "Update fields",
"name": "data",
"in": "body",
"required": true,
"schema": {
"type": "object",
"$ref": "#/definitions/user.UserUpdateRequest"
}
}
],
"responses": {
"204": {},
"400": {
"description": "Bad Request",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
},
"403": {
"description": "Forbidden",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
}
}
}
},
"/users/archive": {
"patch": {
"security": [
{
"OAuth2Password": []
}
],
"description": "Archive soft-deletes the specified user from the system.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "Archive user by ID",
"parameters": [
{
"description": "Update fields",
"name": "data",
"in": "body",
"required": true,
"schema": {
"type": "object",
"$ref": "#/definitions/user.UserArchiveRequest"
}
}
],
"responses": {
"204": {},
"400": {
"description": "Bad Request",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
},
"403": {
"description": "Forbidden",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
}
}
}
},
"/users/password": {
"patch": {
"security": [
{
"OAuth2Password": []
}
],
"description": "Update updates the password for a specified user in the system.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "Update user password by ID",
"parameters": [
{
"description": "Update fields",
"name": "data",
"in": "body",
"required": true,
"schema": {
"type": "object",
"$ref": "#/definitions/user.UserUpdatePasswordRequest"
}
}
],
"responses": {
"204": {},
"400": {
"description": "Bad Request",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
},
"403": {
"description": "Forbidden",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
}
}
}
},
"/users/switch-account/{account_id}": {
"patch": {
"security": [
{
"OAuth2Password": []
}
],
"description": "SwitchAccount updates the auth claims to a new account.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "Switch account.",
"parameters": [
{
"type": "integer",
"description": "Account ID",
"name": "account_id",
"in": "path",
"required": true
}
],
"responses": {
"200": {},
"400": {
"description": "Bad Request",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
}
}
}
},
"/users/{id}": {
"get": {
"security": [
{
"OAuth2Password": []
}
],
"description": "Read returns the specified user from the system.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "Get user by ID",
"parameters": [
{
"type": "string",
"description": "User ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"$ref": "#/definitions/user.UserResponse"
}
},
"400": {
"description": "Bad Request",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
},
"404": {
"description": "Not Found",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
}
}
},
"delete": {
"security": [
{
"OAuth2Password": []
}
],
"description": "Delete removes the specified user from the system.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"user"
],
"summary": "Delete user by ID",
"parameters": [
{
"type": "string",
"description": "User ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"204": {},
"400": {
"description": "Bad Request",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
},
"403": {
"description": "Forbidden",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"type": "object",
"$ref": "#/definitions/web.ErrorResponse"
}
}
}
}
}
},
"definitions": {
"account.AccountResponse": {
"type": "object",
"properties": {
"address1": {
"type": "string",
"example": "221 Tatitlek Ave"
},
"address2": {
"type": "string",
"example": "Box #1832"
},
"archived_at": {
"type": "object",
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"$ref": "#/definitions/web.TimeResponse"
},
"billing_user_id": {
"type": "string",
"example": "d69bdef7-173f-4d29-b52c-3edc60baf6a2"
},
"city": {
"type": "string",
"example": "Valdez"
},
"country": {
"type": "string",
"example": "USA"
},
"created_at": {
"type": "object",
"$ref": "#/definitions/web.TimeResponse"
},
"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",
"example": "d69bdef7-173f-4d29-b52c-3edc60baf6a2"
},
"status": {
"type": "object",
"$ref": "#/definitions/web.EnumResponse"
},
"timezone": {
"type": "string",
"example": "America/Anchorage"
},
"updated_at": {
"type": "object",
"$ref": "#/definitions/web.TimeResponse"
},
"zipcode": {
Completed signup package and hooked up to web-api. Can use the swagger ui to signup a new account.
2019-06-25 02:40:29 -08:00
"type": "string",
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"example": "99686"
}
}
},
"account.AccountUpdateRequest": {
"type": "object",
"required": [
"id"
],
"properties": {
"address1": {
"type": "string",
"example": "221 Tatitlek Ave"
fixed internal package unittests
2019-06-24 22:41:21 -08:00
},
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"address2": {
"type": "string",
"example": "Box #1832"
},
"billing_user_id": {
"type": "string",
"example": "d69bdef7-173f-4d29-b52c-3edc60baf6a2"
},
"city": {
"type": "string",
"example": "Valdez"
},
"country": {
"type": "string",
"example": "USA"
fixed internal package unittests
2019-06-24 22:41:21 -08:00
},
"id": {
Completed signup package and hooked up to web-api. Can use the swagger ui to signup a new account.
2019-06-25 02:40:29 -08:00
"type": "string",
"example": "c4653bf9-5978-48b7-89c5-95704aebb7e2"
fixed internal package unittests
2019-06-24 22:41:21 -08:00
},
"name": {
Completed signup package and hooked up to web-api. Can use the swagger ui to signup a new account.
2019-06-25 02:40:29 -08:00
"type": "string",
"example": "Company Name"
fixed internal package unittests
2019-06-24 22:41:21 -08:00
},
"region": {
Completed signup package and hooked up to web-api. Can use the swagger ui to signup a new account.
2019-06-25 02:40:29 -08:00
"type": "string",
"example": "AK"
fixed internal package unittests
2019-06-24 22:41:21 -08:00
},
"signup_user_id": {
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"type": "string",
"example": "d69bdef7-173f-4d29-b52c-3edc60baf6a2"
fixed internal package unittests
2019-06-24 22:41:21 -08:00
},
"status": {
Completed signup package and hooked up to web-api. Can use the swagger ui to signup a new account.
2019-06-25 02:40:29 -08:00
"type": "string",
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"enum": [
"active",
"pending",
"disabled"
],
"example": "disabled"
fixed internal package unittests
2019-06-24 22:41:21 -08:00
},
"timezone": {
Completed signup package and hooked up to web-api. Can use the swagger ui to signup a new account.
2019-06-25 02:40:29 -08:00
"type": "string",
"example": "America/Anchorage"
fixed internal package unittests
2019-06-24 22:41:21 -08:00
},
"zipcode": {
Completed signup package and hooked up to web-api. Can use the swagger ui to signup a new account.
2019-06-25 02:40:29 -08:00
"type": "string",
"example": "99686"
}
}
},
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"project.ProjectArchiveRequest": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"example": "985f1746-1d9f-459f-a2d9-fc53ece5ae86"
}
}
},
"project.ProjectCreateRequest": {
"type": "object",
"required": [
"account_id",
"name"
],
"properties": {
"account_id": {
"type": "string",
"example": "c4653bf9-5978-48b7-89c5-95704aebb7e2"
},
"name": {
"type": "string",
"example": "Rocket Launch"
},
"status": {
"type": "string",
"enum": [
"active",
"disabled"
],
"example": "active"
}
}
},
"project.ProjectResponse": {
"type": "object",
"required": [
"account_id",
"id",
"name"
],
"properties": {
"account_id": {
"type": "string",
"example": "c4653bf9-5978-48b7-89c5-95704aebb7e2"
},
"archived_at": {
"type": "object",
"$ref": "#/definitions/web.TimeResponse"
},
"created_at": {
"type": "object",
"$ref": "#/definitions/web.TimeResponse"
},
"id": {
"type": "string",
"example": "985f1746-1d9f-459f-a2d9-fc53ece5ae86"
},
"name": {
"type": "string",
"example": "Rocket Launch"
},
"status": {
"type": "object",
"$ref": "#/definitions/web.EnumResponse"
},
"updated_at": {
"type": "object",
"$ref": "#/definitions/web.TimeResponse"
}
}
},
"project.ProjectUpdateRequest": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"example": "985f1746-1d9f-459f-a2d9-fc53ece5ae86"
},
"name": {
"type": "string",
"example": "Rocket Launch to Moon"
},
"status": {
"type": "string",
"enum": [
"active",
"disabled"
],
"example": "disabled"
}
}
},
checkpoint
2019-07-07 12:52:55 -08:00
"signup.SignupAccount": {
"type": "object",
"required": [
"address1",
"city",
"country",
"name",
"region",
"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"
}
}
},
Completed signup package and hooked up to web-api. Can use the swagger ui to signup a new account.
2019-06-25 02:40:29 -08:00
"signup.SignupRequest": {
"type": "object",
"properties": {
"account": {
"type": "object",
checkpoint
2019-07-07 12:52:55 -08:00
"$ref": "#/definitions/signup.SignupAccount"
Completed signup package and hooked up to web-api. Can use the swagger ui to signup a new account.
2019-06-25 02:40:29 -08:00
},
"user": {
"type": "object",
checkpoint
2019-07-07 12:52:55 -08:00
"$ref": "#/definitions/signup.SignupUser"
Completed signup package and hooked up to web-api. Can use the swagger ui to signup a new account.
2019-06-25 02:40:29 -08:00
}
}
},
"signup.SignupResponse": {
"type": "object",
"properties": {
"account": {
checkpoint
2019-07-07 12:52:55 -08:00
"type": "object",
"$ref": "#/definitions/account.AccountResponse"
Completed signup package and hooked up to web-api. Can use the swagger ui to signup a new account.
2019-06-25 02:40:29 -08:00
},
"user": {
checkpoint
2019-07-07 12:52:55 -08:00
"type": "object",
"$ref": "#/definitions/user.UserResponse"
Completed signup package and hooked up to web-api. Can use the swagger ui to signup a new account.
2019-06-25 02:40:29 -08:00
}
}
},
checkpoint
2019-07-07 12:52:55 -08:00
"signup.SignupUser": {
completed API from signup to auth token with swagger UI.
2019-06-25 06:25:55 -08:00
"type": "object",
checkpoint
2019-07-07 12:52:55 -08:00
"required": [
"email",
"name",
"password"
],
completed API from signup to auth token with swagger UI.
2019-06-25 06:25:55 -08:00
"properties": {
checkpoint
2019-07-07 12:52:55 -08:00
"email": {
"type": "string",
"example": "{RANDOM_EMAIL}"
completed API from signup to auth token with swagger UI.
2019-06-25 06:25:55 -08:00
},
checkpoint
2019-07-07 12:52:55 -08:00
"name": {
"type": "string",
"example": "Gabi May"
completed API from signup to auth token with swagger UI.
2019-06-25 06:25:55 -08:00
},
checkpoint
2019-07-07 12:52:55 -08:00
"password": {
"type": "string",
"example": "SecretString"
},
"password_confirm": {
"type": "string",
"example": "SecretString"
completed API from signup to auth token with swagger UI.
2019-06-25 06:25:55 -08:00
}
}
},
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"user.UserArchiveRequest": {
Completed signup package and hooked up to web-api. Can use the swagger ui to signup a new account.
2019-06-25 02:40:29 -08:00
"type": "object",
"required": [
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"id"
],
"properties": {
"id": {
"type": "string",
"example": "d69bdef7-173f-4d29-b52c-3edc60baf6a2"
}
}
},
"user.UserCreateRequest": {
"type": "object",
"required": [
"email",
"name",
"password"
Completed signup package and hooked up to web-api. Can use the swagger ui to signup a new account.
2019-06-25 02:40:29 -08:00
],
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"properties": {
"email": {
"type": "string",
"example": "gabi@geeksinthewoods.com"
},
"name": {
"type": "string",
"example": "Gabi May"
},
"password": {
"type": "string",
"example": "SecretString"
},
"password_confirm": {
"type": "string",
"example": "SecretString"
},
"timezone": {
"type": "string",
"example": "America/Anchorage"
}
}
},
"user.UserResponse": {
"type": "object",
Completed signup package and hooked up to web-api. Can use the swagger ui to signup a new account.
2019-06-25 02:40:29 -08:00
"properties": {
"archived_at": {
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"type": "object",
"$ref": "#/definitions/web.TimeResponse"
Completed signup package and hooked up to web-api. Can use the swagger ui to signup a new account.
2019-06-25 02:40:29 -08:00
},
"created_at": {
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"type": "object",
"$ref": "#/definitions/web.TimeResponse"
Completed signup package and hooked up to web-api. Can use the swagger ui to signup a new account.
2019-06-25 02:40:29 -08:00
},
"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": {
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"type": "object",
"$ref": "#/definitions/web.TimeResponse"
}
}
},
"user.UserUpdatePasswordRequest": {
"type": "object",
"required": [
"id",
"password"
],
"properties": {
"id": {
"type": "string",
"example": "d69bdef7-173f-4d29-b52c-3edc60baf6a2"
},
"password": {
"type": "string",
"example": "NeverTellSecret"
},
"password_confirm": {
"type": "string",
"example": "NeverTellSecret"
}
}
},
"user.UserUpdateRequest": {
"type": "object",
"required": [
"id"
],
"properties": {
"email": {
"type": "string",
"example": "gabi.may@geeksinthewoods.com"
},
"id": {
"type": "string",
"example": "d69bdef7-173f-4d29-b52c-3edc60baf6a2"
},
"name": {
"type": "string",
"example": "Gabi May Not"
},
"timezone": {
"type": "string",
"example": "America/Anchorage"
}
}
},
checkpoint
2019-07-07 12:52:55 -08:00
"user_account.UserAccountArchiveRequest": {
"type": "object",
"required": [
"account_id",
"user_id"
],
"properties": {
"account_id": {
"type": "string",
"example": "c4653bf9-5978-48b7-89c5-95704aebb7e2"
},
"user_id": {
"type": "string",
"example": "d69bdef7-173f-4d29-b52c-3edc60baf6a2"
}
}
},
"user_account.UserAccountCreateRequest": {
"type": "object",
"required": [
"account_id",
"roles",
"user_id"
],
"properties": {
"account_id": {
"type": "string",
"example": "c4653bf9-5978-48b7-89c5-95704aebb7e2"
},
"roles": {
"type": "array",
"items": {
"type": "string",
"enum": [
"admin",
"user"
]
},
"example": [
"admin"
]
},
"status": {
"type": "string",
"enum": [
"active",
"invited",
"disabled"
],
"example": "active"
},
"user_id": {
"type": "string",
"example": "d69bdef7-173f-4d29-b52c-3edc60baf6a2"
}
}
},
"user_account.UserAccountResponse": {
"type": "object",
"required": [
"roles"
],
"properties": {
"account_id": {
"type": "string",
"example": "c4653bf9-5978-48b7-89c5-95704aebb7e2"
},
"archived_at": {
"type": "object",
"$ref": "#/definitions/web.TimeResponse"
},
"created_at": {
"type": "object",
"$ref": "#/definitions/web.TimeResponse"
},
"id": {
"type": "string",
"example": "d69bdef7-173f-4d29-b52c-3edc60baf6a2"
},
"roles": {
"type": "array",
"items": {
"type": "string",
"enum": [
"admin",
"user"
]
},
"example": [
"admin"
]
},
"status": {
"type": "object",
"$ref": "#/definitions/web.EnumResponse"
},
"updated_at": {
"type": "object",
"$ref": "#/definitions/web.TimeResponse"
},
"user_id": {
"type": "string",
"example": "d69bdef7-173f-4d29-b52c-3edc60baf6a2"
}
}
},
"user_account.UserAccountUpdateRequest": {
"type": "object",
"required": [
"account_id",
"user_id"
],
"properties": {
"account_id": {
"type": "string",
"example": "c4653bf9-5978-48b7-89c5-95704aebb7e2"
},
"roles": {
"type": "array",
"items": {
"type": "string",
"enum": [
"admin",
"user"
]
},
"example": [
"user"
]
},
"status": {
"type": "string",
"enum": [
"active",
"invited",
"disabled"
],
"example": "disabled"
},
"user_id": {
"type": "string",
"example": "d69bdef7-173f-4d29-b52c-3edc60baf6a2"
}
}
},
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"web.EnumOption": {
"type": "object",
"properties": {
"selected": {
"type": "boolean",
"example": true
},
"title": {
"type": "string",
"example": "Active Etc"
},
"value": {
"type": "string",
"example": "active_etc"
}
}
},
"web.EnumResponse": {
"type": "object",
"properties": {
"options": {
"type": "array",
"items": {
"$ref": "#/definitions/web.EnumOption"
}
},
"title": {
"type": "string",
"example": "Active Etc"
},
"value": {
"type": "string",
"example": "active_etc"
fixed internal package unittests
2019-06-24 22:41:21 -08:00
}
}
authenticator storage engines Created a storage interface used by authenticator to support multiple types of storage types for private keys. Added a new file storage engine which is now the default for web-api. Migrated aws secrets manager to be optional.
2019-06-24 17:36:42 -08:00
},
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"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": {
"date": {
"type": "string",
"example": "2019-06-25"
},
"kitchen": {
"type": "string",
"example": "3:00AM"
},
"local": {
"type": "string",
"example": "Tue Jun 25 3:00AM"
},
"local_date": {
"type": "string",
"example": "Tue Jun 25"
},
"now_rel_time": {
"type": "string",
"example": "15 hours from now"
},
"now_time": {
"type": "string",
"example": "5 hours ago"
},
"rfc1123": {
"type": "string",
"example": "Tue, 25 Jun 2019 03:00:53 AKDT"
},
"time": {
"type": "string",
"example": "03:00:53"
},
"timezone": {
"type": "string",
"example": "America/Anchorage"
},
"value": {
"type": "string",
"example": "2019-06-25T03:00:53.284-08:00"
},
"value_utc": {
"type": "string",
"example": "2019-06-25T11:00:53.284Z"
}
}
fixed internal package unittests
2019-06-24 22:41:21 -08:00
}
},
"securityDefinitions": {
completed API from signup to auth token with swagger UI.
2019-06-25 06:25:55 -08:00
"BasicAuth": {
"type": "basic"
},
authenticator storage engines Created a storage interface used by authenticator to support multiple types of storage types for private keys. Added a new file storage engine which is now the default for web-api. Migrated aws secrets manager to be optional.
2019-06-24 17:36:42 -08:00
"OAuth2Password": {
"type": "oauth2",
"flow": "password",
completed API from signup to auth token with swagger UI.
2019-06-25 06:25:55 -08:00
"tokenUrl": "/v1/oauth/token",
"scopes": {
Completed API documentation for swagger
2019-06-25 22:31:54 -08:00
"admin": " Grants administrative privileges with role of admin.",
"user": " Grants basic privileges with role of user."
completed API from signup to auth token with swagger UI.
2019-06-25 06:25:55 -08:00
}
authenticator storage engines Created a storage interface used by authenticator to support multiple types of storage types for private keys. Added a new file storage engine which is now the default for web-api. Migrated aws secrets manager to be optional.
2019-06-24 17:36:42 -08:00
}
}
}`
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{})
}
Reference in New Issue Copy Permalink