deps

Documentation

Overview

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

Code generated by github.com/lzurbriggen/oapi-codegen version (devel) DO NOT EDIT.

Index

• func GetSwagger() (swagger *openapi3.T, err error)
• func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)
• type BaseError
• type DefaultError
• type Error
• type N401
• type N403
• type N410

Functions

func GetSwagger

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

GetSwagger returns the Swagger specification corresponding to the generated code in this file. The external references of Swagger specification are resolved. The logic of resolving external references is tightly connected to "import-mapping" feature. Externally referenced files must be embedded in the corresponding golang packages. Urls can be supported but this task was out of the scope.

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 BaseError

type BaseError struct {
	// Code The underlying http status code
	Code int32 `json:"code"`

	// Domain The domain where the error is originating from as defined by the service
	Domain string `json:"domain"`

	// Message A simple message in english describing the error and can be returned to the consumer
	Message string `json:"message"`

	// Metadata Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs
	Metadata *map[string]string `json:"metadata,omitempty"`
}

BaseError defines model for BaseError.

type DefaultError

type DefaultError = Error

DefaultError defines model for DefaultError.

type Error

type Error = BaseError

Error defines model for Error.

type N401

type N401 = Error

N401 defines model for 401.

type N403

type N403 = Error

N403 defines model for 403.

type N410

type N410 = Error

N410 defines model for 410.