diff --git a/src/compute-client/src/controller/error.rs b/src/compute-client/src/controller/error.rs index bbbf0a83e7334..1d7df8297c778 100644 --- a/src/compute-client/src/controller/error.rs +++ b/src/compute-client/src/controller/error.rs @@ -80,10 +80,10 @@ impl From for CollectionLookupError { /// Errors arising during compute replica creation. #[derive(Error, Debug)] pub enum ReplicaCreationError { - /// TODO(database-issues#7533): Add documentation. + /// The target compute instance does not exist. #[error("instance does not exist: {0}")] InstanceMissing(ComputeInstanceId), - /// TODO(database-issues#7533): Add documentation. + /// A replica with the given ID already exists on the target instance. #[error("replica exists already: {0}")] ReplicaExists(ReplicaId), } @@ -97,10 +97,10 @@ impl From for ReplicaCreationError { /// Errors arising during compute replica removal. #[derive(Error, Debug)] pub enum ReplicaDropError { - /// TODO(database-issues#7533): Add documentation. + /// The target compute instance does not exist. #[error("instance does not exist: {0}")] InstanceMissing(ComputeInstanceId), - /// TODO(database-issues#7533): Add documentation. + /// The replica to be dropped does not exist on the target instance. #[error("replica does not exist: {0}")] ReplicaMissing(ReplicaId), } @@ -183,10 +183,10 @@ impl From for PeekError { /// Errors arising during collection updates. #[derive(Error, Debug)] pub enum CollectionUpdateError { - /// TODO(database-issues#7533): Add documentation. + /// The target compute instance does not exist. #[error("instance does not exist: {0}")] InstanceMissing(ComputeInstanceId), - /// TODO(database-issues#7533): Add documentation. + /// The collection to be updated does not exist. #[error("collection does not exist: {0}")] CollectionMissing(GlobalId), } @@ -206,13 +206,13 @@ impl From for CollectionUpdateError { /// Errors arising during collection read policy assignment. #[derive(Error, Debug)] pub enum ReadPolicyError { - /// TODO(database-issues#7533): Add documentation. + /// The target compute instance does not exist. #[error("instance does not exist: {0}")] InstanceMissing(ComputeInstanceId), - /// TODO(database-issues#7533): Add documentation. + /// The collection does not exist. #[error("collection does not exist: {0}")] CollectionMissing(GlobalId), - /// TODO(database-issues#7533): Add documentation. + /// The collection is write-only and does not support read policies. #[error("collection is write-only: {0}")] WriteOnlyCollection(GlobalId), } @@ -232,7 +232,7 @@ impl From for ReadPolicyError { /// Errors arising during orphan removal. #[derive(Error, Debug)] pub enum RemoveOrphansError { - /// TODO(database-issues#7533): Add documentation. + /// An error occurred in the orchestrator while removing orphaned replicas. #[error("orchestrator error: {0}")] OrchestratorError(anyhow::Error), }