Allow skipping GDPR-erasure when deactivating a user through the admin API

[AndrewFerr]

Fixes #4742

This allows using the endpoint to deactivate a user without GDPR-erasing it

[cloudflare-workers-and-pages]

Deploying matrix-authentication-service-docs with    Cloudflare Pages

Latest commit:	49f2dae
Status:	✅  Deploy successful!
Preview URL:	https://b31f2644.matrix-authentication-service-docs.pages.dev
Branch Preview URL:	https://af-rest-deactivate-erase-opt.matrix-authentication-service-docs.pages.dev

View logs

[AndrewFerr]

The failure is due to the schema updater marking the request body of /deactivate as required, but I want it to be optional. The unwanted change is:

diff --git a/docs/api/spec.json b/docs/api/spec.json
index cb597e14..c0e2ee51 100644
--- a/docs/api/spec.json
+++ b/docs/api/spec.json
@@ -1367,7 +1367,7 @@
               }
             }
           },
-          "required": false
+          "required": true
         },
         "responses": {
           "200": {

In deactivate.rs, I've already allowed the handler to accept an optional body (with a parameter of body: Option<Json<Request>>), so in practice the body really is optional (and a unit test confirms that).

Is there a way to make schema generation aware of the body being optional?

The reason I want it to be optional is to keep the endpoint backwards-compatible with its current form, which expects no body.

EDIT: this is now handled by 1101dd9.

[AndrewFerr]

I kept this in to check for the erase parameter on the job, as the response to GET /users doesn't indicate whether the user was erased or not.

[sandhose]

Not 100% convinced by the negation (skip_erase vs. erase) but I guess it makes it backwards-compatible