-
Notifications
You must be signed in to change notification settings - Fork 2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
refactor: Revise job schemas #43
Conversation
@forest1040
I would appreciate it if you would follow the following instructions for your next commit message. |
…mentation site 📃 Ticket✍ DescriptionRevised the structure of the OpenAPI specification, particularly the definition of the job. This introduces breaking changes, including:
📸 Test ResultPlease refer to the results of Github Actions. 🔗 Related PRs |
@@ -50,80 +48,17 @@ devices.DeviceInfo: | |||
type: string | |||
example: "State vector-based quantum circuit simulator" | |||
required: [ | |||
deviceId, deviceType, status, nPendingTasks, basisGates, supportedInstructions, description | |||
deviceId, deviceType, status, nPendingJobs, basisGates, supportedInstructions, description |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should be snake case.
deviceId, deviceType, status, nPendingJobs, basisGates, supportedInstructions, description
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Finished to modify.
backend/oas/user/schemas/jobs.yaml
Outdated
jobs.SimulatorInfo: | ||
type: string | ||
example: >- | ||
{ | ||
"nQubits": 5, | ||
"nNodes": 12, | ||
"nPerNode": 2, | ||
"seedSimulation": 39058567, | ||
"simulationOpt": { | ||
"optimizationMethod": "light", | ||
"optimizationBlockSize": 1, | ||
"optimizationSwapLevel": 1 | ||
} | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
example also should be snake case.
properties: | ||
job_type: | ||
type: string | ||
enum: ["sampling"] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I want the form of enum to be the same as estimation
- "sampling"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree and finished to modify. Other enum fields are also modified.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks a lot.
LGTM 🐱
#111 internal ticket