view website/www/docs.txt @ 8185:e84d4585b16d

fix(web): issue2551356. Add etag header for not-modified (304) request. When a 304 is returned to a conditional request for a static file, print an ETag for the response. ETag was always sent with a 200 response. This also adds initial support for if-none-match conditional requests for static files. Changes: Refactors the if-modified-since code out to a method. It moves a file stat call from serve_static_file to _serve_file so that an etag can be generated by both serve_static_file and serve_file which call _serve_file. Tests added. This does not test the codepath where serve_file pulls content from the database rather than from a local file on disk. Test mocking _serve_file changed to account for 5th argument to serve_file BREAKING CHANGE: function signature for client.py-Client::_serve_file() now has 5 not 4 parameters (added etag param). Since this is a "hidden" method I am not too worried about it.
author John Rouillard <rouilj@ieee.org>
date Tue, 10 Dec 2024 16:06:13 -0500
parents e3b34d02c61a
children 78b13272d41b
line wrap: on
line source

.. meta::
    :description:
        Table of contents for published documentation on the Roundup
        Issue Tracker.

Docs
====

.. admonition:: Welcome

   The documentation is slowly being reorganized using the `Diataxis
   framework`_. Help with the reorganization is welcome. If a page you
   used to see is missing, try checking the `Other Docs
   <olderdocs.html>`_ page.

See: https://wiki.roundup-tracker.org/ReleaseErrata for fixes to
documentation.

.. _diataxis framework: https://diataxis.fr/

.. toctree::
   :maxdepth: 2

   Features <docs/features>
   Installation <docs/installation>
   Upgrading to Newer Versions <docs/upgrading>
   Security Issues <docs/security>
   FAQ <docs/FAQ>
   User's Guide <docs/user_guide>
   Customising <docs/customizing>
   Rest API <docs/rest>
   XML-RPC API <docs/xmlrpc>
   Reference <docs/reference>
   Glossary <docs/glossary>
   docs/admin_guide
   docs/man_pages
   docs/license
   docs/acknowledgements
   olderdocs

Roundup Issue Tracker: http://roundup-tracker.org/