PHphilterd
Always/Never Redact Lists

Replace the always-redact and never-redact lists.

Changed on

Replaces both lists in full with the supplied contents - this is not a merge. Each field is the complete desired contents of that list; a list that is omitted or sent as an empty array is cleared. Terms are trimmed and blank entries are dropped. Each list may contain up to 1000 terms, and each term may be up to 100 characters. Both lists move to their next revision. Takes no If-Match; to replace one list on the condition that it has not changed, use PUT /api/redact-lists/{list}. Admins may replace another user's lists by passing that user's username as owner. Requires the lists:write scope.

post/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 lists were replaced.

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