/*
* incident.io
*
* This is the API reference for incident.io. It documents available API endpoints, provides examples of how to use it, and instructions around things like authentication and error handling. The API is hosted at: - https://api.incident.io/ And you will need to create an API key via your [incident.io dashboard](https://app.incident.io/settings/api-keys) to make requests. # Making requests Here are the key concepts required to make requests to the incident.io API. ## Authentication For all requests made to the incident.io API, you'll need an API key. To create an API key, head to the incident dashboard and visit [API keys](https://app.incident.io/settings/api-keys). When you create the key, you'll be able to choose what actions it can take for your account: choose carefully, as those roles can only be set when you first create the key. We'll only show you the token once, so make sure you store it somewhere safe. API keys are global to your incident.io account, and can be managed by anyone who has the right permissions. We display the user that created the API key, and the API key will remain valid if that user becomes deactivated. Once you have the key, you should make requests to the API that set the `Authorization` request header using a \"Bearer\" authentication scheme: ``` Authorization: Bearer <YOUR_API_KEY> ``` ## Rate Limits The incident.io API enforces rate limits to ensure consistent performance for all users. The default rate limit is 1200 requests/minute per API key. This limit applies to most endpoints across the API. Limits are token buckets that refill continuously rather than resetting on a fixed window boundary. The default bucket holds 1200 requests and refills at 20 per second, so you can burst up to the full bucket and then sustain 20 requests/second indefinitely. There is no boundary at which your quota resets to full in one step. Some endpoints have lower rate limits, particularly those that interact with external third-party systems that impose their own limitations. These specific limits vary by endpoint. ### Rate limit headers Responses to requests authenticated with an API key carry your current allowance, so you can pace yourself rather than waiting to be throttled: ``` X-RateLimit-Limit: 60, 1200;window=60, 60;window=60 X-RateLimit-Remaining: 59 X-RateLimit-Used: 1 X-RateLimit-Reset: 1785173199 ``` | Header | Meaning | | --- | --- | | `X-RateLimit-Limit` | The quota that binds this request, followed by every limit that applied and the window it applies over | | `X-RateLimit-Remaining` | Requests you can make right now against the binding limit | | `X-RateLimit-Used` | Requests you have spent against it | | `X-RateLimit-Reset` | Unix timestamp (seconds) at which that limit will be back to full | More than one limit can apply to a request: your API key's overall limit, and for some endpoints a lower limit of their own. `X-RateLimit-Limit` lists all of them, each with its window, so `1200;window=60` means 1200 requests per minute. Because our limits refill continuously rather than resetting on a boundary, that window is what tells you the rate you can sustain: 1200 per 60 seconds is 20 requests/second indefinitely. `Remaining`, `Used` and `Reset` describe whichever limit has the least allowance left, since that is the one you will hit first. `X-RateLimit-Remaining` may lag by a small number of requests under high concurrency, and can move by more than the requests you made, because limits scoped to your whole organisation are shared with your other API keys. Headers are omitted rather than guessed if we cannot determine your allowance for a request. ### Exceeding a rate limit When you exceed a rate limit the API responds with `429 Too Many Requests` and a `Retry-After` header giving the number of seconds to wait: ``` X-RateLimit-Limit: 1200, 1200;window=60 X-RateLimit-Remaining: 0 X-RateLimit-Used: 1200 X-RateLimit-Reset: 1785173199 Retry-After: 1 ``` Prefer `Retry-After` over `X-RateLimit-Reset` when deciding how long to back off. `Retry-After` is when a single request will succeed; `X-RateLimit-Reset` is the later point at which your whole allowance has returned. It is a duration rather than a timestamp, so it does not depend on your clock agreeing with ours. The 429 also carries a JSON body with the same information: ```json { \"type\": \"too_many_requests\", \"status\": 429, \"request_id\": \"b839a403-7704-41c1-bf6a-39a2d68caefa\", \"rate_limit\": { \"name\": \"api_key_name\", \"limit\": 1200, \"remaining\": 0, \"retry_after\": \"2025-04-17T11:17:18Z\" }, \"errors\": [ { \"code\": \"too_many_requests\", \"message\": \"Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\" } ] } ``` The response includes: * The name of the API key (`name`) * The bucket limit (`limit`) * The number of requests remaining (`remaining`) * When you can retry requests (`retry_after`), as an RFC3339 timestamp ## Errors We use standard HTTP response codes to indicate the status or failure of API requests. The API response body will be JSON, and contain more detailed information on the nature of the error. An example error when a request is made without an API key: ```json { \"type\": \"authentication_error\", \"status\": 401, \"request_id\": \"8e3cc412-b49d-4957-9073-2c19d2c61804\", \"errors\": [ { \"code\": \"missing_authorization_material\", \"message\": \"No authorization material provided in request\" } ] } ``` Note that the error: - Contains the HTTP status (`401`) - References the type of error (`authentication_error`) - Includes a `request_id` that can be provided to incident.io support to help debug questions with your API request - Provides a list of individual errors, which go into detail about why the error occurred The most common error will be a 422 Validation Error, which is returned when the request was rejected due to failing validations. These errors look like this: ```json { \"type\": \"validation_error\", \"status\": 422, \"request_id\": \"631766c4-4afd-4803-997c-cd700928fa4b\", \"errors\": [ { \"code\": \"is_required\", \"message\": \"A severity is required to open an incident\", \"source\": { \"field\": \"severity_id\" } } ] } ``` This error is caused by not providing a severity identifier, which should be at the `severity_id` field of the request payload. Errors like these can be mapped to forms, should you be integrating with the API from a user-interface. ## Compatibility We won't make breaking changes to existing API services or endpoints, but will expect integrators to upgrade themselves to the latest API endpoints within 3 months of us deprecating the old service. We will make changes that are considered backwards compatible, which include: - Adding new API endpoints and services - Adding new properties to responses from existing API endpoints - Reordering properties returned from existing API endpoints - Adding optional request parameters to existing API endpoints - Altering the format or length of IDs - Adding new values to enums It is important that clients are robust to these changes, to ensure reliable integrations. As an example, if you are generating a client using an openapi-generator, ensure the generated client is configured to support unknown enum values, often configured via the `enumUnknownDefaultCase` parameter. When breaking changes are unavoidable, we'll create a new service version on a separate path, and run them in parallel. For example: - https://api.incident.io/v1/incidents - https://api.incident.io/v2/incidents For any questions, email support@incident.io.
*
* The version of the OpenAPI document: 1.0.0
*
* Generated by: https://openapi-generator.tech
*/
use super::{configuration, ContentType, Error};
use crate::{apis::ResponseContent, models};
use reqwest;
use serde::{de::Error as _, Deserialize, Serialize};
/// struct for passing parameters to the method [`incident_timeline_items_v2_create`]
#[derive(Clone, Debug)]
#[non_exhaustive]
pub struct IncidentTimelineItemsV2CreateParams {
pub incident_timeline_items_create_payload_v2: models::IncidentTimelineItemsCreatePayloadV2,
}
/// struct for passing parameters to the method [`incident_timeline_items_v2_list`]
#[derive(Clone, Debug)]
#[non_exhaustive]
pub struct IncidentTimelineItemsV2ListParams {
/// Incident whose timeline you want to list
pub incident_id: String,
/// Integer number of records to return
pub page_size: Option<i64>,
/// A timeline item's ID. This endpoint returns the items that follow it.
pub after: Option<String>,
}
/// struct for passing parameters to the method [`incident_timeline_items_v2_update`]
#[derive(Clone, Debug)]
#[non_exhaustive]
pub struct IncidentTimelineItemsV2UpdateParams {
/// Timeline item to edit
pub id: String,
pub incident_timeline_items_update_payload_v2: models::IncidentTimelineItemsUpdatePayloadV2,
}
/// struct for typed errors of method [`incident_timeline_items_v2_create`]
#[non_exhaustive]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum IncidentTimelineItemsV2CreateError {
Status400(models::ErrorResponse),
Status401(models::ErrorResponse),
Status403(models::ErrorResponse),
Status404(models::ErrorResponse),
Status405(models::ErrorResponse),
Status406(models::ErrorResponse),
Status408(models::ErrorResponse),
Status409(models::ErrorResponse),
Status412(models::ErrorResponse),
Status413(models::ErrorResponse),
Status422(models::ErrorResponse),
Status429(models::ErrorResponse),
Status500(models::ErrorResponse),
UnknownValue(serde_json::Value),
}
/// struct for typed errors of method [`incident_timeline_items_v2_list`]
#[non_exhaustive]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum IncidentTimelineItemsV2ListError {
Status400(models::ErrorResponse),
Status401(models::ErrorResponse),
Status403(models::ErrorResponse),
Status404(models::ErrorResponse),
Status405(models::ErrorResponse),
Status406(models::ErrorResponse),
Status408(models::ErrorResponse),
Status409(models::ErrorResponse),
Status412(models::ErrorResponse),
Status413(models::ErrorResponse),
Status422(models::ErrorResponse),
Status429(models::ErrorResponse),
Status500(models::ErrorResponse),
UnknownValue(serde_json::Value),
}
/// struct for typed errors of method [`incident_timeline_items_v2_update`]
#[non_exhaustive]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum IncidentTimelineItemsV2UpdateError {
Status400(models::ErrorResponse),
Status401(models::ErrorResponse),
Status403(models::ErrorResponse),
Status404(models::ErrorResponse),
Status405(models::ErrorResponse),
Status406(models::ErrorResponse),
Status408(models::ErrorResponse),
Status409(models::ErrorResponse),
Status412(models::ErrorResponse),
Status413(models::ErrorResponse),
Status422(models::ErrorResponse),
Status429(models::ErrorResponse),
Status500(models::ErrorResponse),
UnknownValue(serde_json::Value),
}
/// Add a custom item to an incident's timeline. Items created here are custom, so they carry no activity_log_id and their timestamp stays editable. Set it to when the thing actually happened rather than when you're telling us about it - a deploy you shipped an hour ago belongs an hour back on the timeline. Every request needs an idempotency_key. Retrying with a key we've already seen returns the item the first request created rather than writing a second one, so an automation that retries on a timeout doesn't leave a duplicate behind.
pub async fn incident_timeline_items_v2_create(
configuration: &configuration::Configuration,
params: IncidentTimelineItemsV2CreateParams,
) -> Result<models::IncidentTimelineItemsCreateResultV2, Error<IncidentTimelineItemsV2CreateError>>
{
let uri_str = format!("{}/v2/incident_timeline_items", configuration.base_path);
let mut req_builder = configuration
.client
.request(reqwest::Method::POST, &uri_str);
if let Some(ref user_agent) = configuration.user_agent {
req_builder = req_builder.header(reqwest::header::USER_AGENT, user_agent.clone());
}
if let Some(ref token) = configuration.bearer_access_token {
req_builder = req_builder.bearer_auth(token.to_owned());
};
req_builder = req_builder.json(¶ms.incident_timeline_items_create_payload_v2);
let req = req_builder.build()?;
let resp = configuration.client.execute(req).await?;
let status = resp.status();
let content_type = resp
.headers()
.get("content-type")
.and_then(|v| v.to_str().ok())
.unwrap_or("application/octet-stream");
let content_type = super::ContentType::from(content_type);
if !status.is_client_error() && !status.is_server_error() {
let content = resp.text().await?;
match content_type {
ContentType::Json => serde_path_to_error::deserialize(&mut serde_json::Deserializer::from_str(&content)).map_err(Error::from),
ContentType::Text => return Err(Error::from(serde_json::Error::custom("Received `text/plain` content type response that cannot be converted to `models::IncidentTimelineItemsCreateResultV2`"))),
ContentType::Unsupported(unknown_type) => return Err(Error::from(serde_json::Error::custom(format!("Received `{unknown_type}` content type response that cannot be converted to `models::IncidentTimelineItemsCreateResultV2`")))),
}
} else {
let content = resp.text().await?;
let entity: Option<IncidentTimelineItemsV2CreateError> =
serde_json::from_str::<models::ErrorResponse>(&content)
.ok()
.map(|body| IncidentTimelineItemsV2CreateError::from_status(status.as_u16(), body));
Err(Error::ResponseError(ResponseContent {
status,
content,
entity,
}))
}
}
/// List the timeline items for an incident, oldest first. Items are ordered by timestamp, then by ID to break ties, which is the order the dashboard shows them in. If the incident has streams, this returns the items on its streams too - they're part of the same narrative - and incident_id on each item tells you which stream it came from. Items can be edited after they're written, and this endpoint always returns their current state, so listing an incident again gives you the timeline as it stands today.
pub async fn incident_timeline_items_v2_list(
configuration: &configuration::Configuration,
params: IncidentTimelineItemsV2ListParams,
) -> Result<models::IncidentTimelineItemsListResultV2, Error<IncidentTimelineItemsV2ListError>> {
let uri_str = format!("{}/v2/incident_timeline_items", configuration.base_path);
let mut req_builder = configuration.client.request(reqwest::Method::GET, &uri_str);
req_builder = req_builder.query(&[("incident_id", ¶ms.incident_id.to_string())]);
if let Some(ref param_value) = params.page_size {
req_builder = req_builder.query(&[("page_size", ¶m_value.to_string())]);
}
if let Some(ref param_value) = params.after {
req_builder = req_builder.query(&[("after", ¶m_value.to_string())]);
}
if let Some(ref user_agent) = configuration.user_agent {
req_builder = req_builder.header(reqwest::header::USER_AGENT, user_agent.clone());
}
if let Some(ref token) = configuration.bearer_access_token {
req_builder = req_builder.bearer_auth(token.to_owned());
};
let req = req_builder.build()?;
let resp = configuration.client.execute(req).await?;
let status = resp.status();
let content_type = resp
.headers()
.get("content-type")
.and_then(|v| v.to_str().ok())
.unwrap_or("application/octet-stream");
let content_type = super::ContentType::from(content_type);
if !status.is_client_error() && !status.is_server_error() {
let content = resp.text().await?;
match content_type {
ContentType::Json => serde_path_to_error::deserialize(&mut serde_json::Deserializer::from_str(&content)).map_err(Error::from),
ContentType::Text => return Err(Error::from(serde_json::Error::custom("Received `text/plain` content type response that cannot be converted to `models::IncidentTimelineItemsListResultV2`"))),
ContentType::Unsupported(unknown_type) => return Err(Error::from(serde_json::Error::custom(format!("Received `{unknown_type}` content type response that cannot be converted to `models::IncidentTimelineItemsListResultV2`")))),
}
} else {
let content = resp.text().await?;
let entity: Option<IncidentTimelineItemsV2ListError> =
serde_json::from_str::<models::ErrorResponse>(&content)
.ok()
.map(|body| IncidentTimelineItemsV2ListError::from_status(status.as_u16(), body));
Err(Error::ResponseError(ResponseContent {
status,
content,
entity,
}))
}
}
/// Edit a timeline item. Fields you leave out are unchanged, and an empty description removes it. Timestamp can only be changed on a custom item: a promoted one follows the activity it came from.
pub async fn incident_timeline_items_v2_update(
configuration: &configuration::Configuration,
params: IncidentTimelineItemsV2UpdateParams,
) -> Result<models::IncidentTimelineItemsUpdateResultV2, Error<IncidentTimelineItemsV2UpdateError>>
{
let uri_str = format!(
"{}/v2/incident_timeline_items/{id}",
configuration.base_path,
id = crate::apis::urlencode(params.id)
);
let mut req_builder = configuration
.client
.request(reqwest::Method::PATCH, &uri_str);
if let Some(ref user_agent) = configuration.user_agent {
req_builder = req_builder.header(reqwest::header::USER_AGENT, user_agent.clone());
}
if let Some(ref token) = configuration.bearer_access_token {
req_builder = req_builder.bearer_auth(token.to_owned());
};
req_builder = req_builder.json(¶ms.incident_timeline_items_update_payload_v2);
let req = req_builder.build()?;
let resp = configuration.client.execute(req).await?;
let status = resp.status();
let content_type = resp
.headers()
.get("content-type")
.and_then(|v| v.to_str().ok())
.unwrap_or("application/octet-stream");
let content_type = super::ContentType::from(content_type);
if !status.is_client_error() && !status.is_server_error() {
let content = resp.text().await?;
match content_type {
ContentType::Json => serde_path_to_error::deserialize(&mut serde_json::Deserializer::from_str(&content)).map_err(Error::from),
ContentType::Text => return Err(Error::from(serde_json::Error::custom("Received `text/plain` content type response that cannot be converted to `models::IncidentTimelineItemsUpdateResultV2`"))),
ContentType::Unsupported(unknown_type) => return Err(Error::from(serde_json::Error::custom(format!("Received `{unknown_type}` content type response that cannot be converted to `models::IncidentTimelineItemsUpdateResultV2`")))),
}
} else {
let content = resp.text().await?;
let entity: Option<IncidentTimelineItemsV2UpdateError> =
serde_json::from_str::<models::ErrorResponse>(&content)
.ok()
.map(|body| IncidentTimelineItemsV2UpdateError::from_status(status.as_u16(), body));
Err(Error::ResponseError(ResponseContent {
status,
content,
entity,
}))
}
}
// --- generated by scripts/fix_generated.py ---
impl IncidentTimelineItemsV2CreateParams {
/// The required parameters. Set the optional ones with the
/// `set_*` methods below.
#[must_use]
pub fn new(
incident_timeline_items_create_payload_v2: models::IncidentTimelineItemsCreatePayloadV2,
) -> Self {
Self {
incident_timeline_items_create_payload_v2,
}
}
/// Sets `incident_timeline_items_create_payload_v2`.
#[must_use]
pub fn set_incident_timeline_items_create_payload_v2(
mut self,
value: models::IncidentTimelineItemsCreatePayloadV2,
) -> Self {
self.incident_timeline_items_create_payload_v2 = value;
self
}
}
impl IncidentTimelineItemsV2ListParams {
/// The required parameters. Set the optional ones with the
/// `set_*` methods below.
#[must_use]
pub fn new(incident_id: impl Into<String>) -> Self {
Self {
incident_id: incident_id.into(),
page_size: None,
after: None,
}
}
/// Sets `incident_id`.
#[must_use]
pub fn set_incident_id(mut self, value: impl Into<String>) -> Self {
self.incident_id = value.into();
self
}
/// Sets `page_size`.
#[must_use]
pub fn set_page_size(mut self, value: i64) -> Self {
self.page_size = Some(value);
self
}
/// Sets `after`.
#[must_use]
pub fn set_after(mut self, value: impl Into<String>) -> Self {
self.after = Some(value.into());
self
}
}
impl IncidentTimelineItemsV2UpdateParams {
/// The required parameters. Set the optional ones with the
/// `set_*` methods below.
#[must_use]
pub fn new(
id: impl Into<String>,
incident_timeline_items_update_payload_v2: models::IncidentTimelineItemsUpdatePayloadV2,
) -> Self {
Self {
id: id.into(),
incident_timeline_items_update_payload_v2,
}
}
/// Sets `id`.
#[must_use]
pub fn set_id(mut self, value: impl Into<String>) -> Self {
self.id = value.into();
self
}
/// Sets `incident_timeline_items_update_payload_v2`.
#[must_use]
pub fn set_incident_timeline_items_update_payload_v2(
mut self,
value: models::IncidentTimelineItemsUpdatePayloadV2,
) -> Self {
self.incident_timeline_items_update_payload_v2 = value;
self
}
}
impl IncidentTimelineItemsV2CreateError {
/// The variant matching the response's HTTP status.
///
/// Not `serde`: every variant holds the same type and the enum
/// is `#[serde(untagged)]`, so deserializing would always return
/// the lowest status code the endpoint documents.
fn from_status(status: u16, body: models::ErrorResponse) -> Self {
match status {
400 => Self::Status400(body),
401 => Self::Status401(body),
403 => Self::Status403(body),
404 => Self::Status404(body),
405 => Self::Status405(body),
406 => Self::Status406(body),
408 => Self::Status408(body),
409 => Self::Status409(body),
412 => Self::Status412(body),
413 => Self::Status413(body),
422 => Self::Status422(body),
429 => Self::Status429(body),
500 => Self::Status500(body),
_ => Self::UnknownValue(serde_json::to_value(body).unwrap_or(serde_json::Value::Null)),
}
}
}
impl IncidentTimelineItemsV2ListError {
/// The variant matching the response's HTTP status.
///
/// Not `serde`: every variant holds the same type and the enum
/// is `#[serde(untagged)]`, so deserializing would always return
/// the lowest status code the endpoint documents.
fn from_status(status: u16, body: models::ErrorResponse) -> Self {
match status {
400 => Self::Status400(body),
401 => Self::Status401(body),
403 => Self::Status403(body),
404 => Self::Status404(body),
405 => Self::Status405(body),
406 => Self::Status406(body),
408 => Self::Status408(body),
409 => Self::Status409(body),
412 => Self::Status412(body),
413 => Self::Status413(body),
422 => Self::Status422(body),
429 => Self::Status429(body),
500 => Self::Status500(body),
_ => Self::UnknownValue(serde_json::to_value(body).unwrap_or(serde_json::Value::Null)),
}
}
}
impl IncidentTimelineItemsV2UpdateError {
/// The variant matching the response's HTTP status.
///
/// Not `serde`: every variant holds the same type and the enum
/// is `#[serde(untagged)]`, so deserializing would always return
/// the lowest status code the endpoint documents.
fn from_status(status: u16, body: models::ErrorResponse) -> Self {
match status {
400 => Self::Status400(body),
401 => Self::Status401(body),
403 => Self::Status403(body),
404 => Self::Status404(body),
405 => Self::Status405(body),
406 => Self::Status406(body),
408 => Self::Status408(body),
409 => Self::Status409(body),
412 => Self::Status412(body),
413 => Self::Status413(body),
422 => Self::Status422(body),
429 => Self::Status429(body),
500 => Self::Status500(body),
_ => Self::UnknownValue(serde_json::to_value(body).unwrap_or(serde_json::Value::Null)),
}
}
}