docs

Documentation

Index

• Variables
• func NewGetDocsEndpoint() endpoint.EndpointHandler
• func NewGetOpenapiEndpoint() endpoint.EndpointHandler
• type GetDocsEndpoint
  • func (ep *GetDocsEndpoint) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type GetDocsRequest
• type GetOpenapiEndpoint
  • func (ep GetOpenapiEndpoint) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type GetOpenapiRequest
• type GetOpenapiResponse

Variables

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