Skip to content

Commit

Permalink
Add docstrings about x5u and tombstones
Browse files Browse the repository at this point in the history
  • Loading branch information
leplatrem committed Dec 20, 2024
1 parent 89d95d2 commit 665c2dd
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion components/remote_settings/src/client.rs
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ impl<C: ApiClient> RemoteSettingsClient<C> {
.get_last_modified_timestamp(&collection_url)?
.unwrap_or(0);
if packaged_data.timestamp > cached_timestamp {
// Remove previously cached data (packaged data does not have tombstones).
// Remove previously cached data (packaged data does not have tombstones like diff responses do).
inner.storage.empty()?;
// Insert new packaged data.
inner.storage.insert_collection_content(
Expand Down Expand Up @@ -738,6 +738,7 @@ pub struct CollectionMetadata {
#[derive(Clone, Debug, Default, Deserialize, Serialize, Eq, PartialEq)]
pub struct CollectionSignature {
pub signature: String,
/// X.509 certificate chain Url (x5u)
pub x5u: String,
}

Expand All @@ -747,6 +748,7 @@ pub struct CollectionSignature {
pub struct RemoteSettingsRecord {
pub id: String,
pub last_modified: u64,
/// Tombstone flag (see https://remote-settings.readthedocs.io/en/latest/client-specifications.html#local-state)
#[serde(default)]
pub deleted: bool,
pub attachment: Option<Attachment>,
Expand Down

0 comments on commit 665c2dd

Please sign in to comment.