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

api_client: implement workspaces() query #200

Merged
merged 3 commits into from
Nov 25, 2024
Merged

Conversation

airwoodix
Copy link
Collaborator

@airwoodix airwoodix commented Nov 20, 2024

Summary

Following up on #198, this patch implements a client for the GET /workspaces endpoint on the portal API.

The new PortalClient is used in the AQTProvider implementation to query the data for remote workspaces in the BackendTable. The related code in the adapted on a least-effort basis. In particular, since there's no dedicated client for the direct-access API, the AQTDirectAccessResource implementation still uses the ad-hoc factory for a bare httpx.Client.

The documentation gets a new section in the reference chapter, with documentation for the new PortalClient and related types, including usage examples.

⚠️ This patch is in principle breaking, since it changes the public API of certain types documented in the package's public API. The typical Qiskit usage is however not affected (the examples don't need to be modified).

Details and comments

@airwoodix airwoodix self-assigned this Nov 20, 2024
@airwoodix airwoodix force-pushed the api-client-workspaces branch 2 times, most recently from 05478fe to 05afb41 Compare November 21, 2024 07:58
@airwoodix airwoodix force-pushed the api-client-workspaces branch from 05afb41 to 86590b3 Compare November 21, 2024 08:10
@airwoodix airwoodix marked this pull request as ready for review November 21, 2024 08:18
@airwoodix airwoodix merged commit 4cdae25 into master Nov 25, 2024
15 checks passed
@airwoodix airwoodix deleted the api-client-workspaces branch November 25, 2024 10:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants