Skip to content

Commit 7c98da2

Browse files
authored
Merge pull request #1064 from rouault/ogcapi_part3_and_5_doc
Document new layer metadata items for OGC API Features Part 3 and 5
2 parents fc9b80f + 2b0fd6e commit 7c98da2

2 files changed

Lines changed: 84 additions & 1 deletion

File tree

en/ogc/ogc_api.txt

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -200,6 +200,9 @@ for an OGC API server:**
200200
- ows_title
201201
- gml_include_items
202202
- gml_featureid
203+
- oga_queryable_items
204+
- oga_sortable_items
205+
- oga_geometry_format
203206

204207
- LAYER TEMPLATE "VOID"
205208

@@ -304,6 +307,9 @@ Example OGC API Server Mapfile
304307
"gml_include_items" "all" #REQUIRED
305308
"gml_featureid" "ne_id" #REQUIRED
306309
"oga_use_default_extent_for_getfeature" # Optional. Can improve performance.
310+
"oga_queryable_items" "all" # required to allow filtering
311+
"oga_geometry_format" "geometry-polygn"
312+
"oga_sortable_items" "area"
307313
END
308314
TYPE POLYGON
309315
STATUS ON
@@ -532,3 +538,75 @@ Web Object Metadata
532538
the family of OGC API JSON Schema files are located. This must be a valid URL
533539
where the actual .yaml files are located if you want your OpenAPI description
534540
to be valid. Default is *http://schemas.opengis.net*
541+
542+
.. index::
543+
triple: OGCAPI; METADATA; oga_queryable_items
544+
545+
**oga_queryable_items**
546+
547+
.. versionadded:: 8.8.0
548+
549+
- *Description:* (Optional) Comma separated list of items that can be used for
550+
filtering at the /items endpoint (either as <item>=<value> query parameters
551+
and/or through the filter=<cql2-text>|<cql2-json> query parameter).
552+
"all" can also be used as a special value to indicate that all items can be
553+
queried. If not specified, no items are queryable.
554+
The list of queryable items is returned at the /collections/{collid}/queryables
555+
URL.
556+
557+
- Example Mapfile:
558+
559+
.. code-block:: mapfile
560+
561+
LAYER
562+
METADATA
563+
"oga_queryable_items" "name,count"
564+
END
565+
END
566+
567+
.. index::
568+
triple: OGCAPI; METADATA; oga_sortable_items
569+
570+
**oga_sortable_items**
571+
572+
.. versionadded:: 8.8.0
573+
574+
- *Description:* (Optional) Comma separated list of items that can be used for
575+
sorting at the /items endpoint (through the sortby=[+-]?item query parameter).
576+
"all" can also be used as a special value to indicate that all items can be
577+
used as sorting key. If not specified, no items can be used as sorting keys.
578+
The list of queryable items is returned at the /collections/{collid}/sortables
579+
URL.
580+
581+
- Example Mapfile:
582+
583+
.. code-block:: mapfile
584+
585+
LAYER
586+
METADATA
587+
"oga_sortable_items" "name,count"
588+
END
589+
END
590+
591+
.. index::
592+
triple: OGCAPI; METADATA; oga_geometry_format
593+
594+
**oga_geometry_format**
595+
596+
.. versionadded:: 8.8.0
597+
598+
- *Description:* (Optional) Value among "geometry-point", "geometry-multipoint",
599+
"geometry-linestring", "geometry-multilinestring", "geometry-polygon",
600+
"geometry-multipolygon", "geometry-geometrycollection", "geometry-any" (default value),
601+
"geometry-point-or-multipoint", "geometry-linestring-or-multilinestring"
602+
and "geometry-polygon-or-multipolygon"
603+
604+
- Example Mapfile:
605+
606+
.. code-block:: mapfile
607+
608+
LAYER
609+
METADATA
610+
"oga_geometry_format" "geometry-polygon-or-multipolygon"
611+
END
612+
END

en/ogc/ogc_support.txt

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,9 @@ MapServer OGC Specification support
1919
* Observations and Measurements (OGC:OM) 1.0.0
2020
* SWE Common (OGC:SWE) 1.0.1
2121
* OWS Common (OGC:OWS) 1.0.0, 1.1.0, 2.0.0
22-
* OGC API: Features (OGCAPI:Features) 1.0.0
22+
* OGC API: Features (OGCAPI:Features) 1.0.0, server part
23+
- Part 1: Core
24+
- Part 2: CRS by Reference
25+
- Part 3: Filtering (CQL2 Text and JSON)
26+
- Part 5: Schemas (draft)
27+
- Part 8: Sortables (draft)

0 commit comments

Comments
 (0)