Skip to content

Commit fb930ac

Browse files
author
MapServer deploybot
committed
update with results of commit MapServer/MapServer-documentation@9b6914e 
1 parent 05d69f6 commit fb930ac

File tree

512 files changed

+640
-572
lines changed

Some content is hidden

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

512 files changed

+640
-572
lines changed

‎MIGRATION_GUIDE.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1432,7 +1432,7 @@ <h3>Navigation</h3>
14321432
</div>
14331433
<div class="footer" role="contentinfo">
14341434
&#169; <a href="copyright.html">Copyright</a> 2025, Open Source Geospatial Foundation.
1435-
Last updated on 2025-01-21.
1435+
Last updated on 2025-01-23.
14361436
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
14371437
</div>
14381438
</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-01-21.
162+
Last updated on 2025-01-23.
163163
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.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-01-21.
5579+
Last updated on 2025-01-23.
55805580
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
55815581
</div>
55825582
</body>

‎_sources/development/rfc/ms-rfc-140.txt‎

Lines changed: 64 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ MS RFC 140: MapServer Homepage
66

77
:Author: Seth Girvin
88
:Contact: [email protected]
9-
:Last Updated: 2025-01-18
9+
:Last Updated: 2025-01-23
1010
:Version: MapServer 8.6
1111
:Status: Draft
1212

@@ -21,6 +21,12 @@ would offer greater convenience and maintainability.
2121
With the introduction of the :ref:`CONFIG file <config>` in MapServer 8.0, it is now possible to centrally manage information about all Mapfiles in a deployment.
2222
This would ensure that the homepage remains automatically synchronised with both the CONFIG file and the capabilities of the Mapfiles it references.
2323

24+
The homepage would be a "superset" of all available Mapfiles in a MapServer deployment, as listed in the CONFIG file.
25+
Each individual Mapfile would still have its own OGC API landing page, so the homepage is best described as a directory of all landing pages.
26+
27+
As most MapServer deployments will likely be serving out a combination of WxS and new OGC API services for some time to come,
28+
it will allow both types to be listed together.
29+
2430
2.1 Proposed Solution
2531
=====================
2632

@@ -59,42 +65,73 @@ Requests will look as follows:
5965
As the service returns JSON any client-side library can be used to render the output. However a default HTML template will be provided
6066
following the same approach as in OGC Features API.
6167

68+
.. note::
69+
70+
Even though the JSON format is based on the OGC API, the homepage JSON service will still be generated for a Mapfile even if it only supports
71+
older WxS services.
72+
6273
JSON Structure
6374
--------------
6475

6576
JSON will be generated using the nlohmann/json and Inja approach already implemented in :ref:`MS RFC 134: OGC API Support <rfc134>`.
66-
A proposed JSON structure is shown below. Final details may vary. URLs will be constructed based on settings in each individual Mapfile.
77+
78+
The returned JSON will conform to the the `api-catalog <https://datatracker.ietf.org/doc/draft-ietf-httpapi-api-catalog/08/>`__,
79+
a draft IETF (Internet Engineering Task Force) standard. An example implementation is the `pygeoapi homepage <https://demo.pygeoapi.io/>`__
80+
(see the associated `pull request <https://github.com/geopython/demo.pygeoapi.io/pull/60/files>`__). The JSON structure is available at
81+
https://demo.pygeoapi.io/api-catalog.json. An extract is shown below:
6782

6883
.. code-block:: json
6984

7085
{
71-
"id": "TEST_MAPFILE1", // the key in the config file
72-
"name": "My_Mapfile", // the NAME in the Mapfile
73-
"title": "My Mapfile Title", // the TITLE in the Mapfile
74-
"links": [
75-
{
76-
"href": "https://demo.mapserver.org/cgi-bin/wms?SERVICE=WMS&VERSION=1.3.0&REQUEST=GetCapabilities",
77-
"title": "GetCapabilities",
78-
"type": "WMS"
79-
},
86+
"linkset": [
8087
{
81-
"href": "https://demo.mapserver.org/cgi-bin/wfs?SERVICE=WFS&VERSION=1.0.0&REQUEST=GetCapabilities",
82-
"title": "GetCapabilities",
83-
"type": "WFS"
84-
},
85-
{
86-
"href": "https://demo.mapserver.org/cgi-bin/wcs?SERVICE=WCS&VERSION=1.0.0&REQUEST=GetCapabilities",
87-
"title": "GetCapabilities",
88-
"type": "WCS"
89-
},
90-
{
91-
"href": "https://demo.mapserver.org/cgi-bin/mapserv/localdemo/ogcapi/api?f=html",
92-
"title": "Landing Page",
93-
"type": "OGCAPI"
94-
},
95-
]
96-
}
88+
"anchor": "https://demo.pygeoapi.io/master",
89+
"service-desc": [
90+
{
91+
"href": "https://demo.pygeoapi.io/master/openapi?f=json",
92+
"title": "pygeoapi - latest GitHub 'master' version (JSON)",
93+
"type": "application/vnd.oai.openapi+json"
94+
}
95+
],
96+
"service-doc": [
97+
{
98+
"href": "https://demo.pygeoapi.io/master/openapi?f=html",
99+
"title": "pygeoapi - latest GitHub 'master' version (HTML)",
100+
"type": "text/html"
101+
}
102+
]
103+
},
104+
105+
The api-catalog specification allows for an additional ``service-meta`` property *"used to link to additional metadata about the API,
106+
and is primarily intended for machine consumption."* This can be used to add any additional properties from Mapfiles
107+
required to generate a MapServer homepage. ``service-doc`` isn't mandatory property, so WxS service links can ignore this.
108+
109+
An example of the proposed JSON and metadata is shown below:
110+
111+
.. code-block:: json
97112

113+
{
114+
"linkset": [
115+
{
116+
"anchor": "https://demo.mapserver.org/",
117+
"service-desc": [
118+
{
119+
"href": "https://demo.mapserver.org/cgi-bin/msautotest?SERVICE=WMS&VERSION=1.3.0&REQUEST=GetCapabilities",
120+
"title": "World WMS service",
121+
"type": "text/xml"
122+
}
123+
],
124+
"service-meta": {
125+
{
126+
"service-type": "wms",
127+
"title": "WMS demo server for MapServer, used in the msautotest suite",
128+
"keywords": ["layers", "list"],
129+
"mapfile": "msautotest.map",
130+
}
131+
}
132+
},
133+
134+
``href`` values will be constructed based on settings in each individual Mapfile.
98135

99136
Future Development
100137
------------------

‎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-01-21.
247+
Last updated on 2025-01-23.
248248
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.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-01-21.
186+
Last updated on 2025-01-23.
187187
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.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-01-21.
198+
Last updated on 2025-01-23.
199199
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
200200
</div>
201201
</body>

‎announcements/announcements_archive.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -657,7 +657,7 @@ <h3>Navigation</h3>
657657
</div>
658658
<div class="footer" role="contentinfo">
659659
&#169; <a href="../copyright.html">Copyright</a> 2025, Open Source Geospatial Foundation.
660-
Last updated on 2025-01-21.
660+
Last updated on 2025-01-23.
661661
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
662662
</div>
663663
</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-01-21.
171+
Last updated on 2025-01-23.
172172
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
173173
</div>
174174
</body>

‎basemaps/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ <h3>Navigation</h3>
221221
</div>
222222
<div class="footer" role="contentinfo">
223223
&#169; <a href="../copyright.html">Copyright</a> 2025, Open Source Geospatial Foundation.
224-
Last updated on 2025-01-21.
224+
Last updated on 2025-01-23.
225225
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
226226
</div>
227227
</body>

0 commit comments

Comments
 (0)