tools

package
v0.0.23 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 30, 2025 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewAskDadTool

func NewAskDadTool(collibraClient *http.Client) *chip.Tool[AskDadInput, AskDadOutput]

func NewAskGlossaryTool

func NewAskGlossaryTool(collibraHttpClient *http.Client) *chip.Tool[AskGlossaryInput, AskGlossaryOutput]

func NewAssetDetailsTool

func NewAssetDetailsTool(collibraClient *http.Client) *chip.Tool[AssetDetailsInput, AssetDetailsOutput]

func NewListAssetTypesTool

func NewListAssetTypesTool(collibraClient *http.Client) *chip.Tool[ListAssetTypesInput, ListAssetTypesOutput]

func NewListDataContractsTool

func NewListDataContractsTool(collibraClient *http.Client) *chip.Tool[ListDataContractsInput, ListDataContractsOutput]

func NewSearchDataClassesTool

func NewSearchDataClassesTool(collibraClient *http.Client) *chip.Tool[SearchDataClassesInput, SearchDataClassesOutput]

func NewSearchKeywordTool

func NewSearchKeywordTool(collibraClient *http.Client) *chip.Tool[SearchKeywordInput, SearchKeywordOutput]

func RegisterAll

func RegisterAll(server *chip.Server, client *http.Client, toolConfig *chip.ToolConfig)

Types

type AddDataClassificationMatchInput

type AddDataClassificationMatchInput struct {
	AssetID          string `json:"assetId" jsonschema:"Required. The UUID of the asset to classify (e.g., '9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8')"`
	ClassificationID string `` /* 149-byte string literal not displayed */
}

type AddDataClassificationMatchOutput

type AddDataClassificationMatchOutput struct {
	Match   *clients.DataClassificationMatch `json:"match,omitempty" jsonschema:"The created classification match with all its properties"`
	Success bool                             `json:"success" jsonschema:"Whether the classification was successfully applied to the asset"`
	Error   string                           `json:"error,omitempty" jsonschema:"Error message if the operation failed"`
}

type AskDadInput

type AskDadInput struct {
	Question string `json:"input" jsonschema:"the question to ask the data asset discovery agent"`
}

type AskDadOutput

type AskDadOutput struct {
	Answer string `json:"output" jsonschema:"the answer from the data asset discovery agent"`
}

type AskGlossaryInput

type AskGlossaryInput struct {
	Question string `json:"input" jsonschema:"the question to ask the business glossary agent"`
}

type AskGlossaryOutput

type AskGlossaryOutput struct {
	Answer string `json:"output" jsonschema:"the answer from the business glossary agent"`
}

type AssetDetailsInput

type AssetDetailsInput struct {
	AssetID                 string `json:"assetId" jsonschema:"the UUID of the asset to retrieve details for"`
	OutgoingRelationsCursor string `` /* 189-byte string literal not displayed */
	IncomingRelationsCursor string `` /* 189-byte string literal not displayed */
}

type AssetDetailsOutput

type AssetDetailsOutput struct {
	Asset *clients.Asset `json:"asset,omitempty" jsonschema:"the detailed asset information if found"`
	Link  string         `json:"link,omitempty" jsonschema:"the link you can navigate to in Collibra to view the asset"`
	Error string         `json:"error,omitempty" jsonschema:"error message if asset not found or other error occurred"`
	Found bool           `json:"found" jsonschema:"whether the asset was found"`
}

type AssetType

type AssetType struct {
	ID                 string `json:"id" jsonschema:"The unique identifier of the asset type"`
	Name               string `json:"name" jsonschema:"The name of the asset type"`
	Description        string `json:"description,omitempty" jsonschema:"The description of the asset type"`
	PublicId           string `json:"publicId,omitempty" jsonschema:"The public id of the asset type"`
	DisplayNameEnabled bool   `json:"displayNameEnabled" jsonschema:"Whether display name is enabled for assets of this type"`
	RatingEnabled      bool   `json:"ratingEnabled" jsonschema:"Whether rating is enabled for assets of this type"`
	FinalType          bool   `json:"finalType" jsonschema:"Whether the ability to create child asset types is locked"`
	System             bool   `json:"system" jsonschema:"Whether this is a system asset type"`
	Product            string `json:"product,omitempty" jsonschema:"The product to which this asset type is linked"`
}

type DataContract

type DataContract struct {
	ID         string `json:"id" jsonschema:"The UUID of the data contract asset"`
	DomainID   string `json:"domainId" jsonschema:"The UUID of the domain where the data contract asset is located"`
	ManifestID string `json:"manifestId" jsonschema:"The unique identifier of the data contract manifest"`
}

type ListAssetTypesInput

type ListAssetTypesInput struct {
	Limit  int `` /* 131-byte string literal not displayed */
	Offset int `json:"offset,omitempty" jsonschema:"Optional. Index of first result (pagination offset). Default: 0."`
}

type ListAssetTypesOutput

type ListAssetTypesOutput struct {
	Total      int64       `json:"total" jsonschema:"The total number of asset types available matching the search criteria"`
	Offset     int64       `json:"offset" jsonschema:"The offset for the results"`
	Limit      int64       `json:"limit" jsonschema:"The maximum number of results returned"`
	AssetTypes []AssetType `json:"assetTypes" jsonschema:"The list of asset types"`
}

type ListDataContractsInput

type ListDataContractsInput struct {
	ManifestFilter string `json:"manifestId,omitempty" jsonschema:"Optional. Filter by the unique identifier of the Data Contract manifest."`
	Cursor         string `` /* 192-byte string literal not displayed */
	Limit          int    `` /* 130-byte string literal not displayed */
}

type ListDataContractsOutput

type ListDataContractsOutput struct {
	Total      *int           `` /* 150-byte string literal not displayed */
	Limit      int            `json:"limit" jsonschema:"The maximum number of results returned"`
	NextCursor string         `` /* 131-byte string literal not displayed */
	Contracts  []DataContract `json:"contracts" jsonschema:"The list of data contracts"`
}

type PullDataContractManifestInput

type PullDataContractManifestInput struct {
	DataContractID string `` /* 190-byte string literal not displayed */
}

type PullDataContractManifestOutput

type PullDataContractManifestOutput struct {
	Manifest string `json:"manifest,omitempty" jsonschema:"The content of the active data contract manifest file"`
	Error    string `json:"error,omitempty" jsonschema:"Error message if the manifest could not be retrieved"`
	Found    bool   `json:"found" jsonschema:"Whether the manifest was found"`
}

type PushDataContractManifestInput

type PushDataContractManifestInput struct {
	ManifestID string `` /* 277-byte string literal not displayed */
	Manifest   string `json:"manifest" jsonschema:"The content of the data contract manifest file"`
	Version    string `` /* 270-byte string literal not displayed */
	Force      bool   `` /* 316-byte string literal not displayed */
	Active     bool   `` /* 282-byte string literal not displayed */
}

type PushDataContractManifestOutput

type PushDataContractManifestOutput struct {
	ID         string `json:"id,omitempty" jsonschema:"The UUID of the data contract asset"`
	DomainID   string `json:"domainId,omitempty" jsonschema:"The UUID of the domain where the data contract asset is located"`
	ManifestID string `json:"manifestId,omitempty" jsonschema:"The unique identifier of the data contract manifest"`
	Error      string `json:"error,omitempty" jsonschema:"Error message if the manifest could not be uploaded"`
	Success    bool   `json:"success" jsonschema:"Whether the manifest was successfully uploaded"`
}

type RemoveDataClassificationMatchInput

type RemoveDataClassificationMatchInput struct {
	ClassificationMatchID string `` /* 145-byte string literal not displayed */
}

type RemoveDataClassificationMatchOutput

type RemoveDataClassificationMatchOutput struct {
	Success bool   `json:"success" jsonschema:"Whether the classification match was successfully removed"`
	Error   string `json:"error,omitempty" jsonschema:"Error message if the operation failed"`
}

type SearchClassificationMatchesInput

type SearchClassificationMatchesInput struct {
	AssetIDs          []string `` /* 141-byte string literal not displayed */
	Statuses          []string `` /* 132-byte string literal not displayed */
	ClassificationIDs []string `` /* 148-byte string literal not displayed */
	AssetTypeIDs      []string `` /* 135-byte string literal not displayed */
	Limit             int      `json:"limit,omitempty" jsonschema:"Optional. Maximum number of results to return. The maximum value is 1000. Default: 50."`
	Offset            int      `json:"offset,omitempty" jsonschema:"Optional. Index of first result (pagination offset). Default: 0."`
	CountLimit        int      `` /* 163-byte string literal not displayed */
}

type SearchClassificationMatchesOutput

type SearchClassificationMatchesOutput struct {
	Total                 int                               `json:"total" jsonschema:"Total number of matching classification matches"`
	Count                 int                               `json:"count" jsonschema:"Number of classification matches returned in this response"`
	ClassificationMatches []clients.DataClassificationMatch `json:"classificationMatches" jsonschema:"List of classification matches"`
	Error                 string                            `json:"error,omitempty" jsonschema:"HTTP or other error message if the request failed"`
}

type SearchDataClassesInput

type SearchDataClassesInput struct {
	Name          string `` /* 156-byte string literal not displayed */
	Description   string `` /* 166-byte string literal not displayed */
	ContainsRules bool   `` /* 194-byte string literal not displayed */
	Limit         int    `json:"limit,omitempty" jsonschema:"Optional. Maximum number of results to return. The maximum value is 1000. Default: 50."`
	Offset        int    `json:"offset,omitempty" jsonschema:"Optional. Index of first result (pagination offset). Default: 0."`
}

type SearchDataClassesOutput

type SearchDataClassesOutput struct {
	Total       int                 `json:"total" jsonschema:"Total number of matching data classes"`
	Count       int                 `json:"count" jsonschema:"Number of data classes returned in this response"`
	DataClasses []clients.DataClass `json:"dataClasses" jsonschema:"List of data classes"`
	Error       string              `json:"error,omitempty" jsonschema:"HTTP or other error message if the request failed"`
}

type SearchKeywordInput

type SearchKeywordInput struct {
	Query               string   `json:"query" jsonschema:"Required. The keyword query to search for."`
	Limit               int      `json:"limit,omitempty" jsonschema:"Optional. Maximum number of results to return. The maximum value is 1000. Default: 50."`
	Offset              int      `json:"offset,omitempty" jsonschema:"Optional. Index of first result (pagination offset). Default: 0."`
	ResourceTypeFilters []string `` /* 245-byte string literal not displayed */
	CommunityFilter     []string `json:"communityFilter,omitempty" jsonschema:"Optional. Filter by resources within the specified community UUIDs."`
	DomainFilter        []string `json:"domainFilter,omitempty" jsonschema:"Optional. Filter by resources within the specified domain UUIDs."`
	DomainTypeFilter    []string `json:"domainTypeFilter,omitempty" jsonschema:"Optional. Filter by resources with the specified domain type UUIDs."`
	AssetTypeFilter     []string `json:"assetTypeFilter,omitempty" jsonschema:"Optional. Filter by resources with the specified asset type UUIDs."`
	StatusFilter        []string `json:"statusFilter,omitempty" jsonschema:"Optional. Filter by resources with the specified status UUIDs."`
	CreatedByFilter     []string `json:"createdByFilter,omitempty" jsonschema:"Optional. Filter by resources created by the specified user UUIDs."`
}

type SearchKeywordOutput

type SearchKeywordOutput struct {
	Total   int                     `json:"total" jsonschema:"The total number of results available matching the search criteria"`
	Results []SearchKeywordResource `json:"results" jsonschema:"The list of search results"`
}

type SearchKeywordResource

type SearchKeywordResource struct {
	ResourceType   string `json:"resourceType" jsonschema:"The type of the resource (e.g., Asset, Domain, Community, User, UserGroup)"`
	ID             string `json:"id" jsonschema:"The unique identifier of the resource"`
	CreatedBy      string `json:"createdBy" jsonschema:"The user who created the resource"`
	CreatedOn      string `json:"createdOn" jsonschema:"The timestamp when the resource was created (human-readable format)"`
	LastModifiedOn string `json:"lastModifiedOn" jsonschema:"The timestamp when the resource was last modified (human-readable format)"`
	Name           string `json:"name" jsonschema:"The name of the resource"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL