schema

Documentation

Index

• Variables
• type AggregateSchemaProvider
  • func NewAggregateSchemaProvider(client common.AuthenticatedHTTPClient, ...) *AggregateSchemaProvider
  • func (p *AggregateSchemaProvider) ListObjectMetadata(ctx context.Context, objects []string) (*common.ListObjectMetadataResult, error)
• type CompositeSchemaProvider
  • func NewCompositeSchemaProvider(schemaProviders ...components.SchemaProvider) *CompositeSchemaProvider
  • func (c *CompositeSchemaProvider) ListObjectMetadata(ctx context.Context, objects []string) (*common.ListObjectMetadataResult, error)
• type ObjectSchemaProvider
  • func NewObjectSchemaProvider(client common.AuthenticatedHTTPClient, fetchType string, ...) *ObjectSchemaProvider
  • func (p *ObjectSchemaProvider) ListObjectMetadata(ctx context.Context, objects []string) (*common.ListObjectMetadataResult, error)
• type OpenAPISchemaProvider
  • func NewOpenAPISchemaProvider[F staticschema.FieldMetadataMap](module common.ModuleID, schemas *staticschema.Metadata[F]) *OpenAPISchemaProvider[F]
  • func (p *OpenAPISchemaProvider[F]) ListObjectMetadata(ctx context.Context, objects []string) (*common.ListObjectMetadataResult, error)

Variables

var (
	FetchModeParallel = "parallel" // nolint:gochecknoglobals
	FetchModeSerial   = "serial"   // nolint:gochecknoglobals

	ErrInvalidFetchType = errors.New("invalid fetch type")
	ErrNoMetadata       = errors.New("no metadata found")
)

var ErrUnableToGetMetadata = errors.New("unable to get metadata")

Types

type AggregateSchemaProvider

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

AggregateSchemaProvider gets the schema for multiple objects using a single batch request.

func NewAggregateSchemaProvider

func NewAggregateSchemaProvider(
	client common.AuthenticatedHTTPClient,
	list operations.ListObjectMetadataHandlers,
) *AggregateSchemaProvider

func (*AggregateSchemaProvider) ListObjectMetadata

func (p *AggregateSchemaProvider) ListObjectMetadata(
	ctx context.Context,
	objects []string,
) (*common.ListObjectMetadataResult, error)

type CompositeSchemaProvider

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

CompositeSchemaProvider gets metadata from multiple providers with fallback.

func NewCompositeSchemaProvider

func NewCompositeSchemaProvider(schemaProviders ...components.SchemaProvider) *CompositeSchemaProvider

func (*CompositeSchemaProvider) ListObjectMetadata

func (c *CompositeSchemaProvider) ListObjectMetadata(
	ctx context.Context,
	objects []string,
) (*common.ListObjectMetadataResult, error)

ListObjectMetadata tries each schema provider in order, and returns the best result with the least errors.

type ObjectSchemaProvider

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

ObjectSchemaProvider implements Provider by fetching each object individually.

func NewObjectSchemaProvider

func NewObjectSchemaProvider(
	client common.AuthenticatedHTTPClient,
	fetchType string,
	list operations.SingleObjectMetadataHandlers,
) *ObjectSchemaProvider

func (*ObjectSchemaProvider) ListObjectMetadata

func (p *ObjectSchemaProvider) ListObjectMetadata(
	ctx context.Context,
	objects []string,
) (*common.ListObjectMetadataResult, error)

type OpenAPISchemaProvider

type OpenAPISchemaProvider[F staticschema.FieldMetadataMap] struct {
	// contains filtered or unexported fields
}

OpenAPIProvider implements Provider using OpenAPI schemas.

func NewOpenAPISchemaProvider

func NewOpenAPISchemaProvider[F staticschema.FieldMetadataMap](
	module common.ModuleID,
	schemas *staticschema.Metadata[F],
) *OpenAPISchemaProvider[F]

func (*OpenAPISchemaProvider[F]) ListObjectMetadata

func (p *OpenAPISchemaProvider[F]) ListObjectMetadata(
	ctx context.Context,
	objects []string,
) (*common.ListObjectMetadataResult, error)