Update /templates endpoint

Author: oguzkocer

wp_api/src/request/endpoint/templates_endpoint.rs

@@ -16,6 +16,8 @@ enum TemplatesRequest {
     Delete,
     #[delete(url = "/templates/<template_id>", output = crate::templates::TemplateWithEditContext)]
     Trash,
+    #[post(url = "/templates/<template_id>", params = &crate::templates::TemplateUpdateParams, output = crate::templates::TemplateWithEditContext)]
+    Update,
 }
 
 impl DerivedRequest for TemplatesRequest {
@@ -191,6 +193,14 @@ mod tests {
         );
     }
 
+    #[rstest]
+    fn update_template(endpoint: TemplatesRequestEndpoint) {
+        validate_wp_v2_endpoint(
+            endpoint.update(&TemplateId("foo".to_string())),
+            "/templates/foo",
+        );
+    }
+
     const EXPECTED_QUERY_PAIRS_FOR_TEMPLATE_LIST_PARAMS_WITH_ALL_FIELDS: &str =
         "wp_id=2&area=header&post_type=page";
     fn template_list_params_with_all_fields() -> TemplateListParams {

wp_api/src/templates.rs

@@ -208,3 +208,40 @@ pub struct TemplateDeleteResponse {
     pub deleted: bool,
     pub previous: TemplateWithEditContext,
 }
+
+#[derive(Debug, Default, Serialize, uniffi::Record)]
+pub struct TemplateUpdateParams {
+    // Unique slug identifying the template.
+    #[uniffi(default = None)]
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub slug: Option<String>,
+    // Theme identifier for the template.
+    #[uniffi(default = None)]
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub theme: Option<String>,
+    // Type of template.
+    #[uniffi(default = None)]
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub template_type: Option<String>,
+    // Content of template.
+    #[uniffi(default = None)]
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub content: Option<String>,
+    // Title of template.
+    #[uniffi(default = None)]
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub title: Option<String>,
+    // Description of template.
+    #[uniffi(default = None)]
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub description: Option<String>,
+    // Status of template.
+    // One of: publish, future, draft, pending, private
+    #[uniffi(default = None)]
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub status: Option<TemplateStatus>,
+    // The ID for the author of the template.
+    #[uniffi(default = None)]
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub author: Option<UserId>,
+}

wp_api_integration_tests/tests/test_templates_err.rs

@@ -1,5 +1,8 @@
 use serial_test::parallel;
-use wp_api::{WpErrorCode, templates::TemplateId};
+use wp_api::{
+    WpErrorCode,
+    templates::{TemplateId, TemplateUpdateParams},
+};
 use wp_api_integration_tests::{AssertWpError, TEMPLATE_TWENTY_TWENTY_FOUR_SINGLE, api_client};
 
 #[tokio::test]
@@ -21,3 +24,16 @@ async fn delete_template_err_template_not_found() {
         .await
         .assert_wp_error(WpErrorCode::TemplateNotFound)
 }
+
+#[tokio::test]
+#[parallel]
+async fn update_template_err_template_not_found() {
+    api_client()
+        .templates()
+        .update(
+            &TemplateId("foo".to_string()),
+            &TemplateUpdateParams::default(),
+        )
+        .await
+        .assert_wp_error(WpErrorCode::TemplateNotFound)
+}

wp_api_integration_tests/tests/test_templates_mut.rs

@@ -1,6 +1,9 @@
+use macro_helper::generate_update_test;
 use serial_test::serial;
-use wp_api::templates::{TemplateId, TemplateStatus};
-use wp_api_integration_tests::{TestCredentials, api_client, backend::RestoreServer};
+use wp_api::templates::{TemplateId, TemplateStatus, TemplateUpdateParams};
+use wp_api_integration_tests::{
+    AssertResponse, SECOND_USER_ID, TestCredentials, api_client, backend::RestoreServer,
+};
 
 #[tokio::test]
 #[serial]
@@ -46,3 +49,58 @@ async fn trash_template() {
 
     RestoreServer::db().await;
 }
+
+generate_update_test!(update_slug, slug, "new_slug".to_string());
+generate_update_test!(update_theme, theme, "new_theme".to_string());
+generate_update_test!(
+    update_template_type,
+    template_type,
+    "new_template_type".to_string()
+);
+generate_update_test!(update_content, content, "new_content".to_string());
+generate_update_test!(update_title, title, "new_title".to_string());
+generate_update_test!(
+    update_description,
+    description,
+    "new_description".to_string()
+);
+generate_update_test!(update_status, status, TemplateStatus::Pending);
+generate_update_test!(update_author, author, SECOND_USER_ID);
+
+async fn test_update_template(params: &TemplateUpdateParams) {
+    api_client()
+        .templates()
+        .update(
+            &TemplateId(
+                TestCredentials::instance()
+                    .integration_test_custom_template_id
+                    .to_string(),
+            ),
+            params,
+        )
+        .await
+        .assert_response();
+    RestoreServer::db().await;
+}
+
+mod macro_helper {
+    macro_rules! generate_update_test {
+        ($ident:ident, $field:ident, $new_value:expr) => {
+            paste::paste! {
+                #[tokio::test]
+                #[serial]
+                async fn $ident() {
+                    let updated_value = $new_value;
+                    test_update_template(
+                        &TemplateUpdateParams {
+                            $field: Some(updated_value),
+                            ..Default::default()
+                        })
+                    .await;
+                }
+            }
+        };
+    }
+
+    pub(super) use generate_update_test;
+}