Skip to content

Commit 5cebca0

Browse files
author
MapServer deploybot
committed
update with results of commit MapServer/MapServer-documentation@d87f7f9
1 parent 4fff0b4 commit 5cebca0

File tree

518 files changed

+605
-534
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

518 files changed

+605
-534
lines changed

MIGRATION_GUIDE.html

Lines changed: 35 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ <h3>Navigation</h3>
126126
<span id="migration"></span><h1><a class="toc-backref" href="#table-of-contents" role="doc-backlink">MapServer Migration Guide</a><a class="headerlink" href="#mapserver-migration-guide" title="Link to this heading"></a></h1>
127127
<dl class="field-list simple">
128128
<dt class="field-odd">Last Updated<span class="colon">:</span></dt>
129-
<dd class="field-odd"><p>2025-11-18</p>
129+
<dd class="field-odd"><p>2025-11-19</p>
130130
</dd>
131131
</dl>
132132
<nav class="contents" id="table-of-contents">
@@ -240,11 +240,41 @@ <h3>Navigation</h3>
240240
<p>original Pull Request <a class="reference external" href="https://github.com/MapServer/MapServer/pull/7309/">#7309</a></p>
241241
</div>
242242
</li>
243-
<li><p><a class="reference internal" href="ogc/ogc_api.html#ogcapi"><span class="std std-ref">OGC API : Features</span></a> has been enhanced to allow <cite>vendorSpecificParameters</cite> passed through to the OpenAPI
244-
document on the <cite>/items</cite> definitions.</p>
243+
<li><p><a class="reference internal" href="ogc/ogc_api.html#ogcapi"><span class="std std-ref">OGC API : Features</span></a> has been enhanced to allow the appending of additional
244+
query parameters to all URLs generated through the API, by
245+
defining the <cite>ows_extra_params</cite> parameter in the MAP’s METADATA object.</p>
246+
<blockquote>
247+
<div><div class="highlight-mapfile notranslate"><div class="highlight"><pre><span></span><span class="k">MAP</span>
248+
<span class="p">...</span>
249+
<span class="k">WEB</span>
250+
<span class="k">METADATA</span>
251+
<span class="s">&quot;ows_title&quot;</span> <span class="s">&quot;My OGCAPI Server&quot;</span>
252+
<span class="p">...</span>
253+
<span class="s">&quot;oga_html_template_directory&quot;</span> <span class="s">&quot;../../share/ogcapi/templates/html-bootstrap/&quot;</span>
254+
<span class="s">&quot;ows_extra_params&quot;</span> <span class="s">&quot;token=123&quot;</span>
255+
<span class="k">END</span> <span class="c">#metadata</span>
256+
<span class="k">END</span> <span class="c">#web</span>
257+
<span class="p">...</span>
258+
<span class="k">LAYER</span>
259+
<span class="p">...</span>
260+
<span class="k">END</span> <span class="c">#layer</span>
261+
<span class="k">END</span> <span class="c">#map</span>
262+
</pre></div>
263+
</div>
264+
</div></blockquote>
265+
<p>All subsequent URLs available through OGCAPI: Features will contain that
266+
<cite>token=123</cite>, such as:</p>
267+
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>http://127.0.0.1/cgi-bin/mapserv.exe/local-demo/ogcapi/collections/ocean/items?f=json&amp;token=123
268+
</pre></div>
269+
</div>
270+
<div class="admonition tip">
271+
<p class="admonition-title">Tip</p>
272+
<p>For sensitive parameter values, you should enable <a class="reference internal" href="cgi/runsub.html#runsub"><span class="std std-ref">Run-time Substitution</span></a> to
273+
not store passwords and other tokens in mapfiles. See steps at <a class="reference internal" href="ogc/ogc_api.html#ogcapi-metadata"><span class="std std-ref">OGCAPI: Features metadata</span></a>.</p>
274+
</div>
245275
<div class="admonition seealso">
246276
<p class="admonition-title">See also</p>
247-
<p>original Pull Request <a class="reference external" href="https://github.com/MapServer/MapServer/pull/7295/">#7295</a></p>
277+
<p>original Pull Request <a class="reference external" href="https://github.com/MapServer/MapServer/pull/7360/">#7360</a></p>
248278
</div>
249279
</li>
250280
</ul>
@@ -1534,7 +1564,7 @@ <h3>Navigation</h3>
15341564
</div>
15351565
<div class="footer" role="contentinfo">
15361566
&#169; <a href="copyright.html">Copyright</a> 2025, Open Source Geospatial Foundation.
1537-
Last updated on 2025-11-18.
1567+
Last updated on 2025-11-19.
15381568
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
15391569
</div>
15401570
</body>

_modules/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ <h3>Navigation</h3>
159159
</div>
160160
<div class="footer" role="contentinfo">
161161
&#169; <a href="../copyright.html">Copyright</a> 2025, Open Source Geospatial Foundation.
162-
Last updated on 2025-11-18.
162+
Last updated on 2025-11-19.
163163
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
164164
</div>
165165
</body>

_modules/mapscript/mapscript.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5576,7 +5576,7 @@ <h3>Navigation</h3>
55765576
</div>
55775577
<div class="footer" role="contentinfo">
55785578
&#169; <a href="../../copyright.html">Copyright</a> 2025, Open Source Geospatial Foundation.
5579-
Last updated on 2025-11-18.
5579+
Last updated on 2025-11-19.
55805580
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
55815581
</div>
55825582
</body>

_sources/MIGRATION_GUIDE.txt

Lines changed: 32 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
MapServer Migration Guide
77
*****************************************************************************
88

9-
:Last Updated: 2025-11-18
9+
:Last Updated: 2025-11-19
1010

1111
.. contents:: Table of Contents
1212
:depth: 2
@@ -101,10 +101,38 @@ MapServer 8.4 to 8.6 Migration
101101

102102
.. seealso:: original Pull Request `#7309 <https://github.com/MapServer/MapServer/pull/7309/>`__
103103

104-
- :ref:`ogcapi` has been enhanced to allow `vendorSpecificParameters` passed through to the OpenAPI
105-
document on the `/items` definitions.
104+
- :ref:`ogcapi` has been enhanced to allow the appending of additional
105+
query parameters to all URLs generated through the API, by
106+
defining the `ows_extra_params` parameter in the MAP's METADATA object.
107+
108+
.. code-block:: mapfile
109+
110+
MAP
111+
...
112+
WEB
113+
METADATA
114+
"ows_title" "My OGCAPI Server"
115+
...
116+
"oga_html_template_directory" "../../share/ogcapi/templates/html-bootstrap/"
117+
"ows_extra_params" "token=123"
118+
END #metadata
119+
END #web
120+
...
121+
LAYER
122+
...
123+
END #layer
124+
END #map
125+
126+
All subsequent URLs available through OGCAPI: Features will contain that
127+
`token=123`, such as::
128+
129+
http://127.0.0.1/cgi-bin/mapserv.exe/local-demo/ogcapi/collections/ocean/items?f=json&token=123
130+
131+
.. TIP::
132+
For sensitive parameter values, you should enable :ref:`Run-time Substitution <runsub>` to
133+
not store passwords and other tokens in mapfiles. See steps at :ref:`OGCAPI: Features metadata <ogcapi_metadata>`.
106134

107-
.. seealso:: original Pull Request `#7295 <https://github.com/MapServer/MapServer/pull/7295/>`__
135+
.. seealso:: original Pull Request `#7360 <https://github.com/MapServer/MapServer/pull/7360/>`__
108136

109137
.. _migration-8-4:
110138

_sources/ogc/ogc_api.txt

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
:Author: Jeff McKenna
1111
:Contact: jmckenna at gatewaygeomatics.com
12-
:Last Updated: 2025-10-10
12+
:Last Updated: 2025-11-19
1313

1414
.. contents:: Table of Contents
1515
:depth: 3
@@ -435,6 +435,8 @@ Further Configuration
435435

436436
The following metadata may be used for additional configuration of the service:
437437

438+
.. _ogcapi_metadata:
439+
438440
Web Object Metadata
439441
-------------------
440442

@@ -452,11 +454,11 @@ Web Object Metadata
452454
to be valid. Default is *http://schemas.opengis.net*
453455

454456
.. index::
455-
triple: OGCAPI; METADATA; ows_schemas_location
457+
triple: OGCAPI; METADATA; ows_extra_params
456458

457459
**ows_extra_params**
458460

459-
.. versionadded:: 8.4.0
461+
.. versionadded:: 8.6.0
460462

461463
- *Description:* (Optional) The ``ows_extra_params`` (or ``oga_extra_params``) metadata entry allows you to append
462464
additional query parameters to all URLs generated by MapServer. This can be used, for example,

about.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -244,7 +244,7 @@ <h3>Navigation</h3>
244244
</div>
245245
<div class="footer" role="contentinfo">
246246
&#169; <a href="copyright.html">Copyright</a> 2025, Open Source Geospatial Foundation.
247-
Last updated on 2025-11-18.
247+
Last updated on 2025-11-19.
248248
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
249249
</div>
250250
</body>

announcements/2021-03-30-limit-mapfile-access.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ <h3>Navigation</h3>
183183
</div>
184184
<div class="footer" role="contentinfo">
185185
&#169; <a href="../copyright.html">Copyright</a> 2025, Open Source Geospatial Foundation.
186-
Last updated on 2025-11-18.
186+
Last updated on 2025-11-19.
187187
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
188188
</div>
189189
</body>

announcements/2021-06-11-community-condolences.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ <h3>Navigation</h3>
195195
</div>
196196
<div class="footer" role="contentinfo">
197197
&#169; <a href="../copyright.html">Copyright</a> 2025, Open Source Geospatial Foundation.
198-
Last updated on 2025-11-18.
198+
Last updated on 2025-11-19.
199199
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
200200
</div>
201201
</body>

announcements/announcements_archive.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -677,7 +677,7 @@ <h3>Navigation</h3>
677677
</div>
678678
<div class="footer" role="contentinfo">
679679
&#169; <a href="../copyright.html">Copyright</a> 2025, Open Source Geospatial Foundation.
680-
Last updated on 2025-11-18.
680+
Last updated on 2025-11-19.
681681
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
682682
</div>
683683
</body>

announcements/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ <h3>Navigation</h3>
168168
</div>
169169
<div class="footer" role="contentinfo">
170170
&#169; <a href="../copyright.html">Copyright</a> 2025, Open Source Geospatial Foundation.
171-
Last updated on 2025-11-18.
171+
Last updated on 2025-11-19.
172172
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
173173
</div>
174174
</body>

0 commit comments

Comments
 (0)