aboutsummaryrefslogtreecommitdiff
path: root/docs/docs.go
diff options
context:
space:
mode:
Diffstat (limited to 'docs/docs.go')
-rw-r--r--docs/docs.go182
1 files changed, 182 insertions, 0 deletions
diff --git a/docs/docs.go b/docs/docs.go
new file mode 100644
index 0000000..95e9128
--- /dev/null
+++ b/docs/docs.go
@@ -0,0 +1,182 @@
+// Package docs GENERATED BY SWAG; DO NOT EDIT
+// This file was generated by swaggo/swag
+package docs
+
+import "github.com/swaggo/swag"
+
+const docTemplate = `{
+ "schemes": {{ marshal .Schemes }},
+ "swagger": "2.0",
+ "info": {
+ "description": "{{escape .Description}}",
+ "title": "{{.Title}}",
+ "contact": {
+ "name": "Mitchell Riedstra",
+ "url": "https://riedstra.dev",
+ "email": "mitch@riedstra.dev"
+ },
+ "license": {
+ "name": "ISC"
+ },
+ "version": "{{.Version}}"
+ },
+ "host": "{{.Host}}",
+ "basePath": "{{.BasePath}}",
+ "paths": {
+ "/v0/del/{id}": {
+ "delete": {
+ "description": "Remove a paste from the filesystem",
+ "produces": [
+ "text/plain"
+ ],
+ "tags": [
+ "v0"
+ ],
+ "summary": "Deletes a paste for a given ID",
+ "parameters": [
+ {
+ "type": "string",
+ "description": "Paste ID",
+ "name": "id",
+ "in": "path",
+ "required": true
+ }
+ ],
+ "responses": {}
+ }
+ },
+ "/v0/view/{id}": {
+ "get": {
+ "description": "Fetches the contents of a paste if given an ID",
+ "produces": [
+ "text/plain"
+ ],
+ "tags": [
+ "v0"
+ ],
+ "summary": "View a paste for a given ID",
+ "parameters": [
+ {
+ "type": "string",
+ "description": "Paste ID",
+ "name": "id",
+ "in": "path",
+ "required": true
+ }
+ ],
+ "responses": {}
+ }
+ },
+ "/v1/del/{id}": {
+ "delete": {
+ "description": "Remove a paste from the filesystem",
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "v1"
+ ],
+ "summary": "Deletes a paste for a given ID",
+ "parameters": [
+ {
+ "type": "string",
+ "description": "Paste ID",
+ "name": "id",
+ "in": "path",
+ "required": true
+ }
+ ],
+ "responses": {}
+ }
+ },
+ "/v1/getToken": {
+ "post": {
+ "description": "Returns an API key that's valid for a pre-determined amount of hours",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "v1"
+ ],
+ "summary": "Get an API key with valid credentials",
+ "parameters": [
+ {
+ "description": "User Credentials",
+ "name": "request",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/main.Credentials"
+ }
+ }
+ ],
+ "responses": {}
+ }
+ },
+ "/v1/view/{id}": {
+ "get": {
+ "description": "Fetches the contents of a paste if given an ID",
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "v1"
+ ],
+ "summary": "View a paste for a given ID",
+ "parameters": [
+ {
+ "type": "string",
+ "description": "Paste ID",
+ "name": "id",
+ "in": "path",
+ "required": true
+ }
+ ],
+ "responses": {}
+ }
+ }
+ },
+ "definitions": {
+ "main.Credentials": {
+ "description": "User's credentials",
+ "type": "object",
+ "properties": {
+ "Password": {
+ "type": "string"
+ },
+ "Username": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "securityDefinitions": {
+ "": {
+ "type": "apiKey",
+ "name": "Authorization",
+ "in": "header"
+ },
+ "BasicAuth": {
+ "type": "basic"
+ }
+ }
+}`
+
+// SwaggerInfo holds exported Swagger Info so clients can modify it
+var SwaggerInfo = &swag.Spec{
+ Version: "1.0",
+ Host: "",
+ BasePath: "/api",
+ Schemes: []string{},
+ Title: "Simple Pastebin API",
+ Description: "User's credentials",
+ InfoInstanceName: "swagger",
+ SwaggerTemplate: docTemplate,
+}
+
+func init() {
+ swag.Register(SwaggerInfo.InstanceName(), SwaggerInfo)
+}