Change run_id into job_id (#8)

QuTech-Delft · Jul 19, 2024 · 6c999d9 · 6c999d9
1 parent b8dd566
commit 6c999d9
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 10 deletions.
diff --git a/docs/request/index.md b/docs/request/index.md
@@ -120,7 +120,7 @@ The schemas for validation inherit from the **extended schema** and can be found
 
 | Key | Type | Value |
 | --- | --- | --- |
-| `run_id` | `int` | Client defined identifier for the execution. |
+| `job_id` | `int` | Client defined identifier for the execution. |
 | `circuit` | `str` | Circuit description in cQASM language, see below for more information. |
 | `include_raw_data` | `bool` | Whether or not to return all bitstrings in the order in which they were measured. |
 | `number_of_shots` | `int` | Number of shots to be executed for the circuit. |
@@ -135,7 +135,7 @@ implementations of 2300 might impose different requirements. These will be descr
     "session_id": "eb4fdc2c-755b-47d8-af76-bbca2dce554d",
     "command": "execute",
     "payload": {
-        "run_id": 1,
+        "job_id": 1,
         "circuit": "version 1.0\n\nqubits 2",
         "include_raw_data": true,
         "number_of_shots": 4
@@ -148,7 +148,7 @@ implementations of 2300 might impose different requirements. These will be descr
 
 | Key | Type | Value |
 | --- | --- | --- |
-| `run_id` | `int` | Client defined identifier for the execution. |
+| `job_id` | `int` | Client defined identifier for the execution. |
 | `results` | `dict[str, int]` | Mapping of measured bitstring (for a circuit with `n` measurements; `q[n]...q[0]`) to count of occurrences. Limited to `m` results. |
 | `raw_data` | `list[str]` | A list of bitstrings (little endian notation; `q[n]...q[0]`) ordered by the shot in which it was measured. If `include_raw_data` is set to `false` the list is left empty. |
 
@@ -159,7 +159,7 @@ implementations of 2300 might impose different requirements. These will be descr
     "session_id": "eb4fdc2c-755b-47d8-af76-bbca2dce554d",
     "status": "success",
     "payload": {
-        "run_id": 1,
+        "job_id": 1,
         "results": {
             "000": 3,
             "001": 1

diff --git a/schemas/execute/reply.schema.json b/schemas/execute/reply.schema.json
@@ -12,7 +12,7 @@
       "description": "The return value(s) of the executed command.",
       "type": "object",
       "properties": {
-        "run_id": {
+        "job_id": {
           "description": "Client defined identifier for the execution.",
           "type": "integer"
         },
@@ -48,7 +48,7 @@
     "properties": {
       "payload": {
         "required": [
-          "run_id",
+          "job_id",
           "results",
           "raw_data"
         ]

diff --git a/schemas/execute/request.schema.json b/schemas/execute/request.schema.json
@@ -15,7 +15,7 @@
       "description": "Arguments for the function to be executed.",
       "type": "object",
       "properties": {
-        "run_id": {
+        "job_id": {
           "description": "Client defined identifier for the execution.",
           "type": "integer"
         },
@@ -33,7 +33,7 @@
         }
       },
       "required": [
-        "run_id",
+        "job_id",
         "circuit",
         "number_of_shots"
       ]

diff --git a/tests/data/execute/reply.success.json b/tests/data/execute/reply.success.json
@@ -2,7 +2,7 @@
   "session_id": "eb4fdc2c-755b-47d8-af76-bbca2dce554d",
   "status": "success",
   "payload": {
-    "run_id": 1,
+    "job_id": 1,
     "results": {
       "000": 512,
       "001": 512

diff --git a/tests/data/execute/request.json b/tests/data/execute/request.json
@@ -2,7 +2,7 @@
   "session_id": "eb4fdc2c-755b-47d8-af76-bbca2dce554d",
   "command": "execute",
   "payload": {
-    "run_id": 1,
+    "job_id": 1,
     "circuit": "version 1.0\n\nqubits 2",
     "include_raw_data": true,
     "number_of_shots": 1024