v20240216

Documentation

Overview

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

Code generated by github.com/deepmap/oapi-codegen version v1.14.0 DO NOT EDIT.

Index

• type ActualVersion
• type EndingBefore
• type Error
• type ErrorDocument
• type ErrorLink
• type JsonApi
• type Limit
• type LinkProperty
  • func (t LinkProperty) AsLinkProperty0() (LinkProperty0, error)
  • func (t LinkProperty) AsLinkProperty1() (LinkProperty1, error)
  • func (t *LinkProperty) FromLinkProperty0(v LinkProperty0) error
  • func (t *LinkProperty) FromLinkProperty1(v LinkProperty1) error
  • func (t LinkProperty) MarshalJSON() ([]byte, error)
  • func (t *LinkProperty) MergeLinkProperty0(v LinkProperty0) error
  • func (t *LinkProperty) MergeLinkProperty1(v LinkProperty1) error
  • func (t *LinkProperty) UnmarshalJSON(b []byte) error
• type LinkProperty0
• type LinkProperty1
• type Links
• type Meta
• type N400
• type N401
• type N403
• type N404
• type N409
• type N500
• type PaginatedLinks
• type QueryVersion
• type RelatedLink
• type Relationship
• type SelfLink
• type StartingAfter
• type Tag
• type Types
• type Version

Types

type ActualVersion

type ActualVersion = string

ActualVersion Resolved API version

type EndingBefore

type EndingBefore = string

EndingBefore defines model for EndingBefore.

type Error

type Error struct {
	// Code An application-specific error code, expressed as a string value.
	Code *string `json:"code,omitempty"`

	// Detail A human-readable explanation specific to this occurrence of the problem.
	Detail string `json:"detail"`

	// Id A unique identifier for this particular occurrence of the problem.
	Id *openapi_types.UUID `json:"id,omitempty"`

	// Links A link that leads to further details about this particular occurrance of the problem.
	Links  *ErrorLink              `json:"links,omitempty"`
	Meta   *map[string]interface{} `json:"meta,omitempty"`
	Source *struct {
		// Parameter A string indicating which URI query parameter caused the error.
		Parameter *string `json:"parameter,omitempty"`

		// Pointer A JSON Pointer [RFC6901] to the associated entity in the request document.
		Pointer *string `json:"pointer,omitempty"`
	} `json:"source,omitempty"`

	// Status The HTTP status code applicable to this problem, expressed as a string value.
	Status string `json:"status"`

	// Title A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
	Title *string `json:"title,omitempty"`
}

Error defines model for Error.

type ErrorDocument

type ErrorDocument struct {
	Errors  []Error `json:"errors"`
	Jsonapi JsonApi `json:"jsonapi"`
}

ErrorDocument defines model for ErrorDocument.

type ErrorLink

type ErrorLink struct {
	About *LinkProperty `json:"about,omitempty"`
}

ErrorLink A link that leads to further details about this particular occurrance of the problem.

type JsonApi

type JsonApi struct {
	// Version Version of the JSON API specification this server supports.
	Version string `json:"version"`
}

JsonApi defines model for JsonApi.

type Limit

type Limit = int32

Limit defines model for Limit.

type LinkProperty

type LinkProperty struct {
	// contains filtered or unexported fields
}

LinkProperty defines model for LinkProperty.

func (LinkProperty) AsLinkProperty0

func (t LinkProperty) AsLinkProperty0() (LinkProperty0, error)

AsLinkProperty0 returns the union data inside the LinkProperty as a LinkProperty0

func (LinkProperty) AsLinkProperty1

func (t LinkProperty) AsLinkProperty1() (LinkProperty1, error)

AsLinkProperty1 returns the union data inside the LinkProperty as a LinkProperty1

func (*LinkProperty) FromLinkProperty0

func (t *LinkProperty) FromLinkProperty0(v LinkProperty0) error

FromLinkProperty0 overwrites any union data inside the LinkProperty as the provided LinkProperty0

func (*LinkProperty) FromLinkProperty1

func (t *LinkProperty) FromLinkProperty1(v LinkProperty1) error

FromLinkProperty1 overwrites any union data inside the LinkProperty as the provided LinkProperty1

func (LinkProperty) MarshalJSON

func (t LinkProperty) MarshalJSON() ([]byte, error)

func (*LinkProperty) MergeLinkProperty0

func (t *LinkProperty) MergeLinkProperty0(v LinkProperty0) error

MergeLinkProperty0 performs a merge with any union data inside the LinkProperty, using the provided LinkProperty0

func (*LinkProperty) MergeLinkProperty1

func (t *LinkProperty) MergeLinkProperty1(v LinkProperty1) error

MergeLinkProperty1 performs a merge with any union data inside the LinkProperty, using the provided LinkProperty1

func (*LinkProperty) UnmarshalJSON

func (t *LinkProperty) UnmarshalJSON(b []byte) error

type LinkProperty0

type LinkProperty0 = string

LinkProperty0 A string containing the link’s URL.

type LinkProperty1

type LinkProperty1 struct {
	// Href A string containing the link’s URL.
	Href string `json:"href"`

	// Meta Free-form object that may contain non-standard information.
	Meta *Meta `json:"meta,omitempty"`
}

LinkProperty1 defines model for .

type Links

type Links struct {
	First   *LinkProperty `json:"first,omitempty"`
	Last    *LinkProperty `json:"last,omitempty"`
	Next    *LinkProperty `json:"next,omitempty"`
	Prev    *LinkProperty `json:"prev,omitempty"`
	Related *LinkProperty `json:"related,omitempty"`
	Self    *LinkProperty `json:"self,omitempty"`
}

Links defines model for Links.

type Meta

type Meta map[string]interface{}

Meta Free-form object that may contain non-standard information.

type N400

type N400 = ErrorDocument

N400 defines model for 400.

type N401

type N401 = ErrorDocument

N401 defines model for 401.

type N403

type N403 = ErrorDocument

N403 defines model for 403.

type N404

type N404 = ErrorDocument

N404 defines model for 404.

type N409

type N409 = ErrorDocument

N409 defines model for 409.

type N500

type N500 = ErrorDocument

N500 defines model for 500.

type PaginatedLinks

type PaginatedLinks struct {
	First *LinkProperty `json:"first,omitempty"`
	Last  *LinkProperty `json:"last,omitempty"`
	Next  *LinkProperty `json:"next,omitempty"`
	Prev  *LinkProperty `json:"prev,omitempty"`
	Self  *LinkProperty `json:"self,omitempty"`
}

PaginatedLinks defines model for PaginatedLinks.

type QueryVersion

type QueryVersion = string

QueryVersion Requested API version

type RelatedLink

type RelatedLink struct {
	Related *LinkProperty `json:"related,omitempty"`
}

RelatedLink defines model for RelatedLink.

type Relationship

type Relationship struct {
	Data struct {
		Id openapi_types.UUID `json:"id"`

		// Type Type of the related resource
		Type string `json:"type"`
	} `json:"data"`
	Links RelatedLink `json:"links"`

	// Meta Free-form object that may contain non-standard information.
	Meta *Meta `json:"meta,omitempty"`
}

Relationship defines model for Relationship.

type SelfLink

type SelfLink struct {
	Self *LinkProperty `json:"self,omitempty"`
}

SelfLink defines model for SelfLink.

type StartingAfter

type StartingAfter = string

StartingAfter defines model for StartingAfter.

type Tag

type Tag struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

Tag defines model for Tag.

type Types

type Types = string

Types defines model for Types.

type Version

type Version = QueryVersion

Version Requested API version