api

Documentation

Overview

Package api provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.7.2 DO NOT EDIT.

Index

• func GetSpec() (swagger *openapi3.T, err error)
• func GetSpecJSON() ([]byte, error)
• func GetSwagger() (*openapi3.T, error)
• func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)
• type SystemVersionInfo

Functions

func GetSpec

func GetSpec() (swagger *openapi3.T, err error)

GetSpec returns the OpenAPI specification corresponding to the generated code in this file. External references in the spec are resolved through PathToRawSpec; externally-referenced files must be embedded in their corresponding Go packages (via the import-mapping feature). URL-based external refs are not supported.

func GetSpecJSON

func GetSpecJSON() ([]byte, error)

GetSpecJSON returns the raw JSON bytes of the embedded OpenAPI specification: decompressed but not unmarshaled. External references are not resolved here; the bytes are the spec exactly as embedded by codegen. The result is cached at package init time, so repeated calls are cheap.

func GetSwagger

func GetSwagger() (*openapi3.T, error)

GetSwagger returns the OpenAPI specification corresponding to the generated code in this file.

Deprecated: GetSwagger predates kin-openapi renaming openapi3.Swagger to openapi3.T. Use GetSpec instead. This wrapper is retained for backwards compatibility.

func PathToRawSpec

func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)

Constructs a synthetic filesystem for resolving external references when loading openapi specifications.

Types

type SystemVersionInfo

type SystemVersionInfo struct {
	// BuildTime Time when application was built
	BuildTime *string `json:"build-time,omitempty" yaml:"build-time,omitempty"`

	// BuildUser User who built application
	BuildUser *string `json:"build-user,omitempty" yaml:"build-user,omitempty"`

	// Revision VCS revision
	Revision *string `json:"revision,omitempty" yaml:"revision,omitempty"`

	// Version Application version
	Version *string `json:"version,omitempty" yaml:"version,omitempty"`
}

SystemVersionInfo Encapsulates common version information