Skip to content

Commit

Permalink
REST: Better formatting of optional parameter lists.
Browse files Browse the repository at this point in the history
  • Loading branch information
kjolley committed Apr 7, 2015
1 parent ff80ee8 commit 53a87d5
Showing 1 changed file with 28 additions and 14 deletions.
42 changes: 28 additions & 14 deletions rest.rst
Original file line number Diff line number Diff line change
Expand Up @@ -116,8 +116,10 @@ Lists loci defined within specified database configuration.

**Required query parameter:** {database} - Database configuration name [string]

**Optional parameters:** page [integer], page_size [integer]. Set very large
page size to return all results in one go.
**Optional parameters:**

* page [integer]
* page_size [integer] - Set very large page size to return all results in one go.

**Example request URI:** http://rest.pubmlst.org/db/pubmlst_neisseria_seqdef/loci

Expand Down Expand Up @@ -212,8 +214,10 @@ Lists alleles defined for specific locus.
* {database} - Database configuration name [string]
* {locus} - Locus name [string]

**Optional parameters:** page [integer], page_size [integer]. Set very large
page size to return all results in one go.
**Optional parameters:**

* page [integer]
* page_size [integer] - Set very large page size to return all results in one go.

**Example request URI:**
http://rest.pubmlst.org/db/pubmlst_neisseria_seqdef/loci/abcZ/alleles
Expand Down Expand Up @@ -391,8 +395,10 @@ Lists allelic profiles defined for a specific scheme.
* {database} - Database configuration name [string]
* {scheme_id} - Scheme id [integer]

**Optional parameters:** page [integer], page_size [integer]. Set very large
page size to return all results in one go.
**Optional parameters:**

* page [integer]
* page_size [integer] - Set very large page size to return all results in one go.

**Example request URI:**
http://rest.pubmlst.org/db/pubmlst_neisseria_seqdef/schemes/1/profiles
Expand Down Expand Up @@ -480,8 +486,10 @@ Provides list of isolate records.

**Required query parameter:** {database} - Database configuration name [string]

**Optional parameters:** page [integer], page_size [integer]. Set very large
page size to return all results in one go.
**Optional parameters:**

* page [integer]
* page_size [integer] - Set very large page size to return all results in one go.

**Example request URI:** http://rest.pubmlst.org/db/pubmlst_neisseria_isolates/isolates

Expand Down Expand Up @@ -577,8 +585,10 @@ Provides a list of full allele designation records for the specified isolate.
* {database} - Database configuration name [string]
* {isolate_id} - Isolate identifier [integer]

**Optional parameters:** page [integer], page_size [integer]. Set very large
page size to return all results in one go.
**Optional parameters:**

* page [integer]
* page_size [integer] - Set very large page size to return all results in one go.

**Example request URI:**
http://rest.pubmlst.org/db/pubmlst_neisseria_isolates/isolates/1/allele_designations
Expand Down Expand Up @@ -645,8 +655,10 @@ Returns array of allele identifiers for isolate.
* {database} - Database configuration name [string]
* {isolate_id} - Isolate identifier [integer]

**Optional parameters:** page [integer], page_size [integer]. Set very large
page size to return all results in one go.
**Optional parameters:**

* page [integer]
* page_size [integer] - Set very large page size to return all results in one go.

**Example request URI:**
http://rest.pubmlst.org/db/pubmlst_neisseria_isolates/isolates/1/allele_ids
Expand Down Expand Up @@ -737,8 +749,10 @@ Returns a list of contig records for the specified isolate.
* {database} - Database configuration name [string]
* {isolate_id} - Isolate identifier [integer]

**Optional parameters:** page [integer], page_size [integer]. Set very large
page size to return all results in one go.
**Optional parameters:**

* page [integer]
* page_size [integer] - Set very large page size to return all results in one go.

**Example request URI:**
http://rest.pubmlst.org/db/pubmlst_neisseria_isolates/isolates/1/contigs
Expand Down

0 comments on commit 53a87d5

Please sign in to comment.