github/podinfo
1
0
Fork 0
mirror of https://github.com/stefanprodan/podinfo.git synced 2026-08-28 17:57:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

recreate docs

Browse Source
This commit is contained in:
FlomoN
2022-06-20 18:26:34 +02:00
parent 2da59980fe
commit 678a42ce34
6 changed files with 109 additions and 57 deletions
Download Patch File Download Diff File Expand all files Collapse all files
pkg/api/docs/docs.go
+43 -54
View File
@@ -1,22 +1,14 @@
// GENERATED BY THE COMMAND ABOVE; DO NOT EDIT
// Package docs GENERATED BY SWAG; DO NOT EDIT
// This file was generated by swaggo/swag
package docs
import (
"bytes"
"encoding/json"
"strings"
import "github.com/swaggo/swag"
"github.com/alecthomas/template"
"github.com/swaggo/swag"
)
var doc = `{
const docTemplate = `{
"schemes": {{ marshal .Schemes }},
"swagger": "2.0",
"info": {
"description": "{{.Description}}",
"description": "{{escape .Description}}",
"title": "{{.Title}}",
"contact": {
"name": "Source Code",
@@ -110,6 +102,15 @@ var doc = `{
"HTTP API"
],
"summary": "Get payload from cache",
"parameters": [
{
"type": "string",
"description": "Key to load from cache",
"name": "key",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
@@ -131,6 +132,15 @@ var doc = `{
"HTTP API"
],
"summary": "Save payload in cache",
"parameters": [
{
"type": "string",
"description": "Key to save to",
"name": "key",
"in": "path",
"required": true
}
],
"responses": {
"202": {
"description": ""
@@ -149,6 +159,15 @@ var doc = `{
"HTTP API"
],
"summary": "Delete payload from cache",
"parameters": [
{
"type": "string",
"description": "Key to delete",
"name": "key",
"in": "path",
"required": true
}
],
"responses": {
"202": {
"description": ""
@@ -303,7 +322,8 @@ var doc = `{
"tags": [
"HTTP API"
],
"summary": "Panic"
"summary": "Panic",
"responses": {}
}
},
"/readyz": {
@@ -610,49 +630,18 @@ var doc = `{
}
}`
type swaggerInfo struct {
Version string
Host string
BasePath string
Schemes []string
Title string
Description string
}
// SwaggerInfo holds exported Swagger Info so clients can modify it
var SwaggerInfo = swaggerInfo{
Version: "2.0",
Host: "localhost:9898",
BasePath: "/",
Schemes: []string{"http", "https"},
Title: "Podinfo API",
Description: "Go microservice template for Kubernetes.",
}
type s struct{}
func (s *s) ReadDoc() string {
sInfo := SwaggerInfo
sInfo.Description = strings.Replace(sInfo.Description, "\n", "\\n", -1)
t, err := template.New("swagger_info").Funcs(template.FuncMap{
"marshal": func(v interface{}) string {
a, _ := json.Marshal(v)
return string(a)
},
}).Parse(doc)
if err != nil {
return doc
}
var tpl bytes.Buffer
if err := t.Execute(&tpl, sInfo); err != nil {
return doc
}
return tpl.String()
var SwaggerInfo = &swag.Spec{
Version: "2.0",
Host: "localhost:9898",
BasePath: "/",
Schemes: []string{"http", "https"},
Title: "Podinfo API",
Description: "Go microservice template for Kubernetes.",
InfoInstanceName: "swagger",
SwaggerTemplate: docTemplate,
}
func init() {
swag.Register(swag.Name, &s{})
swag.Register(SwaggerInfo.InstanceName(), SwaggerInfo)
}
pkg/api/docs/swagger.json
+29 -1
View File
@@ -99,6 +99,15 @@
"HTTP API"
],
"summary": "Get payload from cache",
"parameters": [
{
"type": "string",
"description": "Key to load from cache",
"name": "key",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
@@ -120,6 +129,15 @@
"HTTP API"
],
"summary": "Save payload in cache",
"parameters": [
{
"type": "string",
"description": "Key to save to",
"name": "key",
"in": "path",
"required": true
}
],
"responses": {
"202": {
"description": ""
@@ -138,6 +156,15 @@
"HTTP API"
],
"summary": "Delete payload from cache",
"parameters": [
{
"type": "string",
"description": "Key to delete",
"name": "key",
"in": "path",
"required": true
}
],
"responses": {
"202": {
"description": ""
@@ -292,7 +319,8 @@
"tags": [
"HTTP API"
],
"summary": "Panic"
"summary": "Panic",
"responses": {}
}
},
"/readyz": {
pkg/api/docs/swagger.yaml
+19
View File
@@ -103,6 +103,12 @@ paths:
consumes:
- application/json
description: deletes the key and its value from cache
parameters:
- description: Key to delete
in: path
name: key
required: true
type: string
produces:
- application/json
responses:
@@ -115,6 +121,12 @@ paths:
consumes:
- application/json
description: returns the content from cache if key exists
parameters:
- description: Key to load from cache
in: path
name: key
required: true
type: string
produces:
- application/json
responses:
@@ -129,6 +141,12 @@ paths:
consumes:
- application/json
description: writes the posted content in cache
parameters:
- description: Key to save to
in: path
name: key
required: true
type: string
produces:
- application/json
responses:
@@ -233,6 +251,7 @@ paths:
/panic:
get:
description: crashes the process with exit code 255
responses: {}
summary: Panic
tags:
- HTTP API