schema

Documentation

Index

• Variables
• type CompositeObjectSchemaProvider
  • func NewCompositeObjectSchemaProvider(schemaProviders ...HTTPObjectSchemaProvider) *CompositeObjectSchemaProvider
  • func (c *CompositeObjectSchemaProvider) GetMetadata(ctx context.Context, objects []string) (*common.ListObjectMetadataResult, error)
• type HTTPObjectSchemaProvider
  • func NewHTTPObjectSchemaProvider(client common.AuthenticatedHTTPClient, ...) *HTTPObjectSchemaProvider
  • func (p *HTTPObjectSchemaProvider) GetMetadata(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 ErrUnableToGetMetadata = errors.New("unable to get metadata")

Types

type CompositeObjectSchemaProvider

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

CompositeSchemaProvider gets metadata from multiple providers with fallback.

func NewCompositeObjectSchemaProvider

func NewCompositeObjectSchemaProvider(schemaProviders ...HTTPObjectSchemaProvider) *CompositeObjectSchemaProvider

func (*CompositeObjectSchemaProvider) GetMetadata

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

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

type HTTPObjectSchemaProvider

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

HTTPObjectSchemaProvider implements Provider using HTTP.

func NewHTTPObjectSchemaProvider

func NewHTTPObjectSchemaProvider(
	client common.AuthenticatedHTTPClient,
	list operations.ListObjectMetadataHandlers,
) *HTTPObjectSchemaProvider

func (*HTTPObjectSchemaProvider) GetMetadata

func (p *HTTPObjectSchemaProvider) GetMetadata(
	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)