Skip to content

Commit 6e0b4ac

Browse files
committed
update for 8.6.0-beta2
1 parent d48e144 commit 6e0b4ac

File tree

2 files changed

+37
-7
lines changed

2 files changed

+37
-7
lines changed

en/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

en/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,

0 commit comments

Comments
 (0)