REST: Filter schemes to only include those with primary key.

kjolley · Apr 3, 2020 · ff920a9 · ff920a9
1 parent ee63b5e
commit ff920a9
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/conf.py b/conf.py
@@ -54,9 +54,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '1.26.0'
+version = '1.27.0'
 # The full version, including alpha/beta/rc tags.
-release = '1.26.0'
+release = '1.27.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

diff --git a/rest.rst b/rest.rst
@@ -646,7 +646,11 @@ GET /db/{database}/schemes - List schemes
 =========================================
 **Required route parameter:** database [string] - Database configuration name
 
-**Optional parameters:** None
+**Optional parameters:**
+
+* with_pk [integer] - Set to non-zero value to only show indexed schemes, i.e.
+  those with a primary key field that defines each unique combination of 
+  alleles, e.g. MLST. 
 
 **Example request URI:** http://rest.pubmlst.org/db/pubmlst_neisseria_seqdef/schemes