Skip to content

Commit

Permalink
Updated for 4.4
Browse files Browse the repository at this point in the history
  • Loading branch information
Alexander Roemer committed Feb 3, 2015
1 parent 6ef258b commit 273d198
Show file tree
Hide file tree
Showing 135 changed files with 4,037 additions and 2,259 deletions.
1 change: 1 addition & 0 deletions generate_docs.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ def normalize_row(row, max_cols):
"ionreporter", #400
"network", #500
"torrentsuite", #500
"prepopulatedplanningsession", #500
]
API_VERSION = "v1"
DEMO_API_BASE_URL = "http://mytorrentserver/rundb/api/v1/"
Expand Down
115 changes: 65 additions & 50 deletions source/auto_api_ref_docs/activeionchefprepkitinfo.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,37 +12,43 @@ Schema URL: ``http://mytorrentserver/rundb/api/v1/activeionchefprepkitinfo/schem
Fields table
------------

=================== ================================================================================================== ======= ======== ======== ===== ====== =======
field help text default nullable readonly blank unique type
=================== ================================================================================================== ======= ======== ======== ===== ====== =======
**isActive** Boolean data. Ex: True true false false true false boolean
------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------
**kitType** Unicode string data. Ex: "Hello World" n/a false false false false string
------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------
**description** Unicode string data. Ex: "Hello World" false false true false string
------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------
**nucleotideType** Unicode string data. Ex: "Hello World" false false true false string
------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------
**instrumentType** Unicode string data. Ex: "Hello World" false false true false string
------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------
**runMode** Unicode string data. Ex: "Hello World" false false true false string
------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------
**parts** Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a false false false false related
------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------
**flowCount** Integer data. Ex: 2673 n/a false false false false integer
------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------
**applicationType** Unicode string data. Ex: "Hello World" true false false false string
------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------
**uid** Unicode string data. Ex: "Hello World" n/a false false false true string
------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------
**resource_uri** Unicode string data. Ex: "Hello World" n/a false true false false string
------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------
**id** Integer data. Ex: 2673 false false true true integer
------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------
**categories** Unicode string data. Ex: "Hello World" true false false false string
------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------
**name** Unicode string data. Ex: "Hello World" n/a false false false true string
=================== ================================================================================================== ======= ======== ======== ===== ====== =======
============================= ================================================================================================== ======= ======== ======== ===== ====== =======
field help text default nullable readonly blank unique type
============================= ================================================================================================== ======= ======== ======== ===== ====== =======
**isActive** Boolean data. Ex: True true false false true false boolean
----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------
**templatingSize** Unicode string data. Ex: "Hello World" true false false false string
----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------
**kitType** Unicode string data. Ex: "Hello World" n/a false false false false string
----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------
**description** Unicode string data. Ex: "Hello World" false false true false string
----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------
**nucleotideType** Unicode string data. Ex: "Hello World" false false true false string
----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------
**instrumentType** Unicode string data. Ex: "Hello World" false false true false string
----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------
**samplePrep_instrumentType** Unicode string data. Ex: "Hello World" false false true false string
----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------
**runMode** Unicode string data. Ex: "Hello World" false false true false string
----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------
**parts** Many related resources. Can be either a list of URIs or list of individually nested resource data. n/a false false false false related
----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------
**flowCount** Integer data. Ex: 2673 n/a false false false false integer
----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------
**applicationType** Unicode string data. Ex: "Hello World" true false false false string
----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------
**uid** Unicode string data. Ex: "Hello World" n/a false false false true string
----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------
**libraryReadLength** Integer data. Ex: 2673 0 false false false false integer
----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------
**resource_uri** Unicode string data. Ex: "Hello World" n/a false true false false string
----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------
**id** Integer data. Ex: 2673 false false true true integer
----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------
**categories** Unicode string data. Ex: "Hello World" true false false false string
----------------------------- -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------
**name** Unicode string data. Ex: "Hello World" n/a false false false true string
============================= ================================================================================================== ======= ======== ======== ===== ====== =======

Example request
---------------
Expand Down Expand Up @@ -74,46 +80,55 @@ Torrent Server response
{
"meta": {
"previous": null,
"total_count": 2,
"total_count": 4,
"offset": 0,
"limit": 1,
"next": "/rundb/api/v1/activeionchefprepkitinfo/?offset=1&limit=1&format=json"
},
"objects": [
{
"isActive": true,
"templatingSize": "",
"kitType": "IonChefPrepKit",
"description": "ION PGM IC 200 KIT",
"description": "Ion PI IC 200 Kit",
"nucleotideType": "",
"instrumentType": "pgm",
"instrumentType": "proton",
"samplePrep_instrumentType": "IC",
"runMode": "",
"parts": [
{
"barcode": "100020579",
"id": 20085,
"resource_uri": "/rundb/api/v1/kitpart/20085/",
"kit": "/rundb/api/v1/kitinfo/20042/"
"barcode": "100022895",
"id": 20124,
"resource_uri": "/rundb/api/v1/kitpart/20124/",
"kit": "/rundb/api/v1/kitinfo/20057/"
},
{
"barcode": "100020580",
"id": 20086,
"resource_uri": "/rundb/api/v1/kitpart/20086/",
"kit": "/rundb/api/v1/kitinfo/20042/"
"barcode": "100022894",
"id": 20125,
"resource_uri": "/rundb/api/v1/kitpart/20125/",
"kit": "/rundb/api/v1/kitinfo/20057/"
},
{
"barcode": "01",
"id": 20123,
"resource_uri": "/rundb/api/v1/kitpart/20123/",
"kit": "/rundb/api/v1/kitinfo/20042/"
"barcode": "02",
"id": 20126,
"resource_uri": "/rundb/api/v1/kitpart/20126/",
"kit": "/rundb/api/v1/kitinfo/20057/"
},
{
"barcode": "100023442",
"id": 20130,
"resource_uri": "/rundb/api/v1/kitpart/20130/",
"kit": "/rundb/api/v1/kitinfo/20057/"
}
],
"flowCount": 0,
"applicationType": "",
"uid": "ICPREP0001",
"resource_uri": "/rundb/api/v1/activeionchefprepkitinfo/20042/",
"id": 20042,
"uid": "ICPREP0002",
"libraryReadLength": 0,
"resource_uri": "/rundb/api/v1/activeionchefprepkitinfo/20057/",
"id": 20057,
"categories": "",
"name": "ION PGM IC 200 KIT"
"name": "Ion PI IC 200 Kit"
}
]
}
Expand Down
Loading

0 comments on commit 273d198

Please sign in to comment.