Skip to content

Commit

Permalink
tried to be more concise and avoid the occurrence of two colons in a …
Browse files Browse the repository at this point in the history
…single sentence
  • Loading branch information
paulflang committed Feb 11, 2019
1 parent f827d5d commit bef2563
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/rest_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@ The REST JSON API enables researchers to programmatically validate and calculate

The base URL for the REST API is `https://bpforms.org/api/ <https://bpforms.org/api/>`_. The REST API provides two endpoints.

* ``/``: Returns metadata about the API including a description, the version, and a list of endpoints.::
* ``/`` returns metadata about the API including a description, the version, and a list of endpoints::

{
description: <string>,
endpoints: <array>,
version: <string>
}

* ``/alphabet``: Returns a list of available alphabets.::
* ``/alphabet`` returns a list of available alphabets::

[
{
Expand All @@ -26,7 +26,7 @@ The base URL for the REST API is `https://bpforms.org/api/ <https://bpforms.org/
...
]

* ``/alphabet/{alphabet: string}``: Returns an associative array of bases in the alphabet and their properties.::
* ``/alphabet/{alphabet: string}`` returns an associative array of bases in the alphabet and their properties::

{
A: {
Expand All @@ -37,7 +37,7 @@ The base URL for the REST API is `https://bpforms.org/api/ <https://bpforms.org/
...
}

* ``/bpform/properties/{alphabet: rna, dna, or protein}/{base_seq: string}(/{ph: float})?``: If the form is valid, this, optionally, protonates the form to the specified pH and returns the length, formula, mass, and charge of the form. If the form is invalid, this returns an error message.::
* ``/bpform/properties/{alphabet: rna, dna, or protein}/{base_seq: string}(/{ph: float})?`` optionally, protonates the biopolymer form to the specified pH and returns its length, chemical formula, mass and charge. If the form is invalid, this returns an error message::

{
alphabet: <string>,
Expand Down

0 comments on commit bef2563

Please sign in to comment.