Skip to content

Deleting a category

Théandre Bourry edited this page Jun 24, 2023 · 1 revision

To delete a category from the wiki, you should make a call to the route

DELETE - api/deletecategory/{categoryName}

This will try to delete a file named {categoryName}.category from the server. Don't worry though, because it will not delete the pages referenced into the category.

Route infos

Authorizations

This rotue requires the user to send a key to the API. This key is 256 characters long and generated completely randomly. It is changed avery six months to ensure it isn't cracked.

Parameters

Mandatory

Parameter Data type Description Example
{categoryName} string The name of the category to delete. If it contains spaces, they should be replaced with underscores beforehand. Category_Name1

Optional

There are no optional parameters to give for this route.

Request body

This is what the request body will look like:

{
    "validationString": "<authentication key>"
}
  • validationString: This will be compared with the key stored locally on the server (after encryption) to see if the user is allowed to send modifications.

Response

When successful, this route returns a 204 HTTP code. If the authentication fails, it will return a 401 (Unauthorized) code. In any case, it won't return any body.