backup/warcprox
1
0
Fork 0
mirror of https://github.com/internetarchive/warcprox.git synced 2025-01-18 13:22:09 +01:00
Code Issues Projects Releases Activity

WT-2955 documentation for MIME type filtering

Browse Source
This commit is contained in:
Gretchen Miller 2024-09-23 15:21:04 -07:00
parent ff38f69440
commit cdb17f4790
1 changed files with 15 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
api.rst
View File

@ -186,6 +186,21 @@ to evaluate the block rules. In particular, this circumstance prevails when the
browser controlled by brozzler is requesting images, javascript, css, and so
on, embedded in a page.
``mime-type-filters`` (list)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
``mime-type-filters`` is a list of dictionaries, each of which has two required
fields, ``regex`` and ``type``. Each entry in the ``mime-type-filters`` list
defines behavior to filter WARC-writing by the MIME type specified in the HTTP
response's Content-Type header.
There are two expected keys in a MIME type filter block:
* ``regex``: A regex expression to be applied to the Content-Type header value.
* ``type``: The type of filtering logic to apply. Two values are supported.
* ``REJECT``: Any Content-Type header value matching the regex will be
rejected.
* ``LIMIT``: Only Content-Type values matching the regex will be allowed.
``stats`` (dictionary)
~~~~~~~~~~~~~~~~~~~~~~
``stats`` is a dictionary with only one field understood by warcprox,
@ -307,4 +322,3 @@ that it sends to the client. As with the request header, the value is a json
blob. It is only included if something in the ``warcprox-meta`` request header
calls for it. Those cases are described above in the `Warcprox-Meta http
request header`_ section.