directory

README

ODP directory package

Package directory searches the one canonical ODP directory for candidate Services. It does not search Service catalogs. After discovery, an Agent inspects each result's live ODP document and queries that Service's Collections and Offerings.

The production origin is fixed at https://directory.offeringprotocol.org. Select Sandbox to use the fixed https://sandbox.offeringprotocol.org environment. Callers cannot configure another origin.

Search Services

SearchServices lazily traverses directory pages and yields validated Service summaries. Filters are structured and work without natural-language interpretation.

directoryClient, err := directory.New(directory.Options{})
if err != nil {
	return err
}

request := directory.SearchRequest{
	Query: "compute",
	Filters: &directory.ServiceFilters{
		Keywords: []string{"gpu", "accelerator"},
		Payments: []odp.Protocol{odp.ProtocolMPP},
	},
	Limit: 25,
}

for candidate, err := range directoryClient.SearchServices(ctx, request, directory.IterationOptions{}) {
	if err != nil {
		return err
	}
	fmt.Printf("%s: %s\n", candidate.Name, candidate.ServiceOrigin)
}

Use SearchPages when facet counts or page-level additive members are needed:

for page, err := range directoryClient.SearchPages(ctx, request, directory.IterationOptions{}) {
	if err != nil {
		return err
	}
	consume(page.Items, page.Facets)
}

Opaque continuation links are followed with GET on the selected canonical origin. Traversal is limited to 16 pages by default and at most 10,000 results when MaxItems is configured. Stopping iteration stops network activity.

Suggestions

Suggestions help an Agent discover keyword vocabulary without downloading a global keyword list.

suggestions, err := directoryClient.SuggestServices(ctx, directory.SuggestionRequest{
	Prefix: "gp",
	Limit:  5,
})

Sandbox

directoryClient, err := directory.New(directory.Options{
	Environment: directory.Sandbox,
})

Options.HTTPClient permits transport policy and test injection while preserving the selected canonical origin. The client accepts up to five same-origin redirects, bounds response bodies, and returns non-success responses as *directory.RequestError with the status and response headers.

Documentation

Overview

Package directory provides the canonical ODP Service directory client.

Index

• type Client
  • func New(options Options) (*Client, error)
  • func (client *Client) Environment() Environment
  • func (client *Client) SearchPages(ctx context.Context, request SearchRequest, options IterationOptions) iter.Seq2[SearchPage, error]
  • func (client *Client) SearchServices(ctx context.Context, request SearchRequest, options IterationOptions) iter.Seq2[Service, error]
  • func (client *Client) SuggestServices(ctx context.Context, request SuggestionRequest) ([]string, error)
• type Environment
• type Facet
• type Facets
• type IterationOptions
• type Options
• type RequestError
  • func (err *RequestError) Error() string
• type SearchPage
• type SearchRequest
• type Service
• type ServiceFilters
• type SuggestionRequest

Types

type Client

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

func New

func New(options Options) (*Client, error)

func (*Client) Environment

func (client *Client) Environment() Environment

func (*Client) SearchPages

func (client *Client) SearchPages(ctx context.Context, request SearchRequest, options IterationOptions) iter.Seq2[SearchPage, error]

func (*Client) SearchServices

func (client *Client) SearchServices(ctx context.Context, request SearchRequest, options IterationOptions) iter.Seq2[Service, error]

func (*Client) SuggestServices

func (client *Client) SuggestServices(ctx context.Context, request SuggestionRequest) ([]string, error)

type Environment

type Environment string

const (
	Production Environment = "production"
	Sandbox    Environment = "sandbox"
)

type Facet

type Facet[Value ~string] struct {
	Count int64
	Value Value
}

type Facets

type Facets struct {
	Keywords   []Facet[string]
	Onboarding []Facet[odp.Protocol]
	Operations []Facet[odp.Operation]
	Payments   []Facet[odp.Protocol]
}

type IterationOptions

type IterationOptions struct {
	MaxItems int
	MaxPages int
}

type Options

type Options struct {
	Environment Environment
	HTTPClient  *http.Client
}

type RequestError

type RequestError struct {
	Header  http.Header
	Message string
	Status  int
}

func (*RequestError) Error

func (err *RequestError) Error() string

type SearchPage

type SearchPage struct {
	Additional odp.AdditionalMembers
	Facets     *Facets
	Items      []Service
	Next       string
}

type SearchRequest

type SearchRequest struct {
	Filters *ServiceFilters `json:"filters,omitempty"`
	Limit   int             `json:"limit,omitempty"`
	Query   string          `json:"query,omitempty"`
}

type Service

type Service struct {
	Additional    odp.AdditionalMembers
	Description   string
	IndexedAt     time.Time
	Keywords      []string
	Language      string
	Localizations []string
	Name          string
	Operations    []odp.Operation
	Protocols     *odp.ServiceProtocols
	ServiceOrigin string
}

type ServiceFilters

type ServiceFilters struct {
	Keywords   []string        `json:"keywords,omitempty"`
	Onboarding []odp.Protocol  `json:"onboarding,omitempty"`
	Operations []odp.Operation `json:"operations,omitempty"`
	Payments   []odp.Protocol  `json:"payments,omitempty"`
}

type SuggestionRequest

type SuggestionRequest struct {
	Limit  int
	Prefix string
}