Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
- Loading branch information
Showing
43 changed files
with
3,598 additions
and
482 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
.. _api_case: | ||
|
||
================ | ||
Case & Query API | ||
================ | ||
|
||
The REST API for case access and is described in this section. | ||
Cases are not managed directly but through the :ref:`api_importer`. | ||
|
||
|
||
---------- | ||
Versioning | ||
---------- | ||
|
||
For accept header versioning, the following media type and version are expected in the current VarFish version: | ||
|
||
.. code-block:: console | ||
Accept: application/vnd.bihealth.varfish+json; version=0.23.9 | ||
----------- | ||
Return Data | ||
----------- | ||
|
||
The return data for each request will be a JSON document unless otherwise | ||
specified. | ||
|
||
If return data is not specified in the documentation of an API view, it will | ||
return the appropriate HTTP status code along with an optional ``detail`` JSON | ||
field upon a successfully processed request. | ||
|
||
For creation views, the ``sodar_uuid`` of the created object is returned | ||
along with other object fields. | ||
|
||
-------------- | ||
Query Settings | ||
-------------- | ||
|
||
The query follows a :ref:`JSON Schema <api_json_schemas>`. | ||
|
||
--------- | ||
API Views | ||
--------- | ||
|
||
.. currentmodule:: variants.views_api | ||
|
||
.. autoclass:: CaseListApiView | ||
|
||
.. autoclass:: CaseRetrieveApiView | ||
|
||
.. autoclass:: SmallVariantQueryApiView | ||
|
||
.. autoclass:: SmallVariantQueryCreateApiView | ||
|
||
.. autoclass:: SmallVariantQueryRetrieveApiView | ||
|
||
.. autoclass:: SmallVariantQueryStatusApiView | ||
|
||
.. autoclass:: SmallVariantQueryUpdateApiView | ||
|
||
.. autoclass:: SmallVariantQueryFetchResultsApiView |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
.. _api_importer: | ||
|
||
=============== | ||
Case Import API | ||
=============== | ||
|
||
The REST API for case import functionality is documented in this section. | ||
|
||
|
||
--------- | ||
API Views | ||
--------- | ||
|
||
.. note:: | ||
|
||
This is currently not implemented. | ||
|
||
|
||
---------- | ||
Versioning | ||
---------- | ||
|
||
For accept header versioning, the following media type and version are expected in the current VarFish version: | ||
|
||
.. code-block:: console | ||
Accept: application/vnd.bihealth.varfish+json; version=0.23.9 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
.. _api_json_schemas: | ||
|
||
=========== | ||
JSON Schema | ||
=========== | ||
|
||
This section contains the JSON schemas used in the VarFish Server API. | ||
|
||
.. _api_json_schemas_case_query_v1: | ||
|
||
-------------------- | ||
Case Query Schema V1 | ||
-------------------- | ||
|
||
.. jsonschema:: ../variants/schemas/case-query-v1.json | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
.. _api_projectroles: | ||
|
||
====================== | ||
Project Management API | ||
====================== | ||
|
||
The REST API for project access and management operations is described in this section. | ||
|
||
|
||
--------- | ||
API Views | ||
--------- | ||
|
||
The project management API is provided by the SODAR Core package. | ||
The documentation for the REST API views can be found in the `SODAR Core Documentation <https://sodar-core.readthedocs.io/en/latest/app_projectroles_api_rest.html#api-views>`_. | ||
|
||
|
||
---------- | ||
Versioning | ||
---------- | ||
|
||
For accept header versioning, the following media type and version are expected in the current VarFish version: | ||
|
||
.. code-block:: console | ||
Accept: application/vnd.bihealth.sodar-core+json; version=0.10.7 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.