This is an automated email from the ASF dual-hosted git repository.
bcall pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/trafficserver.git
The following commit(s) were added to refs/heads/master by this push:
new 7a3486a0d3 Docs: Clarify URL Parts (#12288)
7a3486a0d3 is described below
commit 7a3486a0d3b8057ef085efb7b07218df841d8743
Author: mlibbey <[email protected]>
AuthorDate: Mon Jun 16 15:42:35 2025 -0700
Docs: Clarify URL Parts (#12288)
- Adds a ASCII table for URL parts
- Order the table by presence in url from left to right
- Add example value for each
---
doc/admin-guide/plugins/header_rewrite.en.rst | 29 ++++++++++++++++++---------
1 file changed, 20 insertions(+), 9 deletions(-)
diff --git a/doc/admin-guide/plugins/header_rewrite.en.rst
b/doc/admin-guide/plugins/header_rewrite.en.rst
index cc8c6d62a0..5b2d232500 100644
--- a/doc/admin-guide/plugins/header_rewrite.en.rst
+++ b/doc/admin-guide/plugins/header_rewrite.en.rst
@@ -1190,25 +1190,36 @@ parameters by writing it as::
The URL part names which may be used for these conditions and actions are:
+.. code-block::
+
+
┌─────────────────────────────────────────────────────────────────────────────────────────┐
+ │ URL
│
+
├─────────────────────────────────────────────────────────────────────────────────────────┤
+ │
https://docs.trafficserver.apache.org:443/en/latest/search.html?q=header_rewrite&;...
│
+ │ ┬──── ┬──────────────────────────── ┬── ─┬───────────────────
┬─────────────────── │
+ │ │ │ │ │ │
│
+ │ SCHEME HOST PORT PATH QUERY
│
+
└─────────────────────────────────────────────────────────────────────────────────────────┘
+
======== ======================================================================
-Part Description
+Part Description and value for
``https://docs.trafficserver.apache.org/en/latest/search.html?q=header_rewrite``
======== ======================================================================
-HOST Full hostname.
+SCHEME URL scheme in use (e.g. ``http`` and ``https``). ``Value`` = `https`
+
+HOST Full hostname. ``Value`` = `docs.trafficserver.apache.org`
+
+PORT Port number. (Regardless if directly specified in the URL). ``Value``
= `443`
PATH URL substring beginning with (but not including) the first ``/`` after
the hostname up to, but not including, the query string. **Note**:
previous
versions of ATS had a `%{PATH}` directive, this will no longer work.
Instead,
- you want to use `%{CLIENT-URL:PATH}`.
-
-PORT Port number.
+ you want to use `%{CLIENT-URL:PATH}`. ``Value`` =
`en/latest/search.html`
QUERY URL substring from the ``?``, signifying the beginning of the query
parameters, until the end of the URL. Empty string if there were no
- query parameters.
-
-SCHEME URL scheme in use (e.g. ``http`` and ``https``).
+ query parameters. ``Value`` = ` `
-URL The complete URL.
+URL The complete URL. ``Value`` =
`https://docs.trafficserver.apache.org/en/latest/search.html?q=header_rewrite`
======== ======================================================================
As another example, a remap rule might use the `set-destination`_ operator to
