package
0.0.0-20200729170929-f24859d2cf71
Repository: https://github.com/onsdigital/dp-census-dataset-search-api.git
Documentation: pkg.go.dev

# Functions

ErrorInvalidTopics - return error.
ErrorMaximumOffsetReached - return error.
ValidateDimensions checks the values in dimensions are valid for querying elasticsearch API.
ValidateTopics checks the values in topics are valid.

# Structs

Body represents the request body to elasticsearch.
Bool represents the desirable goals for query.
Dimension represents an object containing dimension data.
No description provided by the author
No description provided by the author
DimensionObject represents the structure of a dimension.
DimensionsDoc represents a list of dimensions.
Filter represents the filtering object (can only contain eiter term or terms but not both).
Highlight represents parts of the fields that matched.
No description provided by the author
No description provided by the author
Match represents the fields that the term should or must match within query.
Matches represents a list of members and their arrays of character offsets that matched the search term.
Nested represents a nested query object.
NestedQuery represents ...
Object represents an empty object (as expected by elasticsearch).
PageVariables are the necessary fields to determine paging.
Query represents the request query details.
Score contains the ordering of the score (ascending or descending).
Scores represents a list of scoring, e.g.
No description provided by the author
SearchResult represents data on a single item of search results.
SearchResults represents a structure for a list of returned objects.
Taxonomy represents the hierarchy of topics.
Topic represents the topic data and relates to child topics.