package
1.49.2
Repository: https://github.com/onsdigital/dp-search-api.git
Documentation: pkg.go.dev

# Functions

No description provided by the author
No description provided by the author
CreateRequests reads the parameters from the request and generates the corresponding SearchRequest and CountRequest If any validation fails, the http.Error is already handled, and nil is returned: in this case the caller may return straight away.
LegacySearchHandlerFunc returns a http handler function handling search api requests.
NewClientList returns a new ClientList obj with all available clients.
NewSearchAPI returns a new Search API struct after registering the routes.
SearchHandlerFunc returns a http handler function handling search api requests.
SearchReleasesHandlerFunc returns a http handler function handling release calendar search api requests.
SearchURIsHandlerFunc handles the /search/uris endpoint.

# Constants

contains the special characters that are allowed in query validation.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

AuthHandlerMock is a mock implementation of AuthHandler.
ClientList is a struct obj of all the clients the service is dependent on.
DpElasticSearcherMock is a mock implementation of DpElasticSearcher.
ElasticSearcherMock is a mock implementation of ElasticSearcher.
QueryBuilderMock is a mock implementation of QueryBuilder.
QueryParamValidatorMock is a mock implementation of QueryParamValidator.
ReleaseQueryBuilderMock is a mock implementation of ReleaseQueryBuilder.
ReleaseResponseTransformerMock is a mock implementation of ReleaseResponseTransformer.
ResponseTransformerMock is a mock implementation of ResponseTransformer.
SearchAPI provides an API around elasticseach.
No description provided by the author

# Interfaces

AuthHandler provides authorisation checks on requests.
DpElasticSearcher provides an interface for the dp-elasticsearch functionality.
ElasticSearcher provides client methods for the elasticsearch package - now deprecated, due to be replaced with the methods in dp-elasticsearch.
QueryBuilder provides methods for the search package.
QueryParamValidator provides an interface to validate api query parameters (used for /search/releases).
ReleaseQueryBuilder provides an interface to build a search query for the Release content type.
No description provided by the author
ResponseTransformer provides methods for the transform package.