Skip to content
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

Merged
merged 41 commits into from
Nov 13, 2024
Merged

refactor: Revise job schemas #43

merged 41 commits into from
Nov 13, 2024

Conversation

forest1040
Copy link
Contributor

#111 internal ticket

@orangekame3 orangekame3 marked this pull request as draft October 17, 2024 04:53
@orangekame3
Copy link
Collaborator

orangekame3 commented Oct 21, 2024

@forest1040
Please make the following corrections

  • Resolving Conflict
  • Edit PR Title
    • ex) refactor: xxxxxxx
  • Fill in PR Descriptions
  • Confirmation (recommended)
    • Confirmation of test pass
    • Manual confirmation of endpoint response, etc.

I would appreciate it if you would follow the following instructions for your next commit message.
Development Flow - OQTOPUS

@orangekame3 orangekame3 added the refactor Code changes that neither fix a bug nor add a feature label Oct 21, 2024
@katsujukou katsujukou changed the title # 111 Jobs json # 111 refactor: Revise job schemas Nov 8, 2024
@katsujukou
Copy link
Contributor

…mentation site

📃 Ticket

✍ Description

Revised the structure of the OpenAPI specification, particularly the definition of the job. This introduces breaking changes, including:

  • OAS: The endpoints for controlling quantum jobs have been modified, including:
  • Codebase: In accordance with the changes in the OAS, the generated Python data models have also been updated.
  • DB: The database schema for the jobs table has been drastically altered.

📸 Test Result

Please refer to the results of Github Actions.

🔗 Related PRs

@katsujukou katsujukou marked this pull request as ready for review November 11, 2024 07:46
@orangekame3 orangekame3 changed the title # 111 refactor: Revise job schemas refactor: Revise job schemas Nov 11, 2024
@@ -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
Copy link
Collaborator

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

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Finished to modify.

Comment on lines 119 to 132
jobs.SimulatorInfo:
type: string
example: >-
{
"nQubits": 5,
"nNodes": 12,
"nPerNode": 2,
"seedSimulation": 39058567,
"simulationOpt": {
"optimizationMethod": "light",
"optimizationBlockSize": 1,
"optimizationSwapLevel": 1
}
}
Copy link
Collaborator

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"]
Copy link
Collaborator

@orangekame3 orangekame3 Nov 12, 2024

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"

Copy link
Contributor

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.

Copy link
Contributor

@shgokita shgokita left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

Copy link
Collaborator

@orangekame3 orangekame3 left a 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 🐱

@orangekame3 orangekame3 merged commit 4da82bb into develop Nov 13, 2024
9 checks passed
@orangekame3 orangekame3 deleted the jobs-json branch November 13, 2024 01:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
refactor Code changes that neither fix a bug nor add a feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants