Skip to content

Delete /templates endpoint #721

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: trunk
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions wp_api/src/api_error.rs
Original file line number Diff line number Diff line change
Expand Up @@ -256,6 +256,8 @@ pub enum WpErrorCode {
InvalidField,
#[serde(rename = "rest_invalid_param")]
InvalidParam,
#[serde(rename = "rest_invalid_template")]
InvalidTemplate,
#[serde(rename = "rest_no_search_term_defined")]
NoSearchTermDefined,
#[serde(rename = "rest_orderby_include_missing_include")]
Expand All @@ -270,6 +272,10 @@ pub enum WpErrorCode {
PostInvalidPageNumber,
#[serde(rename = "rest_taxonomy_invalid")]
TaxonomyInvalid,
#[serde(rename = "rest_template_already_trashed")]
TemplateAlreadyTrashed,
#[serde(rename = "rest_template_not_found")]
TemplateNotFound,
#[serde(rename = "rest_term_invalid")]
TermInvalid,
#[serde(rename = "rest_theme_not_found")]
Expand Down
28 changes: 28 additions & 0 deletions wp_api/src/request/endpoint/templates_endpoint.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,21 @@ enum TemplatesRequest {
List,
#[contextual_get(url = "/templates/<template_id>", output = crate::templates::SparseTemplate, filter_by = crate::templates::SparseTemplateField)]
Retrieve,
#[delete(url = "/templates/<template_id>", output = crate::templates::TemplateDeleteResponse)]
Delete,
#[delete(url = "/templates/<template_id>", output = crate::templates::TemplateWithEditContext)]
Trash,
}

impl DerivedRequest for TemplatesRequest {
fn additional_query_pairs(&self) -> Vec<(&str, String)> {
match self {
TemplatesRequest::Delete => vec![("force", true.to_string())],
TemplatesRequest::Trash => vec![("force", false.to_string())],
_ => vec![],
}
}

fn namespace() -> impl AsNamespace {
WpNamespace::WpV2
}
Expand Down Expand Up @@ -161,6 +173,22 @@ mod tests {
);
}

#[rstest]
fn delete_template(endpoint: TemplatesRequestEndpoint) {
validate_wp_v2_endpoint(
endpoint.delete(&TemplateId("foo".to_string())),
"/templates/foo?force=true",
);
}

#[rstest]
fn trash_template(endpoint: TemplatesRequestEndpoint) {
validate_wp_v2_endpoint(
endpoint.trash(&TemplateId("foo".to_string())),
"/templates/foo?force=false",
);
}

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 {
Expand Down
6 changes: 6 additions & 0 deletions wp_api/src/templates.rs
Original file line number Diff line number Diff line change
Expand Up @@ -196,3 +196,9 @@ pub struct SparseTemplateTitle {
pub raw: Option<String>,
pub rendered: Option<String>,
}

#[derive(Debug, Serialize, Deserialize, uniffi::Record)]
pub struct TemplateDeleteResponse {
pub deleted: bool,
pub previous: TemplateWithEditContext,
}
1 change: 1 addition & 0 deletions wp_api_integration_tests/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ pub const POST_TEMPLATE_SINGLE_WITH_SIDEBAR: &str = "single-with-sidebar";
pub const THEME_TWENTY_TWENTY_FIVE: &str = "twentytwentyfive";
pub const THEME_TWENTY_TWENTY_FOUR: &str = "twentytwentyfour";
pub const THEME_TWENTY_TWENTY_THREE: &str = "twentytwentythree";
pub const TEMPLATE_CUSTOM: &str = "CustomTemplateToBeUsedInIntegrationTests";

pub fn api_client() -> WpApiClient {
WpApiClient::new(
Expand Down
23 changes: 23 additions & 0 deletions wp_api_integration_tests/tests/test_templates_err.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
use serial_test::parallel;
use wp_api::{WpErrorCode, templates::TemplateId};
use wp_api_integration_tests::{AssertWpError, TEMPLATE_TWENTY_TWENTY_FOUR_SINGLE, api_client};

#[tokio::test]
#[parallel]
async fn delete_template_err_invalid_template() {
api_client()
.templates()
.delete(&TemplateId(TEMPLATE_TWENTY_TWENTY_FOUR_SINGLE.to_string()))
.await
.assert_wp_error(WpErrorCode::InvalidTemplate)
}

#[tokio::test]
#[parallel]
async fn delete_template_err_template_not_found() {
api_client()
.templates()
.delete(&TemplateId("foo".to_string()))
.await
.assert_wp_error(WpErrorCode::TemplateNotFound)
}
20 changes: 20 additions & 0 deletions wp_api_integration_tests/tests/test_templates_mut.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
use serial_test::serial;
use wp_api::templates::TemplateId;
use wp_api_integration_tests::{TEMPLATE_CUSTOM, api_client, backend::RestoreServer};

#[tokio::test]
#[serial]
async fn delete_template() {
let template_delete_response = api_client()
.templates()
.delete(&TemplateId(TEMPLATE_CUSTOM.to_string()))
.await;
assert!(
template_delete_response.is_ok(),
"{:#?}",
template_delete_response
);
assert!(template_delete_response.unwrap().data.deleted);

RestoreServer::db().await;
}