Skip to content

Commit 9a1264f

Browse files
authored
feat(qaas): update documentation (scaleway#2597)
1 parent 5c157eb commit 9a1264f

File tree

2 files changed

+14
-14
lines changed

2 files changed

+14
-14
lines changed

packages_generated/qaas/src/v1alpha1/api.gen.ts

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -98,11 +98,11 @@ const jsonContentHeaders = {
9898
/**
9999
* Quantum as a Service API.
100100
101-
This API allows you to manage Scaleway Quantum as a Service.
101+
This API allows you to allocate and program Quantum Processing Units (QPUs) to run quantum algorithms.
102102
*/
103103
export class API extends ParentAPI {
104104
/**
105-
* Get job information. Retrieve information about the provided **job ID**, such as status, payload, and result.
105+
* Get job information. Retrieve information about the provided **job ID**, mainly used to get the current status.
106106
*
107107
* @param request - The request {@link GetJobRequest}
108108
* @returns A Promise of Job
@@ -159,7 +159,7 @@ export class API extends ParentAPI {
159159
)
160160

161161
/**
162-
* List all jobs within a project or session. Retrieve information about all jobs within a given project or session.
162+
* List all jobs within a project or session. Retrieve information about all jobs within a given session.
163163
*
164164
* @param request - The request {@link ListJobsRequest}
165165
* @returns A Promise of ListJobsResponse
@@ -193,7 +193,7 @@ export class API extends ParentAPI {
193193

194194

195195
/**
196-
* Create a job. Create a job to be executed inside a session.
196+
* Create a job. Create a job to be executed inside a QPU session.
197197
*
198198
* @param request - The request {@link CreateJobRequest}
199199
* @returns A Promise of Job
@@ -326,7 +326,7 @@ export class API extends ParentAPI {
326326

327327

328328
/**
329-
* Get session information. Retrieve information about the provided **session ID**, such as name, status, and number of executed jobs.
329+
* Get session information. Retrieve information about the provided **session ID**, such as name and status.
330330
*
331331
* @param request - The request {@link GetSessionRequest}
332332
* @returns A Promise of Session
@@ -377,7 +377,7 @@ export class API extends ParentAPI {
377377
)
378378

379379
/**
380-
* List all sessions. Retrieve information about all sessions.
380+
* List all sessions. Retrieve information about all QPU sessions.
381381
*
382382
* @param request - The request {@link ListSessionsRequest}
383383
* @returns A Promise of ListSessionsResponse
@@ -387,7 +387,7 @@ export class API extends ParentAPI {
387387

388388

389389
/**
390-
* Create a session. Create a dedicated session for the specified platform.
390+
* Create a session. Create a new QPU session for the specified platform. Once ready, jobs can be sent to this session.
391391
*
392392
* @param request - The request {@link CreateSessionRequest}
393393
* @returns A Promise of Session
@@ -427,7 +427,7 @@ export class API extends ParentAPI {
427427

428428

429429
/**
430-
* Terminate an existing session. Terminate a session by its unique ID and cancel all its attached jobs and booking.
430+
* Terminate an existing session. Terminate a session by its unique ID and cancel all its attached jobs and bookings.
431431
*
432432
* @param request - The request {@link TerminateSessionRequest}
433433
* @returns A Promise of Session
@@ -445,7 +445,7 @@ export class API extends ParentAPI {
445445

446446

447447
/**
448-
* Delete an existing session. Delete a session by its unique ID and delete all its attached job and booking.
448+
* Delete an existing session. Delete a session by its unique ID and delete all its attached jobs and bookings.
449449
*
450450
* @param request - The request {@link DeleteSessionRequest}
451451
*/

packages_generated/qaas/src/v1alpha1/types.gen.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -406,23 +406,23 @@ export interface Platform {
406406
*/
407407
name: string
408408
/**
409-
* Provider name of the platform.
409+
* Name of the technological provider of the platform in lowercase (quandela, pasqal...).
410410
*/
411411
providerName: string
412412
/**
413-
* Name of the running backend over the platform (ascella, qsim, aer...).
413+
* Name of the running emulation backend or QPU model of the platform in lowercase (mosaiq, qsim, aer...).
414414
*/
415415
backendName: string
416416
/**
417-
* Type of the platform.
417+
* Type of the platform (emulator or qpu).
418418
*/
419419
type: PlatformType
420420
/**
421-
* Technology used by the platform.
421+
* Quantum technology used by the platform (trapped-ion, photonic, superconducting qubits...).
422422
*/
423423
technology: PlatformTechnology
424424
/**
425-
* Estimated maximum number of qubits supported by the platform.
425+
* Maximum number of qubits supported by the platform (estimated for emulator).
426426
*/
427427
maxQubitCount: number
428428
/**

0 commit comments

Comments
 (0)