metadata

type AddMetaRT struct {
	// Reference to record created
	RecordID string
}

type AddPayload struct {
	// Entity to which attach metadata
	EntityID string `json:"entity-id,omitempty"`
	// Schema of metadata
	Schema string
	// Aspect content
	Aspect any
	// Content-Type header, MUST be of application/json.
	ContentType string `json:"content-type,omitempty"`
	// Policy guiding visibility and actions performed
	PolicyID *string `json:"policy-id,omitempty"`
	// JWT used for authentication
	JWT string
}

type Auther interface {
	// JWTAuth implements the authorization logic for the JWT security scheme.
	JWTAuth(ctx context.Context, token string, schema *security.JWTScheme) (context.Context, error)
}

type BadRequestT struct {
	// Information message
	Message string
}

type Endpoints struct {
	Read         goa.Endpoint
	List         goa.Endpoint
	Add          goa.Endpoint
	UpdateRecord goa.Endpoint
	Revoke       goa.Endpoint
}

type InvalidParameterT struct {
	// message describing expected type or pattern.
	Message string
	// name of parameter.
	Name string
	// provided parameter value.
	Value *string
}

type InvalidScopesT struct {
	// ID of involved resource
	ID *string
	// Message of error
	Message string
}

type LinkT struct {
	// relation type
	Rel string
	// mime type
	Type string
	// web link
	Href string
}

type ListMetaRT struct {
	// List of metadata records
	Items []*MetadataListItemRT
	// Entity for which to request metadata
	Entity *string
	// Optional schema to filter on
	Schema *string
	// Optional json path to further filter on returned list
	AspectPath *string
	// Time at which this list was valid
	AtTime *string
	Links  []*LinkT
}

type ListPayload struct {
	// Entity for which to request metadata
	EntityID *string `json:"entity-id,omitempty"`
	// Schema prefix using '%' as wildcard indicator
	Schema *string
	// To learn more about the supported format, see
	// https://www.postgresql.org/docs/current/datatype-json.html#DATATYPE-JSONPATH
	AspectPath *string `json:"aspect-path,omitempty"`
	// Return metadata which where valid at that time [now]
	AtTime *string `json:"at-time,omitempty"`
	// The 'limit' system query option requests the number of items in the queried
	// collection to be included in the result.
	Limit int
	// The 'filter' system query option allows clients to filter a collection of
	// resources that are addressed by a request URL. The expression specified with
	// 'filter'
	// is evaluated for each resource in the collection, and only items where the
	// expression
	// evaluates to true are included in the response.
	Filter string
	// The 'orderby' query option allows clients to request resources in either
	// ascending order using asc or descending order using desc. If asc or desc not
	// specified,
	// then the resources will be ordered in ascending order. The request below
	// orders Trips on
	// property EndsAt in descending order.
	OrderBy string `json:"order-by,omitempty"`
	// When set order result in descending order. Ascending order is the default.
	OrderDesc *bool `json:"order-desc,omitempty"`
	// When set, also include aspect content in list.
	IncludeContent bool `json:"include-content,omitempty"`
	// The content of '$page' is returned in the 'links' part of a previous query
	// and
	// will when set, ALL other parameters, except for 'limit' are ignored.
	Page *string
	// JWT used for authentication
	JWT string
}

type MetadataListItemRT struct {
	// ID
	ID string
	// Entity ID
	Entity string
	// Schema ID
	Schema string
	// Attached metadata aspect
	Aspect any
	// If aspectPath was defined, this is what matched the query
	AspectContext *string
}

type MetadataRecordRT struct {
	// ID
	ID string
	// Entity ID
	Entity string
	// Schema ID
	Schema string
	// Attached metadata aspect
	Aspect any
	// Time this record was asserted
	ValidFrom string
	// Time this record was retracted
	ValidTo *string
	// Entity asserting this metadata record at 'valid-from'
	Asserter string
	// Entity revoking this record at 'valid-to'
	Revoker *string
	Links   []*LinkT
}

type NotImplementedT struct {
	// Information message
	Message string
}

type ReadPayload struct {
	// ID of metadata to show
	ID string
	// JWT used for authentication
	JWT string
}

type ResourceNotFoundT struct {
	// ID of missing resource
	ID string
	// Message of error
	Message string
}

type RevokePayload struct {
	// Record ID to restract
	ID *string
	// JWT used for authentication
	JWT string
}

type Service interface {
	// Show metadata by ID
	Read(context.Context, *ReadPayload) (res *MetadataRecordRT, err error)
	// Return a list of metadata records.
	List(context.Context, *ListPayload) (res *ListMetaRT, err error)
	// Attach new metadata to an entity.
	Add(context.Context, *AddPayload) (res *AddMetaRT, err error)
	// Revoke this record and create a new one with the information provided.
	// For any field not provided, the value from the current record is used.
	UpdateRecord(context.Context, *UpdateRecordPayload) (res *AddMetaRT, err error)
	// Retract a previously created statement.
	Revoke(context.Context, *RevokePayload) (err error)
}

type ServiceNotAvailableT struct {
}

type UnauthorizedT struct {
}

type UpdateRecordPayload struct {
	// Record ID to update
	ID string
	// Entity to which attach metadata
	EntityID *string `json:"entity-id,omitempty"`
	// Schema of metadata
	Schema *string
	// Aspect content
	Aspect any
	// Content-Type header, MUST be of application/json.
	ContentType *string `json:"content-type,omitempty"`
	// Policy guiding visibility and actions performed
	PolicyID *string `json:"policy-id,omitempty"`
	// JWT used for authentication
	JWT string
}