Skip to content

Commit

Permalink
Document search_results_exceed_configured_limit
Browse files Browse the repository at this point in the history
... 403 error with OpenAPI
  • Loading branch information
eduardoj committed Mar 21, 2023
1 parent d0cc365 commit b0569a3
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions src/api/public/apidocs-new/paths/search_request.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -217,6 +217,25 @@ get:
summary: unable to evaluate 'foo' for 'requests'
'401':
$ref: '../components/responses/unauthorized.yaml'
'403':
description: |
Forbidden.
XML Schema used for body validation: [status.xsd](../schema/status.xsd).
content:
application/xml; charset=utf-8:
schema:
$ref: '../components/schemas/api_response.yaml'
example:
code: search_results_exceed_configured_limit
summary: |
The number of results returned by the performed search exceeds the configured limit.
You can:
- retrieve only the ids by using an '/search/.../id' API endpoint, or
- reduce the number of matches of your search:
- paginating your results, through the 'limit' and 'offset' parameters, or
- adjusting your `match` expression.
tags:
- Search

Expand Down

0 comments on commit b0569a3

Please sign in to comment.