aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--docs/docs.go39
-rw-r--r--docs/swagger.json15
-rw-r--r--docs/swagger.yaml11
3 files changed, 65 insertions, 0 deletions
diff --git a/docs/docs.go b/docs/docs.go
new file mode 100644
index 0000000..b05b0ad
--- /dev/null
+++ b/docs/docs.go
@@ -0,0 +1,39 @@
1// Package docs GENERATED BY SWAG; DO NOT EDIT
2// This file was generated by swaggo/swag
3package docs
4
5import "github.com/swaggo/swag"
6
7const docTemplate = `{
8 "schemes": {{ marshal .Schemes }},
9 "swagger": "2.0",
10 "info": {
11 "description": "{{escape .Description}}",
12 "title": "{{.Title}}",
13 "contact": {},
14 "license": {
15 "name": "GNU General Public License, Version 2",
16 "url": "https://www.gnu.org/licenses/old-licenses/gpl-2.0.html"
17 },
18 "version": "{{.Version}}"
19 },
20 "host": "{{.Host}}",
21 "basePath": "{{.BasePath}}",
22 "paths": {}
23}`
24
25// SwaggerInfo holds exported Swagger Info so clients can modify it
26var SwaggerInfo = &swag.Spec{
27 Version: "1.0",
28 Host: "localhost:4000",
29 BasePath: "",
30 Schemes: []string{},
31 Title: "Least Portals Database API",
32 Description: "Backend API endpoints for Least Portals Database.",
33 InfoInstanceName: "swagger",
34 SwaggerTemplate: docTemplate,
35}
36
37func init() {
38 swag.Register(SwaggerInfo.InstanceName(), SwaggerInfo)
39}
diff --git a/docs/swagger.json b/docs/swagger.json
new file mode 100644
index 0000000..9c64dd0
--- /dev/null
+++ b/docs/swagger.json
@@ -0,0 +1,15 @@
1{
2 "swagger": "2.0",
3 "info": {
4 "description": "Backend API endpoints for Least Portals Database.",
5 "title": "Least Portals Database API",
6 "contact": {},
7 "license": {
8 "name": "GNU General Public License, Version 2",
9 "url": "https://www.gnu.org/licenses/old-licenses/gpl-2.0.html"
10 },
11 "version": "1.0"
12 },
13 "host": "localhost:4000",
14 "paths": {}
15} \ No newline at end of file
diff --git a/docs/swagger.yaml b/docs/swagger.yaml
new file mode 100644
index 0000000..e4d9f39
--- /dev/null
+++ b/docs/swagger.yaml
@@ -0,0 +1,11 @@
1host: localhost:4000
2info:
3 contact: {}
4 description: Backend API endpoints for Least Portals Database.
5 license:
6 name: GNU General Public License, Version 2
7 url: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
8 title: Least Portals Database API
9 version: "1.0"
10paths: {}
11swagger: "2.0"