Rewrite Resource Controller docs#5320
Merged
Merged
Conversation
Contributor
|
One or more of the following people are relevant to this code:
|
Collaborator
Author
|
You can see a preview at https://qiskit.github.io/documentation/pr-5320/docs/guides/access-instances-platform-apis |
beckykd
reviewed
Jul 1, 2026
Co-authored-by: Rebecca Dimock <66339736+beckykd@users.noreply.github.com>
6 tasks
riley2012
reviewed
Jul 2, 2026
| - `backends` — Array of strings. The allowlist of backend names available to this instance. `["ANY"]` means all backends on the plan are available (the default). `[]` means no backends are available. | ||
|
|
||
| <Admonition type="caution" title="Some extensions fields may be outdated"> | ||
| The following fields in the `extensions` object may be outdated. This can happen when IBM Quantum Support changes your instance's configuration. The current workaround is to instead use the [Qiskit Runtime REST API](/docs/api/qiskit-runtime-rest) to get this metadata. |
There was a problem hiding this comment.
I wonder if we can update this wording: the IBM Quantum Support team doesn't directly change an instance's configuration — it might seem like they have permission to do that, which they don't. Can we say something like (this may be too wordy, but its here for the idea): This can happen when an account update made by IBM Quantum Support results in a change to your instance, for example when a backend is removed from an account, it is automatically removed from an instance of the account.
riley2012
reviewed
Jul 2, 2026
riley2012
reviewed
Jul 2, 2026
|
|
||
| <Admonition type="caution" title="Always include a unique timestamp"> | ||
| The API silently ignores the request if `parameters` is identical to the previous request. In the `parameters` object, always include a `timestamp` field set to the current time so each request is treated as unique. | ||
| </Admonition> |
riley2012
reviewed
Jul 2, 2026
riley2012
reviewed
Jul 2, 2026
riley2012
reviewed
Jul 2, 2026
riley2012
reviewed
Jul 2, 2026
riley2012
left a comment
riley2012
left a comment
There was a problem hiding this comment.
@Eric-Arellano these are great improvements. Thanks for working on it! I left some comments in case you find them helpful.
abbycross
reviewed
Jul 8, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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.
Part of #5265.
This rewrite is mostly based on findings from https://github.com/IBM/qauvern using the Resource Controller API extensively.
We also add two warnings about quirks with the API.