ably_chat_openapi/models/error_info.rs
1/*
2 * Ably Chat REST API
3 *
4 * REST API for [Ably Chat](https://ably.com/docs/chat). This specification describes the HTTP surface of the Ably Chat REST API (path prefix `/chat/v4`) that the official Chat client SDKs use for request/response operations such as sending, editing, deleting and querying messages, message reactions and room occupancy. ## Scope & provenance Ably does **not** publish an official OpenAPI document for the Chat REST API (the official `ably/open-specs` `platform-v1.yaml` covers only the generic pub/sub REST API: `/channels`, `/push`, `/keys`, `/stats`, `/time`). This document was reconstructed from the `@ably/chat` JavaScript SDK v1.4.0 REST layer (`src/core/chat-api.ts`, `src/core/rest-types.ts`) together with Ably's documented REST conventions (host, authentication, versioning, pagination, error envelope). It therefore covers the endpoints the client SDK exercises. It is **not** an exhaustive description of every server capability, and there are intentionally no endpoints for creating or deleting rooms: Chat rooms are channel-backed and implicit — they are not provisioned via REST. ## Realtime vs REST Many Chat features (presence, typing indicators, room reactions, subscribing to live messages and reaction summaries) are delivered over Ably's realtime/pub-sub transport, not this REST API, and are out of scope here.
5 *
6 * The version of the OpenAPI document: 4
7 *
8 * Generated by: https://openapi-generator.tech
9 */
10
11use crate::models;
12use serde::{Deserialize, Serialize};
13
14#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
15pub struct ErrorInfo {
16 /// Ably-specific error code.
17 #[serde(rename = "code")]
18 pub code: i32,
19 /// Human-readable error message.
20 #[serde(rename = "message")]
21 pub message: String,
22 /// HTTP status code.
23 #[serde(rename = "statusCode")]
24 pub status_code: i32,
25 /// URL to Ably documentation for this error code.
26 #[serde(rename = "href", skip_serializing_if = "Option::is_none")]
27 pub href: Option<String>,
28}
29
30impl ErrorInfo {
31 pub fn new(code: i32, message: String, status_code: i32) -> ErrorInfo {
32 ErrorInfo {
33 code,
34 message,
35 status_code,
36 href: None,
37 }
38 }
39}
40