From 4015f5d952e9caa6474bb2e8dd0e1b306df5112f Mon Sep 17 00:00:00 2001
From: Konstantin Knizhnik <knizhnik@neon.tech>
Date: Fri, 30 Jun 2023 15:14:34 +0300
Subject: [PATCH] Add comment for NotLoaded TenentState

---
 libs/pageserver_api/src/models.rs | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/libs/pageserver_api/src/models.rs b/libs/pageserver_api/src/models.rs
index fe788e96f5..d4c916d5d5 100644
--- a/libs/pageserver_api/src/models.rs
+++ b/libs/pageserver_api/src/models.rs
@@ -54,7 +54,8 @@ use bytes::{BufMut, Bytes, BytesMut};
 )]
 #[serde(tag = "slug", content = "data")]
 pub enum TenantState {
-    /// This tenant is not yet loaded
+    /// This tenant is not yet loaded. This state is not actually used internally because not loaded tenants are handled using OnceSet.
+    /// This value is needed only for reporting state of such tenants by list_tenants() function
     ///
     NotLoaded,
     /// This tenant is being loaded from local disk.