oas

Documentation

Overview

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

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

Index

• Variables
• func LoadSpec() (*openapi3.T, error)
• func MustLoadSpec() *openapi3.T
• type ConfiguredFault
• type DeliveryDelay
• type ErrorType
• type FaultDescription
• type PostFaultsInjectJSONRequestBody
• type PutDelaysSubscriptionJSONRequestBody
• type UptimeResponse
  • func (a UptimeResponse) Get(fieldName string) (value interface{}, found bool)
  • func (a UptimeResponse) MarshalJSON() ([]byte, error)
  • func (a *UptimeResponse) Set(fieldName string, value interface{})
  • func (a *UptimeResponse) UnmarshalJSON(b []byte) error

Variables

var OpenAPIFS embed.FS

Functions

func LoadSpec

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

LoadSpec parses the spec resource, as a stand-in for the spec generation from oapi-codegen, to avoid double-embedding the YAML in the binary.

func MustLoadSpec

func MustLoadSpec() *openapi3.T

Types

type ConfiguredFault

type ConfiguredFault struct {
	Count            int64              `json:"count"`
	FaultDescription *string            `json:"faultDescription,omitempty"`
	Operation        string             `json:"operation"`
	Parameters       *map[string]string `json:"parameters,omitempty"`
}

ConfiguredFault defines model for ConfiguredFault.

type DeliveryDelay

type DeliveryDelay struct {
	// Delay Delivery delay, formatted as a Go Duration
	Delay sqltypes.Interval `json:"delay"`
}

DeliveryDelay defines model for DeliveryDelay.

type ErrorType

type ErrorType string

ErrorType defines model for ErrorType.

const (
	ContextCanceled         ErrorType = "context.Canceled"
	ContextDeadlineExceeded ErrorType = "context.DeadlineExceeded"
	EntNotFound             ErrorType = "ent.NotFound"
	GrpcAborted             ErrorType = "grpc.Aborted"
	GrpcAlreadyExists       ErrorType = "grpc.AlreadyExists"
	GrpcCanceled            ErrorType = "grpc.Canceled"
	GrpcDataLoss            ErrorType = "grpc.DataLoss"
	GrpcDeadlineExceeded    ErrorType = "grpc.DeadlineExceeded"
	GrpcFailedPrecondition  ErrorType = "grpc.FailedPrecondition"
	GrpcInternal            ErrorType = "grpc.Internal"
	GrpcInvalidArgument     ErrorType = "grpc.InvalidArgument"
	GrpcNotFound            ErrorType = "grpc.NotFound"
	GrpcOutOfRange          ErrorType = "grpc.OutOfRange"
	GrpcPermissionDenied    ErrorType = "grpc.PermissionDenied"
	GrpcResourceExhausted   ErrorType = "grpc.ResourceExhausted"
	GrpcUnauthenticated     ErrorType = "grpc.Unauthenticated"
	GrpcUnavailable         ErrorType = "grpc.Unavailable"
	GrpcUnimplemented       ErrorType = "grpc.Unimplemented"
	GrpcUnknown             ErrorType = "grpc.Unknown"
)

Defines values for ErrorType.

type FaultDescription

type FaultDescription struct {
	Count      *int64             `json:"count,omitempty"`
	Error      ErrorType          `json:"error"`
	Operation  string             `json:"operation"`
	Parameters *map[string]string `json:"parameters,omitempty"`
}

FaultDescription defines model for FaultDescription.

type PostFaultsInjectJSONRequestBody

type PostFaultsInjectJSONRequestBody = FaultDescription

PostFaultsInjectJSONRequestBody defines body for PostFaultsInject for application/json ContentType.

type PutDelaysSubscriptionJSONRequestBody

type PutDelaysSubscriptionJSONRequestBody = DeliveryDelay

PutDelaysSubscriptionJSONRequestBody defines body for PutDelaysSubscription for application/json ContentType.

type UptimeResponse

type UptimeResponse struct {
	// StartTime Timestamp of when the application instance started
	StartTime            time.Time              `json:"startTime"`
	AdditionalProperties map[string]interface{} `json:"-"`
}

UptimeResponse Response object for a successful uptime request

func (UptimeResponse) Get

func (a UptimeResponse) Get(fieldName string) (value interface{}, found bool)

Getter for additional properties for UptimeResponse. Returns the specified element and whether it was found

func (UptimeResponse) MarshalJSON

func (a UptimeResponse) MarshalJSON() ([]byte, error)

Override default JSON handling for UptimeResponse to handle AdditionalProperties

func (*UptimeResponse) Set

func (a *UptimeResponse) Set(fieldName string, value interface{})

Setter for additional properties for UptimeResponse

func (*UptimeResponse) UnmarshalJSON

func (a *UptimeResponse) UnmarshalJSON(b []byte) error

Override default JSON handling for UptimeResponse to handle AdditionalProperties