make repo get and put endpoints more conventional

Author: david-crespo

nexus/external-api/output/nexus_tags.txt

@@ -296,9 +296,9 @@ ping                                     GET      /v1/ping
 
 API operations found with tag "system/update"
 OPERATION ID                             METHOD   URL PATH
-system_update_get_repository             GET      /v1/system/update/repository/{system_version}
-system_update_put_repository             PUT      /v1/system/update/repository
 system_update_repository_list            GET      /v1/system/update/repositories
+system_update_repository_upload          PUT      /v1/system/update/repositories
+system_update_repository_view            GET      /v1/system/update/repositories/{system_version}
 system_update_trust_root_create          POST     /v1/system/update/trust-roots
 system_update_trust_root_delete          DELETE   /v1/system/update/trust-roots/{trust_root_id}
 system_update_trust_root_list            GET      /v1/system/update/trust-roots

nexus/external-api/src/lib.rs

@@ -2967,11 +2967,11 @@ pub trait NexusExternalApi {
     /// System release repositories are verified by the updates trust store.
     #[endpoint {
         method = PUT,
-        path = "/v1/system/update/repository",
+        path = "/v1/system/update/repositories",
         tags = ["system/update"],
         request_body_max_bytes = PUT_UPDATE_REPOSITORY_MAX_BYTES,
     }]
-    async fn system_update_put_repository(
+    async fn system_update_repository_upload(
         rqctx: RequestContext<Self::Context>,
         query: Query<params::UpdatesPutRepositoryParams>,
         body: StreamingBody,
@@ -2980,10 +2980,10 @@ pub trait NexusExternalApi {
     /// Fetch system release repository description by version
     #[endpoint {
         method = GET,
-        path = "/v1/system/update/repository/{system_version}",
+        path = "/v1/system/update/repositories/{system_version}",
         tags = ["system/update"],
     }]
-    async fn system_update_get_repository(
+    async fn system_update_repository_view(
         rqctx: RequestContext<Self::Context>,
         path_params: Path<params::UpdatesGetRepositoryParams>,
     ) -> Result<HttpResponseOk<views::TufRepo>, HttpError>;

nexus/src/external_api/http_entrypoints.rs

@@ -6639,7 +6639,7 @@ impl NexusExternalApi for NexusExternalApiImpl {
 
     // Updates
 
-    async fn system_update_put_repository(
+    async fn system_update_repository_upload(
         rqctx: RequestContext<ApiContext>,
         query: Query<params::UpdatesPutRepositoryParams>,
         body: StreamingBody,
@@ -6664,7 +6664,7 @@ impl NexusExternalApi for NexusExternalApiImpl {
             .await
     }
 
-    async fn system_update_get_repository(
+    async fn system_update_repository_view(
         rqctx: RequestContext<ApiContext>,
         path_params: Path<params::UpdatesGetRepositoryParams>,
     ) -> Result<HttpResponseOk<views::TufRepo>, HttpError> {

nexus/tests/integration_tests/endpoints.rs

@@ -2535,16 +2535,21 @@ pub static VERIFY_ENDPOINTS: LazyLock<Vec<VerifyEndpoint>> = LazyLock::new(
                 ],
             },
             VerifyEndpoint {
-                url: "/v1/system/update/repository?file_name=demo-repo.zip",
+                url: "/v1/system/update/repositories?file_name=demo-repo.zip",
                 visibility: Visibility::Public,
                 unprivileged_access: UnprivilegedAccess::None,
-                allowed_methods: vec![AllowedMethod::Put(
-                    // In reality this is the contents of a zip file.
-                    serde_json::Value::Null,
-                )],
+                allowed_methods: vec![
+                    // the query param is only relevant to the put
+                    AllowedMethod::Put(
+                        // In reality this is the contents of a zip file.
+                        serde_json::Value::Null,
+                    ),
+                    // get doesn't use the query param but it doesn't break if it's there
+                    AllowedMethod::Get
+                ],
             },
             VerifyEndpoint {
-                url: "/v1/system/update/repository/1.0.0",
+                url: "/v1/system/update/repositories/1.0.0",
                 visibility: Visibility::Public,
                 unprivileged_access: UnprivilegedAccess::None,
                 allowed_methods: vec![AllowedMethod::Get],

nexus/tests/integration_tests/updates.rs

@@ -140,7 +140,7 @@ impl TestRepo {
         expected_status: StatusCode,
     ) -> NexusRequest<'a> {
         let url = format!(
-            "/v1/system/update/repository?file_name={}",
+            "/v1/system/update/repositories?file_name={}",
             self.0.file_name().expect("archive path must have a file name")
         );
         let request = RequestBuilder::new(client, Method::PUT, &url)
@@ -196,7 +196,7 @@ async fn test_repo_upload_unconfigured() -> Result<()> {
     // with a 404 error.
     object_get_error(
         client,
-        "/v1/system/update/repository/1.0.0",
+        "/v1/system/update/repositories/1.0.0",
         StatusCode::NOT_FOUND,
     )
     .await;
@@ -348,7 +348,7 @@ async fn test_repo_upload() -> Result<()> {
 
     // Now get the repository that was just uploaded.
     let repo =
-        object_get::<TufRepo>(client, "/v1/system/update/repository/1.0.0")
+        object_get::<TufRepo>(client, "/v1/system/update/repositories/1.0.0")
             .await;
 
     // Compare just the repo metadata (not artifacts)
@@ -525,9 +525,11 @@ async fn test_repo_upload() -> Result<()> {
         );
 
         // Now get the repository that was just uploaded.
-        let get_repo =
-            object_get::<TufRepo>(client, "/v1/system/update/repository/2.0.0")
-                .await;
+        let get_repo = object_get::<TufRepo>(
+            client,
+            "/v1/system/update/repositories/2.0.0",
+        )
+        .await;
 
         // Validate the repo metadata
         assert_eq!(get_repo.system_version.to_string(), "2.0.0");

nexus/types/src/external_api/params.rs

@@ -2398,14 +2398,14 @@ pub struct ResourceMetrics {
 
 // SYSTEM UPDATE
 
-/// Parameters for PUT requests for `/v1/system/update/repository`.
+/// Parameters for PUT requests for `/v1/system/update/repositories`.
 #[derive(Clone, Debug, Deserialize, Serialize, JsonSchema)]
 pub struct UpdatesPutRepositoryParams {
     /// The name of the uploaded file.
     pub file_name: String,
 }
 
-/// Parameters for GET requests for `/v1/system/update/repository`.
+/// Parameters for GET requests for `/v1/system/update/repositories`.
 #[derive(Clone, Debug, Deserialize, JsonSchema)]
 pub struct UpdatesGetRepositoryParams {
     /// The version to get.

openapi/nexus.json

@@ -10961,16 +10961,14 @@
         "x-dropshot-pagination": {
           "required": []
         }
-      }
-    },
-    "/v1/system/update/repository": {
+      },
       "put": {
         "tags": [
           "system/update"
         ],
         "summary": "Upload system release repository",
         "description": "System release repositories are verified by the updates trust store.",
-        "operationId": "system_update_put_repository",
+        "operationId": "system_update_repository_upload",
         "parameters": [
           {
             "in": "query",
@@ -11013,13 +11011,13 @@
         }
       }
     },
-    "/v1/system/update/repository/{system_version}": {
+    "/v1/system/update/repositories/{system_version}": {
       "get": {
         "tags": [
           "system/update"
         ],
         "summary": "Fetch system release repository description by version",
-        "operationId": "system_update_get_repository",
+        "operationId": "system_update_repository_view",
         "parameters": [
           {
             "in": "path",