docs: Update OpenAPI specification for jobs #64
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📃 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 includingmitigation_info
,simulation_info
, etc, are not detailed yet.📸 Test Result
🔗 Related PRs