Allow manually toggling the "major change" state (#347)

* add revision list endpoint

* add revision update endpoint

* bump version and sdks

* update cli to support the new commands

Author: pietroalbini

Cargo.lock

@@ -7,7 +7,7 @@
       "url": "https://oxide.computer",
       "email": "[email protected]"
     },
-    "version": "0.12.1"
+    "version": "0.12.2"
   },
   "paths": {
     "/.well-known/jwks.json": {
@@ -2119,6 +2119,63 @@
         }
       }
     },
+    "/rfd/{number}/revision": {
+      "get": {
+        "summary": "List all revisions of an RFD",
+        "operationId": "list_rfd_revisions",
+        "parameters": [
+          {
+            "in": "path",
+            "name": "number",
+            "description": "The RFD number (examples: 1 or 123)",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "in": "query",
+            "name": "limit",
+            "schema": {
+              "nullable": true,
+              "type": "integer",
+              "format": "int64"
+            }
+          },
+          {
+            "in": "query",
+            "name": "offset",
+            "schema": {
+              "nullable": true,
+              "type": "integer",
+              "format": "int64"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "successful operation",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "title": "Array_of_RfdRevisionMeta",
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/RfdRevisionMeta"
+                  }
+                }
+              }
+            }
+          },
+          "4XX": {
+            "$ref": "#/components/responses/Error"
+          },
+          "5XX": {
+            "$ref": "#/components/responses/Error"
+          }
+        }
+      }
+    },
     "/rfd/{number}/revision/{revision}": {
       "get": {
         "summary": "Get an RFD revision's metadata",
@@ -2161,6 +2218,58 @@
             "$ref": "#/components/responses/Error"
           }
         }
+      },
+      "patch": {
+        "summary": "Update the metadata of an RFD's revision",
+        "operationId": "update_rfd_revision",
+        "parameters": [
+          {
+            "in": "path",
+            "name": "number",
+            "description": "The RFD number (examples: 1 or 123)",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "in": "path",
+            "name": "revision",
+            "description": "The revision id of the RFD",
+            "required": true,
+            "schema": {
+              "$ref": "#/components/schemas/TypedUuidForRfdRevisionId"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/UpdateRfdAttrBody"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "successful operation",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/RfdRevisionMeta"
+                }
+              }
+            }
+          },
+          "4XX": {
+            "$ref": "#/components/responses/Error"
+          },
+          "5XX": {
+            "$ref": "#/components/responses/Error"
+          }
+        }
       }
     },
     "/rfd/{number}/revision/{revision}/attr/{attr}": {
@@ -4570,6 +4679,30 @@
           "updated_at"
         ]
       },
+      "RfdRevisionMeta": {
+        "type": "object",
+        "properties": {
+          "commit_sha": {
+            "$ref": "#/components/schemas/CommitSha"
+          },
+          "committed_at": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "id": {
+            "$ref": "#/components/schemas/TypedUuidForRfdRevisionId"
+          },
+          "major_change": {
+            "type": "boolean"
+          }
+        },
+        "required": [
+          "commit_sha",
+          "committed_at",
+          "id",
+          "major_change"
+        ]
+      },
       "RfdState": {
         "type": "string",
         "enum": [
@@ -5025,6 +5158,15 @@
         "type": "string",
         "format": "uuid"
       },
+      "UpdateRfdAttrBody": {
+        "type": "object",
+        "properties": {
+          "major_change": {
+            "nullable": true,
+            "type": "boolean"
+          }
+        }
+      },
       "Visibility": {
         "type": "string",
         "enum": [

rfd-api-spec.json

@@ -1,6 +1,6 @@
 [package]
 name = "rfd-api"
-version = "0.12.1"
+version = "0.12.2"
 edition = "2021"
 repository = "https://github.com/oxidecomputer/rfd-api"
 

rfd-api/Cargo.toml

@@ -17,9 +17,12 @@ use rfd_data::{
 use rfd_github::{GitHubError, GitHubNewRfdNumber, GitHubRfdRepo};
 use rfd_model::{
     schema_ext::{ContentFormat, Visibility},
-    storage::{JobFilter, JobStore, RfdFilter, RfdMetaStore, RfdPdfsStore, RfdStorage, RfdStore},
-    CommitSha, FileSha, Job, NewJob, Rfd, RfdId, RfdMeta, RfdPdf, RfdPdfs, RfdRevision,
-    RfdRevisionId,
+    storage::{
+        JobFilter, JobStore, RfdFilter, RfdMetaStore, RfdPdfsStore, RfdRevisionFilter,
+        RfdRevisionMetaStore, RfdRevisionStore, RfdStorage, RfdStore,
+    },
+    CommitSha, FileSha, Job, NewJob, NewRfdRevision, Rfd, RfdId, RfdMeta, RfdPdf, RfdPdfs,
+    RfdRevision, RfdRevisionId,
 };
 use rsa::{
     pkcs1::{DecodeRsaPrivateKey, EncodeRsaPrivateKey},
@@ -94,6 +97,25 @@ pub enum UpdateRfdContentError {
     Storage(#[from] StoreError),
 }
 
+#[derive(Debug, Clone, Deserialize, Serialize, JsonSchema)]
+pub struct RfdRevisionMeta {
+    pub id: TypedUuid<RfdRevisionId>,
+    pub commit_sha: CommitSha,
+    pub committed_at: DateTime<Utc>,
+    pub major_change: bool,
+}
+
+impl From<RfdRevision> for RfdRevisionMeta {
+    fn from(value: RfdRevision) -> Self {
+        Self {
+            id: value.id,
+            commit_sha: value.commit,
+            committed_at: value.committed_at,
+            major_change: value.major_change,
+        }
+    }
+}
+
 #[partial(RfdWithoutContent)]
 #[partial(RfdWithPdf)]
 #[derive(Debug, Clone, Deserialize, Serialize, JsonSchema)]
@@ -267,6 +289,11 @@ impl From<TypedUuid<RfdRevisionId>> for RfdRevisionIdentifier {
     }
 }
 
+#[derive(Debug, Clone)]
+pub enum RfdRevisionMetadataChange {
+    MajorChange(bool),
+}
+
 impl RfdContext {
     pub async fn new(
         public_url: String,
@@ -459,6 +486,32 @@ impl RfdContext {
         Ok(rfd_list)
     }
 
+    #[instrument(skip(self, caller))]
+    pub async fn list_revisions(
+        &self,
+        caller: &Caller<RfdPermission>,
+        rfd_number: i32,
+        pagination: &ListPagination,
+    ) -> ResourceResult<Vec<RfdRevisionMeta>, StoreError> {
+        let rfd = self.get_rfd(caller, rfd_number, None).await?;
+
+        let filter = RfdRevisionFilter::default().rfd(Some(vec![rfd.id]));
+        if caller.can(&RfdPermission::GetRfdsAll)
+            || caller.can(&RfdPermission::GetRfd(rfd_number))
+            || rfd.visibility == Visibility::Public
+        {
+            Ok(
+                RfdRevisionStore::list(&*self.storage, vec![filter], pagination)
+                    .await?
+                    .into_iter()
+                    .map(|rev| rev.into())
+                    .collect(),
+            )
+        } else {
+            resource_not_found()
+        }
+    }
+
     #[instrument(skip(self, caller))]
     async fn get_rfd(
         &self,
@@ -820,6 +873,43 @@ impl RfdContext {
         }
     }
 
+    #[instrument(skip(self, caller))]
+    pub async fn update_rfd_revision_metadata(
+        &self,
+        caller: &Caller<RfdPermission>,
+        rfd_number: i32,
+        id: TypedUuid<RfdRevisionId>,
+        changes: &[RfdRevisionMetadataChange],
+    ) -> ResourceResult<RfdRevision, StoreError> {
+        if !caller.can(&RfdPermission::UpdateRfdsAll)
+            && !caller.can(&RfdPermission::UpdateRfd(rfd_number))
+        {
+            return resource_not_found();
+        }
+
+        let rfd = self.get_rfd(caller, rfd_number, None).await?;
+        let Some(revision) = RfdRevisionStore::get(&*self.storage, &id, false).await? else {
+            return resource_not_found();
+        };
+
+        // Someone is trying to access a revision from a different RFD than the one they claim to
+        // request, probably to bypass access control.
+        if revision.rfd_id != rfd.id {
+            return resource_not_found();
+        }
+
+        let mut to_update = NewRfdRevision::from(revision);
+        for change in changes {
+            match change {
+                RfdRevisionMetadataChange::MajorChange(major_change) => {
+                    to_update.major_change = *major_change;
+                }
+            }
+        }
+
+        Ok(RfdRevisionStore::upsert(&*self.storage, to_update).await?)
+    }
+
     // Job Operations
     pub async fn list_jobs(
         &self,