Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix rosie REST API docs #2334

Merged
merged 1 commit into from
May 10, 2019
Merged

fix rosie REST API docs #2334

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions sphinx/api/rosie-web.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ REST API
Example Request
.. code-block:: http

GET http://host/my_prefix/get_known/keys?format=json HTTP/1.1
GET http://host/my_prefix/get_known_keys?format=json HTTP/1.1

Example Response
.. code-block:: json
Expand Down Expand Up @@ -91,7 +91,7 @@ REST API
Return a list of suites matching all search terms.

:arg str prefix: Repository prefix.
:param list query: List of queries.
:param list q: List of queries.
:param string format: Desired return format (``json`` or ``None``).
:param flag all_revs: Switch on searching older revisions of current suites
and deleted suites.
Expand Down Expand Up @@ -141,7 +141,7 @@ REST API
Return a list of suites matching one or more search terms.

:arg str prefix: Repository prefix.
:param list search: List of queries in the same format as
:param list s: List of queries in the same format as
:http:get:`(str:prefix)/query`
:param string format: Desired return format (``json`` or ``None``).
:param flag all_revs: Switch on searching older revisions of current suites
Expand All @@ -152,7 +152,7 @@ REST API

.. code-block:: http

GET http://host/my_prefix/search?var+bob+nowcast&format=json HTTP/1.1
GET http://host/my_prefix/search/?s=var+bob+nowcast&format=json HTTP/1.1

Example Response
.. code-block:: json
Expand Down