odp

package module

Go to main page

Versions in this module

v0

v0.3.2

Aug 11, 2026

Changes in this version

+ func IsPaymentOption(value PaymentOption) bool

+ type PaymentOption string

+ const PaymentOptionAlgorand

+ const PaymentOptionAptos

+ const PaymentOptionArbitrum

+ const PaymentOptionAvalanche

+ const PaymentOptionBase

+ const PaymentOptionCard

+ const PaymentOptionEthereum

+ const PaymentOptionHedera

+ const PaymentOptionInflow

+ const PaymentOptionLightning

+ const PaymentOptionPolygon

+ const PaymentOptionSolana

+ const PaymentOptionStellar

+ const PaymentOptionStripe

+ const PaymentOptionTON

+ const PaymentOptionTempo

type PaymentProtocol

+ Options []PaymentOption

v0.3.1

Aug 11, 2026

v0.3.0

Aug 7, 2026

Changes in this version

type HTTPConfiguration

+ OpenAPI *ServiceOpenAPI

+ type ServiceBranding struct

+ Icon ServiceBrandingImage

+ Logo ServiceBrandingImage

+ type ServiceBrandingImage struct

+ Source string

+ Type ServiceBrandingImageType

+ type ServiceBrandingImageType string

+ const ServiceBrandingPNG

+ const ServiceBrandingSVG

+ const ServiceBrandingWebP

type ServiceDocument

+ Branding *ServiceBranding

+ type ServiceOpenAPI struct

+ URL string

v0.2.0

Aug 3, 2026

Changes in this version

type Action

+ Authentication AuthenticationRequirement

+ type AuthenticationRequirement string

+ const AuthenticationNotRequired

+ const AuthenticationOptional

+ const AuthenticationRequired

type Collection

+ AuthExpands bool

+ type EnrollmentProtocol struct

+ Name Protocol

type Offering

+ AuthExpands bool

type OfferingPage

+ AuthExpands bool

+ type OperationDescriptor struct

+ Authentication AuthenticationRequirement

+ Name Operation

type Page

+ AuthExpands bool

+ type PaymentProtocol struct

+ Authentication AuthenticationRequirement

+ Name Protocol

type ServiceProtocols

+ Enrollment []EnrollmentProtocol

v0.1.0

Aug 3, 2026

Changes in this version

+ const MaxTraversalPages

+ const Version

+ var ErrPaginationLoop = errors.New("ODP pagination loop detected")

+ func BuildOperationURL(endpointBase string, operation Operation, serviceOrigin, id string) (*url.URL, error)

+ func DeriveServiceOrigin(serviceDocumentURL string) (string, error)

+ func IsLocalResourceIdentifier(value string) bool

+ func IterateItems[Item any](ctx context.Context, first Page[Item], load PageLoader[Item]) iter.Seq2[Item, error]

+ func IteratePages[Item any](ctx context.Context, first Page[Item], load PageLoader[Item]) iter.Seq2[Page[Item], error]

+ func OperationMethod(operation Operation) (string, bool)

+ func ResolveContinuation(reference, serviceOrigin string) (*url.URL, error)

+ func ResolveResourceReference(reference, serviceOrigin string) (*url.URL, error)

+ type Action struct

+ Description string

+ HTTP *HTTPActionTarget

+ ID string

+ OpenAPI *OpenAPIActionTarget

+ Rel ActionRelation

+ type ActionRelation string

+ const ActionDownload

+ const ActionInvoke

+ const ActionPurchase

+ const ActionQuote

+ const ActionReserve

+ type ActionRequest struct

+ ContentType string

+ Schema *SchemaReference

+ type AdditionalMembers map[string]json.RawMessage

+ type CapabilityLink struct

+ Additional AdditionalMembers

+ Href string

+ func (value *CapabilityLink) UnmarshalJSON(data []byte) error

+ func (value CapabilityLink) MarshalJSON() ([]byte, error)

+ type Collection struct

+ Additional AdditionalMembers

+ Description string

+ DetailFields []string

+ ID string

+ Language string

+ Localizations []string

+ Name string

+ ODPVersion string

+ ParentIDs []string

+ SearchCapabilities *SearchCapabilities

+ WebURL string

+ func ParseCollection(data []byte) (Collection, error)

+ func (value *Collection) UnmarshalJSON(data []byte) error

+ func (value Collection) MarshalJSON() ([]byte, error)

+ type CollectionSearchRequest struct

+ Additional AdditionalMembers

+ Limit int

+ ODPVersion string

+ ParentID Optional[string]

+ Query string

+ func ParseCollectionSearchRequest(data []byte) (CollectionSearchRequest, error)

+ func (value *CollectionSearchRequest) UnmarshalJSON(data []byte) error

+ func (value CollectionSearchRequest) MarshalJSON() ([]byte, error)

+ type FilterCapabilitySource struct

+ Additional AdditionalMembers

+ Inline []FilterDefinition

+ Linked *CapabilityLink

+ func (value *FilterCapabilitySource) UnmarshalJSON(data []byte) error

+ func (value FilterCapabilitySource) MarshalJSON() ([]byte, error)

+ type FilterDefinition struct

+ Additional AdditionalMembers

+ Description string

+ ID string

+ Operators []FilterOperator

+ Refinable bool

+ Title string

+ Type FilterType

+ Unit *FilterUnit

+ func ParseFilterDefinition(data []byte) (FilterDefinition, error)

+ func (value *FilterDefinition) UnmarshalJSON(data []byte) error

+ func (value FilterDefinition) MarshalJSON() ([]byte, error)

+ type FilterExpression struct

+ Additional AdditionalMembers

+ ID string

+ Operator FilterOperator

+ Value json.RawMessage

+ func (value *FilterExpression) UnmarshalJSON(data []byte) error

+ func (value FilterExpression) MarshalJSON() ([]byte, error)

+ type FilterOperator string

+ const OperatorEqual

+ const OperatorExists

+ const OperatorGreaterThan

+ const OperatorGreaterThanOrEqual

+ const OperatorIn

+ const OperatorLessThan

+ const OperatorLessThanOrEqual

+ type FilterType string

+ const FilterBoolean

+ const FilterDate

+ const FilterDateTime

+ const FilterDecimal

+ const FilterInteger

+ const FilterNumber

+ const FilterString

+ type FilterUnit struct

+ Additional AdditionalMembers

+ Code string

+ System string

+ Title string

+ func (value *FilterUnit) UnmarshalJSON(data []byte) error

+ func (value FilterUnit) MarshalJSON() ([]byte, error)

+ type HTTPActionTarget struct

+ Href string

+ Method string

+ Request *ActionRequest

+ ResponseContentTypes []string

+ type HTTPConfiguration struct

+ Additional AdditionalMembers

+ EndpointBase string

+ func (value *HTTPConfiguration) UnmarshalJSON(data []byte) error

+ func (value HTTPConfiguration) MarshalJSON() ([]byte, error)

+ type InvalidParameter struct

+ Additional AdditionalMembers

+ In string

+ Name string

+ Reason string

+ func (value *InvalidParameter) UnmarshalJSON(data []byte) error

+ func (value InvalidParameter) MarshalJSON() ([]byte, error)

+ type MissingPlacement string

+ const MissingFirst

+ const MissingLast

+ type Offering struct

+ Actions []Action

+ Additional AdditionalMembers

+ Attributes map[string]json.RawMessage

+ CollectionIDs []string

+ Description string

+ DetailFields []string

+ ID string

+ Language string

+ Localizations []string

+ Name string

+ ODPVersion string

+ Price *PricePreview

+ Schema *SchemaReference

+ WebURL string

+ func ParseOffering(data []byte) (Offering, error)

+ func (value *Offering) UnmarshalJSON(data []byte) error

+ func (value Offering) MarshalJSON() ([]byte, error)

+ type OfferingPage struct

+ Additional AdditionalMembers

+ Items []Item

+ Next string

+ ODPVersion string

+ Refinements []RefinementGroup

+ func ParseOfferingSearchResponse(data []byte) (OfferingPage[Offering], error)

+ func (value *OfferingPage[Item]) UnmarshalJSON(data []byte) error

+ func (value OfferingPage[Item]) MarshalJSON() ([]byte, error)

+ type OfferingSearchRequest struct

+ Additional AdditionalMembers

+ CollectionID string

+ Filters []FilterExpression

+ IncludeDescendants bool

+ Limit int

+ ODPVersion string

+ Query string

+ Refinements []string

+ Sort string

+ func ParseOfferingSearchRequest(data []byte) (OfferingSearchRequest, error)

+ func (value *OfferingSearchRequest) UnmarshalJSON(data []byte) error

+ func (value OfferingSearchRequest) MarshalJSON() ([]byte, error)

+ type OpenAPIActionTarget struct

+ OperationID string

+ URL string

+ type Operation string

+ const OperationGetCollection

+ const OperationGetOffering

+ const OperationListCollectionOfferings

+ const OperationListCollections

+ const OperationListOfferings

+ const OperationSearchCollections

+ const OperationSearchOfferings

+ type Operations struct

+ Additional AdditionalMembers

+ Supported []Operation

+ func (value *Operations) UnmarshalJSON(data []byte) error

+ func (value Operations) MarshalJSON() ([]byte, error)

+ type Optional struct

+ func Null[Value any]() Optional[Value]

+ func Some[Value any](value Value) Optional[Value]

+ func (optional *Optional[Value]) UnmarshalJSON(data []byte) error

+ func (optional Optional[Value]) Get() (Value, bool)

+ func (optional Optional[Value]) IsNull() bool

+ func (optional Optional[Value]) IsPresent() bool

+ func (optional Optional[Value]) IsZero() bool

+ func (optional Optional[Value]) MarshalJSON() ([]byte, error)

+ type Page struct

+ Additional AdditionalMembers

+ Items []Item

+ Next string

+ ODPVersion string

+ func ParseFilterDefinitionPage(data []byte) (Page[FilterDefinition], error)

+ func ParsePage[Item any](data []byte) (Page[Item], error)

+ func ParseSortDefinitionPage(data []byte) (Page[SortDefinition], error)

+ func (value *Page[Item]) UnmarshalJSON(data []byte) error

+ func (value Page[Item]) MarshalJSON() ([]byte, error)

+ type PageLoader func(context.Context, string) (Page[Item], error)

+ type PricePreview struct

+ Additional AdditionalMembers

+ Amount string

+ Currency string

+ Maximum string

+ Minimum string

+ Type PriceType

+ Unit string

+ func (value *PricePreview) UnmarshalJSON(data []byte) error

+ func (value PricePreview) MarshalJSON() ([]byte, error)

+ type PriceType string

+ const PriceFixed

+ const PriceFree

+ const PriceMetered

+ const PriceQuote

+ const PriceRange

+ const PriceStartingAt

+ type ProblemDetails struct

+ Additional AdditionalMembers

+ Code string

+ Detail string

+ Instance string

+ InvalidParams []InvalidParameter

+ Status int

+ Title string

+ Type string

+ func ParseProblemDetails(data []byte) (ProblemDetails, error)

+ func ParseProblemResponse(data []byte, status int) (ProblemDetails, error)

+ func (value *ProblemDetails) UnmarshalJSON(data []byte) error

+ func (value ProblemDetails) MarshalJSON() ([]byte, error)

+ type Protocol string

+ const ProtocolAEP

+ const ProtocolMPP

+ const ProtocolX402

+ type RefinementBucket struct

+ Additional AdditionalMembers

+ Count int

+ CountRelation string

+ Value any

+ func (value *RefinementBucket) UnmarshalJSON(data []byte) error

+ func (value RefinementBucket) MarshalJSON() ([]byte, error)

+ type RefinementGroup struct

+ Additional AdditionalMembers

+ FilterID string

+ Values []RefinementBucket

+ func (value *RefinementGroup) UnmarshalJSON(data []byte) error

+ func (value RefinementGroup) MarshalJSON() ([]byte, error)

+ type Representation string

+ const RepresentationFull

+ const RepresentationTerse

+ type ResourceIdentity struct

+ ID string

+ Service string

+ Type ResourceType

+ func NewResourceIdentity(serviceDocumentURL string, resourceType ResourceType, id string) (ResourceIdentity, error)

+ func ParseResourceIdentity(data []byte) (ResourceIdentity, error)

+ func (identity ResourceIdentity) Equal(other ResourceIdentity) bool

+ func (identity ResourceIdentity) Key() string

+ type ResourceType string

+ const ResourceCollection

+ const ResourceOffering

+ type SchemaReference struct

+ URL string

+ type SearchCapabilities struct

+ Additional AdditionalMembers

+ Filters *FilterCapabilitySource

+ Sorts *SortCapabilitySource

+ func (value *SearchCapabilities) UnmarshalJSON(data []byte) error

+ func (value SearchCapabilities) MarshalJSON() ([]byte, error)

+ type ServiceDocument struct

+ Additional AdditionalMembers

+ Description string

+ HTTP HTTPConfiguration

+ Keywords []string

+ Language string

+ Localizations []string

+ Name string

+ ODPVersion string

+ Operations Operations

+ Protocols *ServiceProtocols

+ SearchCapabilities *SearchCapabilities

+ func ParseServiceDocument(data []byte) (ServiceDocument, error)

+ func (value *ServiceDocument) UnmarshalJSON(data []byte) error

+ func (value ServiceDocument) MarshalJSON() ([]byte, error)

+ type ServiceProtocols struct

+ Onboarding []Protocol

+ Payments []Protocol

+ type SortCapabilitySource struct

+ Additional AdditionalMembers

+ Inline []SortDefinition

+ Linked *CapabilityLink

+ func (value *SortCapabilitySource) UnmarshalJSON(data []byte) error

+ func (value SortCapabilitySource) MarshalJSON() ([]byte, error)

+ type SortDefinition struct

+ Additional AdditionalMembers

+ Description string

+ ID string

+ Keys []SortKey

+ Title string

+ func ParseSortDefinition(data []byte) (SortDefinition, error)

+ func (value *SortDefinition) UnmarshalJSON(data []byte) error

+ func (value SortDefinition) MarshalJSON() ([]byte, error)

+ type SortDirection string

+ const SortAscending

+ const SortDescending

+ type SortKey struct

+ Additional AdditionalMembers

+ Direction SortDirection

+ FilterID string

+ Missing MissingPlacement

+ func (value *SortKey) UnmarshalJSON(data []byte) error

+ func (value SortKey) MarshalJSON() ([]byte, error)

+ type ValidationError struct

+ DocumentType string

+ Issues []ValidationIssue

+ func (err *ValidationError) Error() string

+ type ValidationIssue struct

+ Keyword string

+ Message string

+ Params map[string]any

+ Path string

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