Documentation
¶
Overview ¶
Package search owns the metadata-backed settings and customization search indexes and the HTTP surface for customization search.
Index ¶
- func BuildCategories[T any](profile searchtypes.Profile) []category.Category
- func RegisterCustomize(api huma.API, customizeSearchService *CustomizeSearchService)
- func Search(categories []category.Category, query string, profile searchtypes.Profile) searchtypes.Response
- type CustomizeHandler
- type CustomizeItem
- type CustomizeSearchService
- type CustomizeVariable
- type GetCustomizeCategoriesInput
- type GetCustomizeCategoriesOutput
- type Module
- type SearchCustomizeInput
- type SearchCustomizeOutput
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func BuildCategories ¶ added in v2.10.2
func BuildCategories[T any](profile searchtypes.Profile) []category.Category
BuildCategories extracts searchable metadata in model field order.
func RegisterCustomize ¶
func RegisterCustomize(api huma.API, customizeSearchService *CustomizeSearchService)
RegisterCustomize registers customization endpoints using Huma.
func Search ¶ added in v2.10.2
func Search(categories []category.Category, query string, profile searchtypes.Profile) searchtypes.Response
Search matches category metadata using the selected ranking profile.
Types ¶
type CustomizeHandler ¶
type CustomizeHandler struct {
// contains filtered or unexported fields
}
CustomizeHandler handles customization search endpoints.
func (*CustomizeHandler) GetCategories ¶
func (h *CustomizeHandler) GetCategories(ctx context.Context, input *GetCustomizeCategoriesInput) (*GetCustomizeCategoriesOutput, error)
GetCategories returns all available customization categories.
func (*CustomizeHandler) Search ¶
func (h *CustomizeHandler) Search(ctx context.Context, input *SearchCustomizeInput) (*SearchCustomizeOutput, error)
Search searches customization options by query.
type CustomizeItem ¶ added in v2.8.1
type CustomizeItem struct {
// Defaults category
DefaultProjectTemplate CustomizeVariable `` /* 213-byte string literal not displayed */
DefaultContainerSettings CustomizeVariable `` /* 222-byte string literal not displayed */
DefaultNetworkMode CustomizeVariable `` /* 201-byte string literal not displayed */
// Templates category
CustomTemplates CustomizeVariable `` /* 346-byte string literal not displayed */
TemplateCategories CustomizeVariable `` /* 196-byte string literal not displayed */
TemplateValidation CustomizeVariable `` /* 190-byte string literal not displayed */
// Registries category
ContainerRegistries CustomizeVariable `` /* 363-byte string literal not displayed */
RegistryCredentials CustomizeVariable `` /* 218-byte string literal not displayed */
RegistryMirrors CustomizeVariable `` /* 187-byte string literal not displayed */
// Variables category
GlobalVariables CustomizeVariable `` /* 346-byte string literal not displayed */
SecretVariables CustomizeVariable `` /* 196-byte string literal not displayed */
VariableTemplates CustomizeVariable `` /* 202-byte string literal not displayed */
// Git repositories category
GitRepositories CustomizeVariable `` /* 398-byte string literal not displayed */
GitRepositoryDefaults CustomizeVariable `` /* 220-byte string literal not displayed */
GitRepositoryTemplates CustomizeVariable `` /* 205-byte string literal not displayed */
}
CustomizeItem represents a customization configuration item This struct uses reflection tags to define customization categories and metadata Categories must be grouped together and use `catmeta` tag for category-level metadata
type CustomizeSearchService ¶
type CustomizeSearchService struct {
// contains filtered or unexported fields
}
func NewCustomizeSearchService ¶
func NewCustomizeSearchService() *CustomizeSearchService
func (*CustomizeSearchService) GetCustomizeCategories ¶
func (s *CustomizeSearchService) GetCustomizeCategories() []category.Category
GetCustomizeCategories returns the category index initialized by the service.
type CustomizeVariable ¶ added in v2.8.1
type CustomizeVariable struct {
Value string
}
type GetCustomizeCategoriesInput ¶
type GetCustomizeCategoriesInput struct{}
type Module ¶
type Module struct {
// contains filtered or unexported fields
}
Module owns the customization search index and mounts the customization search routes.
func (*Module) CustomizeService ¶
func (m *Module) CustomizeService() *CustomizeSearchService
CustomizeService exposes the customization search index to direct collaborators.
func (*Module) RegisterRoutes ¶
RegisterRoutes mounts customization search endpoints for runtime and schema discovery.
type SearchCustomizeInput ¶
type SearchCustomizeInput struct {
Body searchtypes.Request
}
type SearchCustomizeOutput ¶
type SearchCustomizeOutput struct {
Body searchtypes.Response
}