barbercollie/tinyauth
1
0
Fork 1
mirror of https://github.com/steveiliop56/tinyauth.git synced 2025-10-30 21:55:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

wip

Browse Source
This commit is contained in:
Stavros
2025-03-15 17:06:06 +02:00
parent 52f189563b
commit 07b57fb0ca
14 changed files with 590 additions and 273 deletions
Download Patch File Download Diff File Expand all files Collapse all files

92
docs/docs.go Normal file
View File

@@ -0,0 +1,92 @@
// Package docs Code generated by swaggo/swag. DO NOT EDIT
package docs
import "github.com/swaggo/swag"
const docTemplate = `{
"schemes": {{ marshal .Schemes }},
"swagger": "2.0",
"info": {
"description": "{{escape .Description}}",
"title": "{{.Title}}",
"contact": {},
"version": "{{.Version}}"
},
"host": "{{.Host}}",
"basePath": "{{.BasePath}}",
"paths": {
"/auth/logout": {
"get": {
"description": "Log the user out by invalidating the session cookie",
"produces": [
"application/json"
],
"tags": [
"auth"
],
"summary": "Logout",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/types.SimpleResponse"
}
}
}
}
},
"/healthcheck": {
"get": {
"description": "Simple health check",
"produces": [
"application/json"
],
"tags": [
"health"
],
"summary": "Health Check",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/types.SimpleResponse"
}
}
}
}
}
},
"definitions": {
"types.SimpleResponse": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "OK"
},
"status": {
"type": "integer",
"example": 200
}
}
}
}
}`
// SwaggerInfo holds exported Swagger Info so clients can modify it
var SwaggerInfo = &swag.Spec{
Version: "1.0",
Host: "",
BasePath: "/api",
Schemes: []string{},
Title: "Tinyauth API",
Description: "Documentation for the Tinyauth API",
InfoInstanceName: "swagger",
SwaggerTemplate: docTemplate,
LeftDelim: "{{",
RightDelim: "}}",
}
func init() {
swag.Register(SwaggerInfo.InstanceName(), SwaggerInfo)
}

67
docs/swagger.json Normal file
View File

@@ -0,0 +1,67 @@
{
"swagger": "2.0",
"info": {
"description": "Documentation for the Tinyauth API",
"title": "Tinyauth API",
"contact": {},
"version": "1.0"
},
"basePath": "/api",
"paths": {
"/auth/logout": {
"get": {
"description": "Log the user out by invalidating the session cookie",
"produces": [
"application/json"
],
"tags": [
"auth"
],
"summary": "Logout",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/types.SimpleResponse"
}
}
}
}
},
"/healthcheck": {
"get": {
"description": "Simple health check",
"produces": [
"application/json"
],
"tags": [
"health"
],
"summary": "Health Check",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/types.SimpleResponse"
}
}
}
}
}
},
"definitions": {
"types.SimpleResponse": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "OK"
},
"status": {
"type": "integer",
"example": 200
}
}
}
}
}

44
docs/swagger.yaml Normal file
View File

@@ -0,0 +1,44 @@
basePath: /api
definitions:
types.SimpleResponse:
properties:
message:
example: OK
type: string
status:
example: 200
type: integer
type: object
info:
contact: {}
description: Documentation for the Tinyauth API
title: Tinyauth API
version: "1.0"
paths:
/auth/logout:
get:
description: Log the user out by invalidating the session cookie
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/types.SimpleResponse'
summary: Logout
tags:
- auth
/healthcheck:
get:
description: Simple health check
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/types.SimpleResponse'
summary: Health Check
tags:
- health
swagger: "2.0"