datahubapi

type Bridge interface {
	Connections() []Connection
	Reader(conn string) (Reader, bool)
	Writer(conn string) (Writer, bool)
}

type Connection struct {
	Name     string `json:"name"`
	Writable bool   `json:"writable"`
}

type Deps struct {
	Bridge          Bridge
	PersonaResolver portal.PersonaResolver
	AdminRoles      []string
	Audit           audit.Logger
}

type DocumentInput struct {
	ID        string `json:"id,omitempty"`
	EntityURN string `json:"entity_urn,omitempty"`
	Title     string `json:"title"`
	Content   string `json:"content"`
	Category  string `json:"category,omitempty"`
}

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

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

type OwnerChange struct {
	OwnerURN      string `json:"owner_urn"`
	OwnershipType string `json:"ownership_type,omitempty"`
}

type Reader interface {
	ResolveURN(ctx context.Context, urn string) (*semantic.TableIdentifier, error)
	GetTableContext(ctx context.Context, table semantic.TableIdentifier) (*semantic.TableContext, error)
	GetColumnsContext(ctx context.Context, table semantic.TableIdentifier) (map[string]*semantic.ColumnContext, error)
	SearchTables(ctx context.Context, filter semantic.SearchFilter) ([]semantic.TableSearchResult, error)
	SearchTags(ctx context.Context, query string, limit int) ([]semantic.EntityRef, error)
	SearchGlossaryTerms(ctx context.Context, query string, limit int) ([]semantic.EntityRef, error)
	ListDomains(ctx context.Context) ([]semantic.EntityRef, error)
	ListRootGlossaryNodes(ctx context.Context, offset, limit int) ([]semantic.GlossaryNode, int, error)
	ListRootGlossaryTerms(ctx context.Context, offset, limit int) ([]semantic.GlossaryTerm, int, error)
	ListGlossaryNodeChildren(ctx context.Context, nodeURN string, offset, limit int) (*semantic.GlossaryChildren, error)
	GetGlossaryParentChain(ctx context.Context, urn string) ([]semantic.GlossaryNode, error)
	// GetGlossaryTerm reads one term by URN (#1159). It is the only by-URN read
	// any governance vocabulary has upstream: a tag or a domain resolves only by
	// listing its vocabulary and matching, which is what shapes the label
	// resolver in labels.go and the deep-link paths in the portal.
	GetGlossaryTerm(ctx context.Context, urn string) (*semantic.GlossaryTerm, error)
	SearchDocuments(ctx context.Context, query string, limit int) ([]semantic.DocumentResult, error)
	BrowseDocuments(ctx context.Context, offset, limit int) ([]semantic.DocumentResult, int, error)
	GetDocument(ctx context.Context, urn string) (*semantic.DocumentResult, error)
	// GetRelatedDocuments returns the context documents attached to one entity
	// (#1158), which the corpus-wide browse and search reads cannot express.
	GetRelatedDocuments(ctx context.Context, urn string) ([]semantic.DocumentResult, error)
}

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

type Writer interface {
	UpdateDescription(ctx context.Context, urn, description string) error
	ApplyTagChanges(ctx context.Context, urn string, add, remove []string) error
	ApplyGlossaryTermChanges(ctx context.Context, urn string, add, remove []string) error
	ApplyOwnerChanges(ctx context.Context, urn string, add []OwnerChange, remove []string) error
	SetDomain(ctx context.Context, entityURN, domainURN string) error
	UnsetDomain(ctx context.Context, entityURN string) error
	// CreateGlossaryNode adds a directory to the business glossary, under
	// parentNode or at the root when it is empty, returning the new node's URN
	// (#1155).
	CreateGlossaryNode(ctx context.Context, name, definition, parentNode string) (string, error)
	// CreateGlossaryTerm adds a term to the business glossary, under parentNode
	// or at the root when it is empty, returning the new term's URN (#1158).
	// Editing a term's definition is UpdateDescription with the term's URN,
	// which is why there is no term-specific update here.
	CreateGlossaryTerm(ctx context.Context, name, definition, parentNode string) (string, error)
	// DeleteGlossaryEntity retires a glossary term or node. Upstream is one call
	// for both kinds, and it removes neither a node's children nor a term's
	// assignments, which is why the portal shows both before offering the delete.
	DeleteGlossaryEntity(ctx context.Context, urn string) error
	// CreateTag defines a new tag and returns its URN (#1156). Editing a tag's
	// description is UpdateDescription with the tag's URN, which is why there is
	// no tag-specific update here.
	CreateTag(ctx context.Context, name, description string) (string, error)
	// DeleteTag removes a tag definition. Nothing here checks what still carries
	// the tag, which is why the portal shows a tag's current usage before
	// offering the delete.
	DeleteTag(ctx context.Context, tagURN string) error
	// CreateDomain defines a new domain and returns its URN (#1157). Editing a
	// domain's description is UpdateDescription with the domain's URN, and
	// moving a table into or out of a domain is SetDomain/UnsetDomain, which is
	// why neither has a domain-specific method here.
	CreateDomain(ctx context.Context, name, description string) (string, error)
	// DeleteDomain removes a domain definition. Nothing here clears the domain
	// from the tables that carry it, which is why the portal shows a domain's
	// current membership before offering the delete.
	DeleteDomain(ctx context.Context, domainURN string) error
	UpsertContextDocument(ctx context.Context, in DocumentInput) (*semantic.DocumentResult, error)
	DeleteContextDocument(ctx context.Context, documentID string) error
}