Skip to content

Commit 6c999d9

Browse files
authored
Change run_id into job_id (#8)
1 parent b8dd566 commit 6c999d9

File tree

5 files changed

+10
-10
lines changed

5 files changed

+10
-10
lines changed

docs/request/index.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ The schemas for validation inherit from the **extended schema** and can be found
120120

121121
| Key | Type | Value |
122122
| --- | --- | --- |
123-
| `run_id` | `int` | Client defined identifier for the execution. |
123+
| `job_id` | `int` | Client defined identifier for the execution. |
124124
| `circuit` | `str` | Circuit description in cQASM language, see below for more information. |
125125
| `include_raw_data` | `bool` | Whether or not to return all bitstrings in the order in which they were measured. |
126126
| `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
135135
"session_id": "eb4fdc2c-755b-47d8-af76-bbca2dce554d",
136136
"command": "execute",
137137
"payload": {
138-
"run_id": 1,
138+
"job_id": 1,
139139
"circuit": "version 1.0\n\nqubits 2",
140140
"include_raw_data": true,
141141
"number_of_shots": 4
@@ -148,7 +148,7 @@ implementations of 2300 might impose different requirements. These will be descr
148148

149149
| Key | Type | Value |
150150
| --- | --- | --- |
151-
| `run_id` | `int` | Client defined identifier for the execution. |
151+
| `job_id` | `int` | Client defined identifier for the execution. |
152152
| `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. |
153153
| `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. |
154154

@@ -159,7 +159,7 @@ implementations of 2300 might impose different requirements. These will be descr
159159
"session_id": "eb4fdc2c-755b-47d8-af76-bbca2dce554d",
160160
"status": "success",
161161
"payload": {
162-
"run_id": 1,
162+
"job_id": 1,
163163
"results": {
164164
"000": 3,
165165
"001": 1

schemas/execute/reply.schema.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
"description": "The return value(s) of the executed command.",
1313
"type": "object",
1414
"properties": {
15-
"run_id": {
15+
"job_id": {
1616
"description": "Client defined identifier for the execution.",
1717
"type": "integer"
1818
},
@@ -48,7 +48,7 @@
4848
"properties": {
4949
"payload": {
5050
"required": [
51-
"run_id",
51+
"job_id",
5252
"results",
5353
"raw_data"
5454
]

schemas/execute/request.schema.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
"description": "Arguments for the function to be executed.",
1616
"type": "object",
1717
"properties": {
18-
"run_id": {
18+
"job_id": {
1919
"description": "Client defined identifier for the execution.",
2020
"type": "integer"
2121
},
@@ -33,7 +33,7 @@
3333
}
3434
},
3535
"required": [
36-
"run_id",
36+
"job_id",
3737
"circuit",
3838
"number_of_shots"
3939
]

tests/data/execute/reply.success.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"session_id": "eb4fdc2c-755b-47d8-af76-bbca2dce554d",
33
"status": "success",
44
"payload": {
5-
"run_id": 1,
5+
"job_id": 1,
66
"results": {
77
"000": 512,
88
"001": 512

tests/data/execute/request.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"session_id": "eb4fdc2c-755b-47d8-af76-bbca2dce554d",
33
"command": "execute",
44
"payload": {
5-
"run_id": 1,
5+
"job_id": 1,
66
"circuit": "version 1.0\n\nqubits 2",
77
"include_raw_data": true,
88
"number_of_shots": 1024

0 commit comments

Comments
 (0)