search

package
v2.10.2 Latest Latest
Warning

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

Go to latest
Published: Sep 5, 2026 License: BSD-3-Clause Imports: 1 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Profile added in v2.10.2

type Profile uint8

Profile selects the metadata defaults and ranking rules for a search surface.

const (
	SettingsProfile Profile = iota + 1
	CustomizeProfile
)

type Request

type Request struct {
	// Query is the search query string.
	//
	// Required: true
	Query string `json:"query" binding:"required,min=1"`
}

Request represents a search request.

type Response

type Response struct {
	// Results is a list of categories matching the search query.
	//
	// Required: true
	Results []category.Category `json:"results"`

	// Query is the search query that was executed.
	//
	// Required: true
	Query string `json:"query"`

	// Count is the number of results returned.
	//
	// Required: true
	Count int `json:"count"`
}

Response represents the results of a search.

Jump to

Keyboard shortcuts

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