Help us shape the future of Go! Take the 2026 Go Developer Survey

output

package
v0.1.0 Latest Latest
Warning

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

Go to latest
Published: Apr 15, 2026 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetOpenAPISpecJSON

func GetOpenAPISpecJSON() ([]byte, error)

GetOpenAPISpecJSON returns the raw OpenAPI spec as JSON bytes.

Types

type BaseError

type BaseError struct {
	// The underlying http status code
	Code int32 `form:"code" json:"code"`
	// A simple message in english describing the error and can be returned to the consumer
	Message string `form:"message" json:"message"`
	// The domain where the error is originating from as defined by the service
	Domain string `form:"domain" json:"domain"`
	// Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs
	Metadata map[string]string `form:"metadata,omitempty" json:"metadata,omitempty"`
}

#/components/schemas/BaseError

func (*BaseError) ApplyDefaults

func (s *BaseError) ApplyDefaults()

ApplyDefaults sets default values for fields that are nil.

type BaseErrorMetadata

type BaseErrorMetadata = map[string]string

#/components/schemas/BaseError/properties/metadata Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs

type Error

type Error struct {
	// A reason code specific to the service and can be used to identify the exact issue. Should be unique within a domain
	Reason string `form:"reason" json:"reason"`
	// The underlying http status code
	Code int32 `form:"code" json:"code"`
	// A simple message in english describing the error and can be returned to the consumer
	Message string `form:"message" json:"message"`
	// The domain where the error is originating from as defined by the service
	Domain string `form:"domain" json:"domain"`
	// Any additional details to be conveyed as determined by the service. If present, will return map of key value pairs
	Metadata map[string]string `form:"metadata,omitempty" json:"metadata,omitempty"`
}

#/components/schemas/Error

func (*Error) ApplyDefaults

func (s *Error) ApplyDefaults()

ApplyDefaults sets default values for fields that are nil.

Jump to

Keyboard shortcuts

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