caution on pub types

Signed-off-by: oflatt <oflatt@gmail.com>

Author: oflatt

cedar-policy-validator/src/entity_manifest.rs

@@ -45,6 +45,9 @@ use crate::{
 ///
 /// `T` represents an optional type annotation on each
 /// node in the [`AccessTrie`].
+// CAUTION: this type is publicly exported in `cedar-policy`.
+// Don't make fields `pub`, don't make breaking changes, and use caution
+// when adding public methods.
 #[doc = include_str!("../../cedar-policy/experimental_warning.md")]
 #[serde_as]
 #[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
@@ -61,10 +64,16 @@ where
 /// A map of data fields to [`AccessTrie`]s.
 /// The keys to this map form the edges in the access trie,
 /// pointing to sub-tries.
+// CAUTION: this type is publicly exported in `cedar-policy`.
+// Don't make fields `pub`, don't make breaking changes, and use caution
+// when adding public methods.
 #[doc = include_str!("../../cedar-policy/experimental_warning.md")]
 pub type Fields<T> = HashMap<SmolStr, Box<AccessTrie<T>>>;
 
 /// The root of a data path or [`RootAccessTrie`].
+// CAUTION: this type is publicly exported in `cedar-policy`.
+// Don't make fields `pub`, don't make breaking changes, and use caution
+// when adding public methods.
 #[doc = include_str!("../../cedar-policy/experimental_warning.md")]
 #[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, Hash)]
 pub enum EntityRoot {
@@ -92,6 +101,9 @@ impl Display for EntityRoot {
 ///
 /// `T` represents an optional type annotation on each
 /// node in the [`AccessTrie`].
+// CAUTION: this type is publicly exported in `cedar-policy`.
+// Don't make fields `pub`, don't make breaking changes, and use caution
+// when adding public methods.
 #[doc = include_str!("../../cedar-policy/experimental_warning.md")]
 #[serde_as]
 #[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
@@ -110,6 +122,10 @@ where
 ///
 /// `T` represents an optional type annotation on each
 /// node in the [`AccessTrie`].
+///
+// CAUTION: this type is publicly exported in `cedar-policy`.
+// Don't make fields `pub`, don't make breaking changes, and use caution
+// when adding public methods.
 #[doc = include_str!("../../cedar-policy/experimental_warning.md")]
 #[serde_as]
 #[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
@@ -200,6 +216,9 @@ impl Diagnostic for PartialRequestError {}
 /// An error generated by entity slicing.
 /// See [`FailedAnalysisError`] for details on the fragment
 /// of Cedar handled by entity slicing.
+// CAUTION: this type is publicly exported in `cedar-policy`.
+// Don't make fields `pub`, don't make breaking changes, and use caution
+// when adding public methods.
 #[derive(Debug, Error, Diagnostic)]
 #[non_exhaustive]
 pub enum EntityManifestError {