aboutsummaryrefslogtreecommitdiffstats
path: root/crates/turtle/src/atuin_common/api.rs
diff options
context:
space:
mode:
Diffstat (limited to 'crates/turtle/src/atuin_common/api.rs')
-rw-r--r--crates/turtle/src/atuin_common/api.rs118
1 files changed, 59 insertions, 59 deletions
diff --git a/crates/turtle/src/atuin_common/api.rs b/crates/turtle/src/atuin_common/api.rs
index 1a9f348c..2f909676 100644
--- a/crates/turtle/src/atuin_common/api.rs
+++ b/crates/turtle/src/atuin_common/api.rs
@@ -5,140 +5,140 @@ use std::sync::LazyLock;
use time::OffsetDateTime;
// the usage of X- has been deprecated for quite along time, it turns out
-pub static ATUIN_HEADER_VERSION: &str = "Atuin-Version";
-pub static ATUIN_CARGO_VERSION: &str = env!("CARGO_PKG_VERSION");
+pub(crate) static ATUIN_HEADER_VERSION: &str = "Atuin-Version";
+pub(crate) static ATUIN_CARGO_VERSION: &str = env!("CARGO_PKG_VERSION");
-pub static ATUIN_VERSION: LazyLock<Version> =
+pub(crate) static ATUIN_VERSION: LazyLock<Version> =
LazyLock::new(|| Version::parse(ATUIN_CARGO_VERSION).expect("failed to parse self semver"));
#[derive(Debug, Serialize, Deserialize)]
-pub struct UserResponse {
- pub username: String,
+pub(crate) struct UserResponse {
+ pub(crate) username: String,
}
#[derive(Debug, Serialize, Deserialize)]
-pub struct RegisterRequest {
- pub email: String,
- pub username: String,
- pub password: String,
+pub(crate) struct RegisterRequest {
+ pub(crate) email: String,
+ pub(crate) username: String,
+ pub(crate) password: String,
}
#[derive(Debug, Serialize, Deserialize)]
-pub struct RegisterResponse {
- pub session: String,
+pub(crate) struct RegisterResponse {
+ pub(crate) session: String,
/// Auth type: "hub" for Hub API tokens, "cli" for legacy CLI session tokens.
/// Old servers that don't return this field will deserialize as None.
#[serde(default)]
- pub auth: Option<String>,
+ pub(crate) auth: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
-pub struct DeleteUserResponse {}
+pub(crate) struct DeleteUserResponse {}
#[derive(Debug, Serialize, Deserialize)]
-pub struct ChangePasswordRequest {
- pub current_password: String,
- pub new_password: String,
+pub(crate) struct ChangePasswordRequest {
+ pub(crate) current_password: String,
+ pub(crate) new_password: String,
}
#[derive(Debug, Serialize, Deserialize)]
-pub struct ChangePasswordResponse {}
+pub(crate) struct ChangePasswordResponse {}
#[derive(Debug, Serialize, Deserialize)]
-pub struct LoginRequest {
- pub username: String,
- pub password: String,
+pub(crate) struct LoginRequest {
+ pub(crate) username: String,
+ pub(crate) password: String,
}
#[derive(Debug, Serialize, Deserialize)]
-pub struct LoginResponse {
- pub session: String,
+pub(crate) struct LoginResponse {
+ pub(crate) session: String,
/// Auth type: "hub" for Hub API tokens, "cli" for legacy CLI session tokens.
/// Old servers that don't return this field will deserialize as None.
#[serde(default)]
- pub auth: Option<String>,
+ pub(crate) auth: Option<String>,
}
#[derive(Debug, Serialize, Deserialize)]
-pub struct AddHistoryRequest {
- pub id: String,
+pub(crate) struct AddHistoryRequest {
+ pub(crate) id: String,
#[serde(with = "time::serde::rfc3339")]
- pub timestamp: OffsetDateTime,
- pub data: String,
- pub hostname: String,
+ pub(crate) timestamp: OffsetDateTime,
+ pub(crate) data: String,
+ pub(crate) hostname: String,
}
#[derive(Debug, Serialize, Deserialize)]
-pub struct CountResponse {
- pub count: i64,
+pub(crate) struct CountResponse {
+ pub(crate) count: i64,
}
#[derive(Debug, Serialize, Deserialize)]
-pub struct SyncHistoryRequest {
+pub(crate) struct SyncHistoryRequest {
#[serde(with = "time::serde::rfc3339")]
- pub sync_ts: OffsetDateTime,
+ pub(crate) sync_ts: OffsetDateTime,
#[serde(with = "time::serde::rfc3339")]
- pub history_ts: OffsetDateTime,
- pub host: String,
+ pub(crate) history_ts: OffsetDateTime,
+ pub(crate) host: String,
}
#[derive(Debug, Serialize, Deserialize)]
-pub struct SyncHistoryResponse {
- pub history: Vec<String>,
+pub(crate) struct SyncHistoryResponse {
+ pub(crate) history: Vec<String>,
}
#[derive(Debug, Serialize, Deserialize)]
-pub struct ErrorResponse<'a> {
- pub reason: Cow<'a, str>,
+pub(crate) struct ErrorResponse<'a> {
+ pub(crate) reason: Cow<'a, str>,
}
#[derive(Debug, Serialize, Deserialize)]
-pub struct IndexResponse {
- pub homage: String,
- pub version: String,
+pub(crate) struct IndexResponse {
+ pub(crate) homage: String,
+ pub(crate) version: String,
}
#[derive(Debug, Serialize, Deserialize)]
-pub struct StatusResponse {
- pub count: i64,
- pub username: String,
- pub deleted: Vec<String>,
+pub(crate) struct StatusResponse {
+ pub(crate) count: i64,
+ pub(crate) username: String,
+ pub(crate) deleted: Vec<String>,
// These could/should also go on the index of the server
// However, we do not request the server index as a part of normal sync
// I'd rather slightly increase the size of this response, than add an extra HTTP request
- pub page_size: i64, // max page size supported by the server
- pub version: String,
+ pub(crate) page_size: i64, // max page size supported by the server
+ pub(crate) version: String,
}
#[derive(Debug, Serialize, Deserialize)]
-pub struct DeleteHistoryRequest {
- pub client_id: String,
+pub(crate) struct DeleteHistoryRequest {
+ pub(crate) client_id: String,
}
#[derive(Debug, Serialize, Deserialize)]
-pub struct MessageResponse {
- pub message: String,
+pub(crate) struct MessageResponse {
+ pub(crate) message: String,
}
#[derive(Debug, Serialize, Deserialize)]
-pub struct MeResponse {
- pub username: String,
+pub(crate) struct MeResponse {
+ pub(crate) username: String,
}
// Hub CLI authentication types
/// Response from POST /auth/cli/code - generates a code for CLI auth
#[derive(Debug, Serialize, Deserialize)]
-pub struct CliCodeResponse {
- pub code: String,
+pub(crate) struct CliCodeResponse {
+ pub(crate) code: String,
}
/// Response from GET /auth/cli/verify?code=<code> - polls for authorization
#[derive(Debug, Serialize, Deserialize)]
-pub struct CliVerifyResponse {
+pub(crate) struct CliVerifyResponse {
/// Session token, present only when authorization is complete
- pub token: Option<String>,
- pub success: Option<bool>,
- pub error: Option<String>,
+ pub(crate) token: Option<String>,
+ pub(crate) success: Option<bool>,
+ pub(crate) error: Option<String>,
}