Skip to content

Commit

Permalink
don't ignore the auto generated files.
Browse files Browse the repository at this point in the history
  • Loading branch information
gourneau committed Jan 30, 2014
1 parent 8be3911 commit 0fa66ee
Show file tree
Hide file tree
Showing 139 changed files with 14,419 additions and 3 deletions.
1 change: 0 additions & 1 deletion source/.gitignore
Original file line number Diff line number Diff line change
@@ -1 +0,0 @@
/auto_database_ref_index.rst
1 change: 0 additions & 1 deletion source/auto_api_ref_docs/.gitignore
Original file line number Diff line number Diff line change
@@ -1 +0,0 @@
/*.rst
129 changes: 129 additions & 0 deletions source/auto_api_ref_docs/activeionchefprepkitinfo.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@
Activeionchefprepkitinfo Resource
==========================================================================

Resource URL: ``http://mytorrentserver/rundb/api/v1/activeionchefprepkitinfo/``


Schema URL: ``http://mytorrentserver/rundb/api/v1/activeionchefprepkitinfo/schema/``


.. include:: ../manual_api_ref_docs/activeionchefprepkitinfo.rst

Fields table
------------

================== ================================================================================================== ======= ======== ======== ===== ====== =======
field help text default nullable readonly blank unique type
================== ================================================================================================== ======= ======== ======== ===== ====== =======
**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
------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------
**id** Integer data. Ex: 2673 false false true true integer
------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------
**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
------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------
**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
------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------
**instrumentType** Unicode string data. Ex: "Hello World" false false true false string
------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------
**isActive** Boolean data. Ex: True true false false true false boolean
------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------
**name** Unicode string data. Ex: "Hello World" n/a false false false true string
================== ================================================================================================== ======= ======== ======== ===== ====== =======

Example request
---------------

Request URL: ``http://mytorrentserver/rundb/api/v1/activeionchefprepkitinfo/?format=json&limit=1``


Python example
^^^^^^^^^^^^^^

.. code-block:: python
import requests
ts_api_request = requests.get("http://mytorrentserver/rundb/api/v1/activeionchefprepkitinfo/", params={"format": "json", "limit": 1})
ts_api_response = ts_api_request.json()
activeionchefprepkitinfos = ts_api_response["objects"]
for activeionchefprepkitinfo in activeionchefprepkitinfos:
print activeionchefprepkitinfo
Torrent Server response
^^^^^^^^^^^^^^^^^^^^^^^

.. code-block:: javascript
{
"meta": {
"previous": null,
"total_count": 2,
"offset": 0,
"limit": 1,
"next": "/rundb/api/v1/activeionchefprepkitinfo/?offset=1&limit=1&format=json"
},
"objects": [
{
"kitType": "IonChefPrepKit",
"description": "Ion PI IC 200 Kit",
"nucleotideType": "",
"id": 20057,
"runMode": "",
"parts": [
{
"barcode": "100023442",
"id": 20130,
"resource_uri": "/rundb/api/v1/kitpart/20130/",
"kit": "/rundb/api/v1/kitinfo/20057/"
},
{
"barcode": "100022895",
"id": 20124,
"resource_uri": "/rundb/api/v1/kitpart/20124/",
"kit": "/rundb/api/v1/kitinfo/20057/"
},
{
"barcode": "100022894",
"id": 20125,
"resource_uri": "/rundb/api/v1/kitpart/20125/",
"kit": "/rundb/api/v1/kitinfo/20057/"
},
{
"barcode": "02",
"id": 20126,
"resource_uri": "/rundb/api/v1/kitpart/20126/",
"kit": "/rundb/api/v1/kitinfo/20057/"
}
],
"flowCount": 0,
"uid": "ICPREP0002",
"resource_uri": "/rundb/api/v1/activeionchefprepkitinfo/20057/",
"instrumentType": "proton",
"isActive": true,
"name": "Ion PI IC 200 Kit"
}
]
}
Allowed HTTP methods
--------------------

- get
- post
- put
- delete
- patch

111 changes: 111 additions & 0 deletions source/auto_api_ref_docs/activelibrarykitinfo.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
Activelibrarykitinfo Resource
==========================================================================

Resource URL: ``http://mytorrentserver/rundb/api/v1/activelibrarykitinfo/``


Schema URL: ``http://mytorrentserver/rundb/api/v1/activelibrarykitinfo/schema/``


.. include:: ../manual_api_ref_docs/activelibrarykitinfo.rst

Fields table
------------

================== ================================================================================================== ======= ======== ======== ===== ====== =======
field help text default nullable readonly blank unique type
================== ================================================================================================== ======= ======== ======== ===== ====== =======
**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
------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------
**id** Integer data. Ex: 2673 false false true true integer
------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------
**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
------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------
**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
------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------
**instrumentType** Unicode string data. Ex: "Hello World" false false true false string
------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------
**isActive** Boolean data. Ex: True true false false true false boolean
------------------ -------------------------------------------------------------------------------------------------- ------- -------- -------- ----- ------ -------
**name** Unicode string data. Ex: "Hello World" n/a false false false true string
================== ================================================================================================== ======= ======== ======== ===== ====== =======

Example request
---------------

Request URL: ``http://mytorrentserver/rundb/api/v1/activelibrarykitinfo/?format=json&limit=1``


Python example
^^^^^^^^^^^^^^

.. code-block:: python
import requests
ts_api_request = requests.get("http://mytorrentserver/rundb/api/v1/activelibrarykitinfo/", params={"format": "json", "limit": 1})
ts_api_response = ts_api_request.json()
activelibrarykitinfos = ts_api_response["objects"]
for activelibrarykitinfo in activelibrarykitinfos:
print activelibrarykitinfo
Torrent Server response
^^^^^^^^^^^^^^^^^^^^^^^

.. code-block:: javascript
{
"meta": {
"previous": null,
"total_count": 12,
"offset": 0,
"limit": 1,
"next": "/rundb/api/v1/activelibrarykitinfo/?offset=1&limit=1&format=json"
},
"objects": [
{
"kitType": "LibraryKit",
"description": "Ion Fragment Library Kit",
"nucleotideType": "dna",
"id": 20005,
"runMode": "",
"parts": [
{
"barcode": "4466464",
"id": 20014,
"resource_uri": "/rundb/api/v1/kitpart/20014/",
"kit": "/rundb/api/v1/kitinfo/20005/"
}
],
"flowCount": 0,
"uid": "LIB0002",
"resource_uri": "/rundb/api/v1/activelibrarykitinfo/20005/",
"instrumentType": "",
"isActive": true,
"name": "IonFragmentLibKit2"
}
]
}
Allowed HTTP methods
--------------------

- get
- post
- put
- delete
- patch

Loading

0 comments on commit 0fa66ee

Please sign in to comment.