qcs_api/apis/
default_api.rs

1/*
2 * Rigetti QCS API
3 *
4 * # Introduction  This is the documentation for the Rigetti QCS HTTP API.  You can find out more about Rigetti at [https://rigetti.com](https://rigetti.com), and also interact with QCS via the web at [https://qcs.rigetti.com](https://qcs.rigetti.com).  This API is documented in **OpenAPI format** and so is compatible with the dozens of language-specific client generators available [here](https://github.com/OpenAPITools/openapi-generator) and elsewhere on the web.  # Principles  This API follows REST design principles where appropriate, and otherwise an HTTP RPC paradigm. We adhere to the Google [API Improvement Proposals](https://google.aip.dev/general) where reasonable to provide a consistent, intuitive developer experience. HTTP response codes match their specifications, and error messages fit a common format.  # Authentication  All access to the QCS API requires OAuth2 authentication provided by Okta. You can request access [here](https://www.rigetti.com/get-quantum). Once you have a user account, you can download your access token from QCS [here](https://qcs.rigetti.com/auth/token).   That access token is valid for 24 hours after issuance. The value of `access_token` within the JSON file is the token used for authentication (don't use the entire JSON file).  Authenticate requests using the `Authorization` header and a `Bearer` prefix:  ``` curl --header \"Authorization: Bearer eyJraW...Iow\" ```  # Quantum Processor Access  Access to the quantum processors themselves is not yet provided directly by this HTTP API, but is instead performed over ZeroMQ/[rpcq](https://gitlab.com/rigetti/rpcq). Until that changes, we suggest using [pyquil](https://gitlab.com/rigetti/pyquil) to build and execute quantum programs via the Legacy API.  # Legacy API  Our legacy HTTP API remains accessible at https://forest-server.qcs.rigetti.com, and it shares a source of truth with this API's services. You can use either service with the same user account and means of authentication. We strongly recommend using the API documented here, as the legacy API is on the path to deprecation.
5 *
6 * The version of the OpenAPI document: 2020-07-31
7 * Contact: support@rigetti.com
8 * Generated by: https://openapi-generator.tech
9 */
10
11use reqwest;
12
13use super::{configuration, Error};
14use crate::apis::ResponseContent;
15
16/// struct for typed errors of method [`get_health`]
17#[derive(Debug, Clone, Serialize, Deserialize)]
18#[serde(untagged)]
19pub enum GetHealthError {
20    UnknownValue(serde_json::Value),
21}
22
23/// struct for typed errors of method [`health_check`]
24#[derive(Debug, Clone, Serialize, Deserialize)]
25#[serde(untagged)]
26pub enum HealthCheckError {
27    Status422(crate::models::ValidationError),
28    UnknownValue(serde_json::Value),
29}
30
31/// Retrieve the health status of the API
32pub async fn get_health(
33    configuration: &configuration::Configuration,
34) -> Result<crate::models::Health, Error<GetHealthError>> {
35    let local_var_configuration = configuration;
36
37    let local_var_client = &local_var_configuration.client;
38
39    let local_var_uri_str = format!("{}/", local_var_configuration.base_path);
40    let mut local_var_req_builder =
41        local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str());
42
43    if let Some(ref local_var_user_agent) = local_var_configuration.user_agent {
44        local_var_req_builder =
45            local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone());
46    }
47
48    let local_var_req = local_var_req_builder.build()?;
49    let local_var_resp = local_var_client.execute(local_var_req).await?;
50
51    let local_var_status = local_var_resp.status();
52    let local_var_content = local_var_resp.text().await?;
53
54    if !local_var_status.is_client_error() && !local_var_status.is_server_error() {
55        serde_json::from_str(&local_var_content).map_err(Error::from)
56    } else {
57        let local_var_entity: Option<GetHealthError> =
58            serde_json::from_str(&local_var_content).ok();
59        let local_var_error = ResponseContent {
60            status: local_var_status,
61            content: local_var_content,
62            entity: local_var_entity,
63        };
64        Err(Error::ResponseError(local_var_error))
65    }
66}
67
68/// Endpoint to return a status 200 for load balancer health checks
69pub async fn health_check(
70    configuration: &configuration::Configuration,
71) -> Result<serde_json::Value, Error<HealthCheckError>> {
72    let local_var_configuration = configuration;
73
74    let local_var_client = &local_var_configuration.client;
75
76    let local_var_uri_str = format!("{}/v1/", local_var_configuration.base_path);
77    let mut local_var_req_builder =
78        local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str());
79
80    if let Some(ref local_var_user_agent) = local_var_configuration.user_agent {
81        local_var_req_builder =
82            local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone());
83    }
84
85    let local_var_req = local_var_req_builder.build()?;
86    let local_var_resp = local_var_client.execute(local_var_req).await?;
87
88    let local_var_status = local_var_resp.status();
89    let local_var_content = local_var_resp.text().await?;
90
91    if !local_var_status.is_client_error() && !local_var_status.is_server_error() {
92        serde_json::from_str(&local_var_content).map_err(Error::from)
93    } else {
94        let local_var_entity: Option<HealthCheckError> =
95            serde_json::from_str(&local_var_content).ok();
96        let local_var_error = ResponseContent {
97            status: local_var_status,
98            content: local_var_content,
99            entity: local_var_entity,
100        };
101        Err(Error::ResponseError(local_var_error))
102    }
103}
qcs_api/apis/default_api.rs

qcs_api/apis/
default_api.rs
