metadatadef

Documentation

Index

• type ExtendedSchema
  • func (s ExtendedSchema[C]) String() string
• type Field
• type Fields
• type Schema
• type Schemas
  • func (s Schemas[C]) Combine(others Schemas[C]) Schemas[C]

Types

type ExtendedSchema

type ExtendedSchema[C any] struct {
	ObjectName  string
	DisplayName string
	Fields      Fields
	QueryParams []string
	URLPath     string
	ResponseKey string
	Problem     error
	Custom      C
}

func (ExtendedSchema[C]) String

func (s ExtendedSchema[C]) String() string

type Field

type Field struct {
	Name         string
	Type         string
	ValueOptions []string
}

type Fields

type Fields = datautils.Map[string, Field]

type Schema

type Schema = ExtendedSchema[any]

Schema is a model that describes a REST API object. This is usually created when metadata is coming not from API but alternative sources, example: OpenAPI. This model holds more information than common.ObjectMetadata. It may include custom properties.

type Schemas

type Schemas[C any] []ExtendedSchema[C]

func (Schemas[C]) Combine

func (s Schemas[C]) Combine(others Schemas[C]) Schemas[C]