docs

package
v0.0.28 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 12, 2021 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	OpenAPITags = []api.Tag{
		{Name: "Documentation", Description: ""},
	}
)

Functions

func NewGetDocsEndpoint

func NewGetDocsEndpoint() endpoint.EndpointHandler

func NewGetOpenapiEndpoint

func NewGetOpenapiEndpoint() endpoint.EndpointHandler

Types

type GetDocsEndpoint

type GetDocsEndpoint struct {
	endpoint.Endpoint
}

func (*GetDocsEndpoint) ServeHTTP

func (ep *GetDocsEndpoint) ServeHTTP(w http.ResponseWriter, r *http.Request)

type GetDocsRequest

type GetDocsRequest struct{}

type GetOpenapiEndpoint

type GetOpenapiEndpoint struct {
	endpoint.Endpoint
}

https://golang.org/doc/effective_go#embedding

func (GetOpenapiEndpoint) ServeHTTP

func (ep GetOpenapiEndpoint) ServeHTTP(w http.ResponseWriter, r *http.Request)

type GetOpenapiRequest

type GetOpenapiRequest struct {
	Format string `json:"format" oas-query:"format" query:"format" oas-desc:"Format returned by the endpoint, eg. json"`
}

type GetOpenapiResponse

type GetOpenapiResponse exporter.Openapi

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL