Skip to content
This repository has been archived by the owner on Jan 29, 2022. It is now read-only.

Commit

Permalink
Fix description of search endpoint
Browse files Browse the repository at this point in the history
We do support all of ElasticSearch query strings, including "AND" and "OR"
  • Loading branch information
vitorbaptista committed Oct 7, 2016
1 parent 3d2e42d commit e67e631
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions api/swagger/swagger.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,10 @@ paths:
get:
tags:
- trials
description: Find trials using a simple keyword(s) based search. At the moment, operators (`AND`, `OR`)are not implemented.
If the results span across multiple pages, use the `page` parameter to request a specific page and `per_page`
to alter the number of results returned on a single page.
description: Returns trials based on a search query. By default, it'll search in all of a trial's attributes.

- `q` can be a simple string search or an
[Elasticsearch query string](https://www.elastic.co/guide/en/elasticsearch/reference/2.3/query-dsl-query-string-query.html#query-string-syntax)
- `q` is a [ElasticSearch query
string](https://www.elastic.co/guide/en/elasticsearch/reference/2.3/query-dsl-query-string-query.html#query-string-syntax)
(e.g. `public_title:(depressive OR depression)`)

- `page` can take a value between `1` and `100`
Expand All @@ -34,7 +32,7 @@ paths:
parameters:
- name: q
in: query
description: The [search query](https://www.elastic.co/guide/en/elasticsearch/reference/2.3/query-dsl-query-string-query.html#query-string-syntax)
description: The search query (follows the [ElasticSearch Query String](https://www.elastic.co/guide/en/elasticsearch/reference/2.3/query-dsl-query-string-query.html#query-string-syntax) syntax)
type: string
- name: page
in: query
Expand Down

0 comments on commit e67e631

Please sign in to comment.