search

Documentation

Index

• type SearchOptions
• type SearchRequest
  • func (r SearchRequest) Search() (searchResp SearchResponse, err error)
• type SearchRequestBody
• type SearchResponse

Types

type SearchOptions

type SearchOptions struct {
	IgnoreHits          bool `json:"ignore_hits"`
	IgnoreHighlightHits bool `json:"ignore_highlight_hits"`
	IgnoreIDList        bool `json:"ignore_id_list"`
	WithThumbnails      bool `json:"with_thumbnails"`
}

SearchOptions is the options for showing search responses

type SearchRequest

type SearchRequest struct {
	Method      string
	Url         string
	Token       string
	RequestBody *SearchRequestBody
}

func (SearchRequest) Search

func (r SearchRequest) Search() (searchResp SearchResponse, err error)

type SearchRequestBody

type SearchRequestBody struct {
	Query   string                 `json:"query"`
	Params  map[string]interface{} `json:"params"`
	Options SearchOptions          `json:"options"`
}

SearchRequestBody is the expected request body for search route

type SearchResponse

type SearchResponse struct {
	Page        int          `json:"page"`
	NbHits      int          `json:"nbHits"`
	NbPage      int          `json:"nbPages"`
	HitsPerPage int          `json:"hitsPerPage`
	IdList      []string     `json:"idList"`
	Hits        []synq.Asset `json:"hits"`
}