Merge branch 'pr/14'

Author: GeorgDaniel

README.md

@@ -49,14 +49,22 @@ celery worker and execute all tasks synchronously.
     * **DELETE /jobs/{job_id}/** *(Get details/results of a job)*
     * **POST /jobs/run/{job_id}/** *(Executes an uploaded python file)*
     * **POST /jobs/rerun/{job_id}/** *(Copies and Runs again an existing Job)*
+    * **GET /jobs/{deployment_id}/** *(Get all jobs with the given deploymentId)*
+    * **DELETE /jobs/{deployment_id}/** *(Delete all jobs with the given deploymentId)*
 
 * **DEPLOYMENTS**
     * **GET /deployments/** *(Get all Deployments)*
     * **POST /deployments/** *(Create a Deployment)*
-    * **GET /deployments/{job_id}/** *(Gets a Deployment)*
+    * **GET /deployments/{deployment_id}/** *(Gets a Deployment)*
+    * **PUT /deployments/{deployment_id}/** *(Update a Deployment)*
+    * **DELETE /deployments/{deployment_id}/** *(Deletes a Deployment)*
 
 * **DEVICES**
+    * **GET /devices/** *(Get all currently saved devices)*
     * **PUT /devices/** *(Updates the devices, by retrieving them from IBM)*
+    * **PUT /devices/{device_id}/** *(Get details about one device)*
+    * **PUT /devices/{device_id}/status** *(To check if a device is running)*
+    * **PUT /devices/{device_id}/calibration** *(To get some device properties)*
 
 Run the development server with
 

docs/adr/0003-rest-decisions.md

@@ -23,6 +23,7 @@ Use the HTTP Status Codes and Verbs correctly
     * POST: Create/Run/Pause/Cancel a resource
     * PUT: Update a resource
     * DELETE: Delete a resource
-    * PATCH: Update a resource partially
+* Decision on Patch Verb
+    * Not used due to similarity to update
 
 <!-- markdownlint-disable-file MD013 -->

docs/glossary.rst

@@ -0,0 +1,43 @@
+Glossary
+========
+
+**Qunicorn**:
+The name of the application that serves as an API for quantum computing request.
+
+**Job**:
+The data object that is used to run deployments with their quantum programs on specified provider and store their results
+
+**Deployment**:
+The data object that stores information about quantum programs and their configurations.
+Is used to register/deploy them, to use them later in multiple jobs.
+
+**Provider**:
+An institution that provides quantum computer or simulators.
+
+**Device**:
+A single quantum computer that belongs to a provider
+
+**Pilots**:
+They are run in a celery-task and are used to communicate with the provider apis and run the jobs there.
+
+**Service**:
+Files that belong to the service-layer or core. They calculate or process data, but do not directly communicate with the database.
+
+**QASM-Format**:
+The most used format to describe quantum circuits.
+
+**CLI**: Shortcut for command line interface, used for example to initially set up the database with custom commands.
+
+**Celery**:
+A python library that is used to run tasks in the background in an asynchronous task queue based on messaging.
+It is used to run the quantum programs on the quantum computers.
+
+**Worker**:
+Used as a synonym for a celery worker. That is a process that executes tasks in the background.
+
+**Broker**:
+Used in the context of celery and docker. Manages the Celery Worker.
+
+**In-Request**:
+Something that is done in a request. For example in-request-execution means that the execution of a quantum program is done in the request.
+