openapi

package
v1.0.0 Latest Latest
Warning

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

Go to latest
Published: Mar 20, 2026 License: MPL-2.0 Imports: 13 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func DefineErrors

func DefineErrors(op *core.Operation, registry core.Registry, factory core.ErrorHandler, discovered ...[]core.DiscoveredError)

func Downgrade

func Downgrade(oapi *core.OpenAPI) ([]byte, error)

func DowngradeYAML

func DowngradeYAML(oapi *core.OpenAPI) ([]byte, error)

func FilterByTag

func FilterByTag(oapi *core.OpenAPI, tag string) *core.OpenAPI

func FilterExcludeTag

func FilterExcludeTag(oapi *core.OpenAPI, tag string) *core.OpenAPI

func GenerateInternalSpec

func GenerateInternalSpec(oapi *core.OpenAPI, hiddenOps []*core.Operation) (*core.OpenAPI, error)

func GenerateInternalSpecJSON

func GenerateInternalSpecJSON(oapi *core.OpenAPI, hiddenOps []*core.Operation) ([]byte, error)

func RegisterDocsRoute

func RegisterDocsRoute(adapter core.Adapter, oapi *core.OpenAPI, config core.Config)

func RegisterErrorDocRoutes

func RegisterErrorDocRoutes(adapter core.Adapter, factory core.ErrorHandler, config core.Config)

func RegisterInternalSpecRoutes

func RegisterInternalSpecRoutes(adapter core.Adapter, api core.API, config core.Config)

func RegisterSpecRoutes

func RegisterSpecRoutes(adapter core.Adapter, oapi *core.OpenAPI, config core.Config)

func YAML

func YAML(oapi *core.OpenAPI) ([]byte, error)

Types

type ScalarProvider

type ScalarProvider struct {
	LocalJSPath string
}

func (ScalarProvider) Render

func (p ScalarProvider) Render(specURL string, title string) string

type StoplightProvider

type StoplightProvider struct{}

func (StoplightProvider) Render

func (p StoplightProvider) Render(specURL string, title string) string

type SwaggerUIProvider

type SwaggerUIProvider struct {
	OAuthClientID string
	OAuthScopes   []string
}

func (SwaggerUIProvider) Render

func (p SwaggerUIProvider) Render(specURL string, title string) string

Jump to

Keyboard shortcuts

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