search

Documentation

Index

• type Client
  • func NewClient(searchAPIURL string) *Client
  • func (c *Client) Checker(ctx context.Context, check *health.CheckState) error
  • func (c *Client) GetSearch(ctx context.Context, query url.Values) (r Response, err error)
• type ContentType
• type ErrInvalidSearchResponse
  • func NewSearchErrorResponse(resp *http.Response, uri string) (e *ErrInvalidSearchResponse)
  • func (e ErrInvalidSearchResponse) Code() int
  • func (e ErrInvalidSearchResponse) Error() string
• type Response

Types

type Client

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

Client is a dp-search-query client which can be used to make requests to the server

func NewClient

func NewClient(searchAPIURL string) *Client

NewClient creates a new instance of Client with a given search-query api url

func (*Client) Checker

func (c *Client) Checker(ctx context.Context, check *health.CheckState) error

Checker calls search api health endpoint and returns a check object to the caller.

func (*Client) GetSearch

func (c *Client) GetSearch(ctx context.Context, query url.Values) (r Response, err error)

GetSearch returns the search results

type ContentType

type ContentType struct {
	Type  string `json:"type"`
	Count int    `json:"count"`
}

ContentType represents the specific content type for the search results with its respective count

type ErrInvalidSearchResponse

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

ErrInvalidSearchResponse is returned when the dp-search-query does not respond with a valid status

func NewSearchErrorResponse

func NewSearchErrorResponse(resp *http.Response, uri string) (e *ErrInvalidSearchResponse)

NewSearchErrorResponse creates an error response

func (ErrInvalidSearchResponse) Code

func (e ErrInvalidSearchResponse) Code() int

Code returns the status code received from dp-search-query if an error is returned

func (ErrInvalidSearchResponse) Error

func (e ErrInvalidSearchResponse) Error() string

Error should be called by the user to print out the stringified version of the error

type Response

type Response struct {
	Count        int           `json:"count"`
	ContentTypes []ContentType `json:"content_types"`
	Items        []contentItem `json:"items"`
	Suggestions  []string      `json:"suggestions,omitempty"`
}

Response represents the fields for the search results as returned by dp-search-query