Skip to content

Document resource unit fields in service instance API guide (#5790) - #5798

Open
Aryan Gupta (AryanSilver24) wants to merge 5 commits into
Qiskit:mainfrom
AryanSilver24:doc-resource-unit-fields
Open

Aryan Gupta (AryanSilver24) wants to merge 5 commits into
Qiskit:mainfrom
AryanSilver24:doc-resource-unit-fields

Conversation

@AryanSilver24

Copy link
Copy Markdown

Description

Closes #5790

Updates docs/guides/access-instances-platform-apis.mdx to document the new resource unit (RU) fields:

  • Added instance_limit_ru and usage_allocation_ru to the extensions response object in "Get an instance".
  • Added instance_limit_ru and usage_allocation_ru to the request parameters list in "Update an instance" and "Create a new instance".
  • Added an admonition clarifying that seconds and ru parameters cannot be specified simultaneously in POST/PATCH requests, and that specifying one automatically calculates the other.

Document instance_limit_ru and usage_allocation_ru fields in get, update, and create instance sections of access-instances-platform-apis guide. Clarify that seconds and RUs cannot be specified simultaneously in requests and that RUs are floating point values.

Closes Qiskit#5790
@CLAassistant

CLAassistant commented Oct 14, 2026 •

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@qiskit-bot

Copy link
Copy Markdown
Contributor

Thanks for contributing to Qiskit documentation!

Before your PR can be merged, it will first need to pass continuous integration tests and be reviewed. Sometimes the review process can be slow, so please be patient. Thanks! 🙌

One or more of the following people are relevant to this code:

  • @abbycross
  • @beckykd

Comment thread docs/guides/access-instances-platform-apis.mdx
Comment thread docs/guides/access-instances-platform-apis.mdx
Comment thread docs/guides/access-instances-platform-apis.mdx Outdated
Comment thread docs/guides/access-instances-platform-apis.mdx
Comment thread docs/guides/access-instances-platform-apis.mdx Outdated
Comment thread docs/guides/access-instances-platform-apis.mdx Outdated
Comment thread docs/guides/access-instances-platform-apis.mdx Outdated
@beckykd

Copy link
Copy Markdown
Collaborator

Hi Aryan Gupta (@AryanSilver24) , We really appreciate your contribution! In the future, please note that issues with the "Needs triage" are not yet ready for assignment. Additionally, we ask that users leave a comment on an issue, indicating that they are interested in working on that issue.

You can find details about the above, and a lot of helpful information in the the Contributing topic.

Thanks again!

Co-authored-by: Rebecca Dimock <66339736+beckykd@users.noreply.github.com>
Co-authored-by: Rebecca Dimock <66339736+beckykd@users.noreply.github.com>
Co-authored-by: Rebecca Dimock <66339736+beckykd@users.noreply.github.com>
Co-authored-by: Rebecca Dimock <66339736+beckykd@users.noreply.github.com>

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

Document resource unit fields in service instance API guide

4 participants