PHphilterd
Always/Never Redact Lists

Append to the always-redact and never-redact lists.

Changed on

Appends the supplied terms to the existing lists rather than replacing them - use POST to replace. Each field's terms are added to the current contents of that list; a list that is omitted or sent as an empty array is left unchanged. Terms are trimmed, blank entries are dropped, and terms already present are not added again. The resulting list may contain up to 1000 terms, and each term may be up to 100 characters; an append that would exceed the limit is rejected. Each list appended to moves to its next revision. Admins may append to another user's lists by passing that user's username as owner. Requires the lists:write scope.

put/api/redact-lists

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/redact-lists
  • Auth
    HTTP bearer

Query parameters

ownerstring

Headers

Authorizationstring required

Request body

alwaysRedactstring[]
neverRedactstring[]

Response

The terms were appended.

fieldstring

For a request refused as invalid, the parameter or body field that was invalid, when one is.

messagestring

What happened, written for a person to read. It may change; use reason in code.

reasonstring

For an error, why the request was refused, as a stable code a client can act on. The codes are listed in the API documentation under Errors.

Changes

  • fddc8a37e181Revision changes
    • breaking

      removed the media type */* for the response with the status

    • info

      added the media type application/json for the response with the status

  • c4f85daa9208Revision changes
    • breaking

      removed the media type */* for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status