Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in
Toggle navigation
Menu
Open sidebar
subugoe
ahiqar
api-documentation
Commits
f990e291
Commit
f990e291
authored
Aug 11, 2021
by
Mathias Goebel
🎠
Browse files
feat: add total stats
parent
8e0c82c0
Changes
1
Hide whitespace changes
Inline
Side-by-side
content/page/search-api-specs.md
View file @
f990e291
...
...
@@ -120,7 +120,9 @@ This object is specified according to the [Elasticsearch Query DSL](https://www.
| Field Name | Cardinality | Type | Description |
|----|----|----|----|
| value | 1 | int | number of total hits |
| value | 1 | int | number of total hits (in this scope: pages) |
| manifests | 1 | int | total number of distinct manifests in hits |
| matches | 1 | int | total number of matches (equal to the sum of all values from
`occurrencesOnPage`
) |
| relation | 1 | string |
`eq`
(from Elasticsearch), means that there are exactly this number of total hits available |
### Hits Array
...
...
@@ -148,7 +150,9 @@ This describes a single object from the `hits` array that MUST be present but MA
"hits"
:
{
"total"
:
{
"value"
:
2
,
"relation"
:
"eq"
"relation"
:
"eq"
,
"manifests"
:
2
,
"matches"
:
5
},
"hits"
:
[
{
"item"
:
"/api/textapi/ahikar/syriac/3r678-186v/latest/item.json"
,
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment