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

docs: Update OpenAPI specification for jobs #64

Merged
merged 2 commits into from
Dec 26, 2024
Merged

Conversation

katsujukou
Copy link
Contributor

@katsujukou katsujukou commented Dec 25, 2024

📃 Ticket

https://github.com/FujitsuResearch/QuantumCloudPlatform/issues/277

✍ Description

This PR makes some modifications to documentation, specifically the sequence diagram of job execution.
For detailed explanation for job definition, I added a new page in the architecture page of docsite.

NOTE: Currently only job_info is explained, and other json field including mitigation_info, simulation_info, etc, are not detailed yet.

📸 Test Result

🔗 Related PRs

@katsujukou katsujukou self-assigned this Dec 25, 2024
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Dec 25, 2024
@katsujukou katsujukou marked this pull request as ready for review December 26, 2024 01:19
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.

@katsujukou
Thanks LGTM

@orangekame3 orangekame3 merged commit 28458bb into develop Dec 26, 2024
7 checks passed
@orangekame3 orangekame3 deleted the docs/oas-jobs branch December 26, 2024 02:33
@orangekame3 orangekame3 changed the title [Docs] Update OpenAPI specification for jobs docs: Update OpenAPI specification for jobs Dec 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants