From db94f516c4f686c72937aa127696bfa4ac30706e Mon Sep 17 00:00:00 2001 From: Jerome St-Louis Date: Tue, 5 Nov 2024 20:04:08 -0500 Subject: [PATCH] Collections: Common OGC API - Records compliance section - Collections can comply to records whether Searchable, Sortable or Filterable is supported or not - Moved 5 shared Records conformance classes information to Collections - Searchable, Sortable and Filterable Records compliance section now link to Collections, and mention only their 2 additional related Records conformance classes --- .../clause_10_searchable_collections.adoc | 14 +++---------- .../clause_11_sortable_collections.adoc | 15 +++---------- .../clause_12_filterable_collections.adoc | 13 ++---------- collections/clause_8_collections.adoc | 21 +++++++++++++++++++ 4 files changed, 29 insertions(+), 34 deletions(-) diff --git a/collections/clause_10_searchable_collections.adoc b/collections/clause_10_searchable_collections.adoc index c1eede0..e91c60b 100644 --- a/collections/clause_10_searchable_collections.adoc +++ b/collections/clause_10_searchable_collections.adoc @@ -22,26 +22,18 @@ If implementing https://docs.ogc.org/is/19-072/19-072.html[OGC API - Common - Pa [[searchable-api-records]] === OGC API - Records compliance -When implementing this "Searchable Collections" requirement class, the `/collections` end-point is considered a _Local Resource Catalog_, where the local resources are the collections being cataloged. - -This requirement class is consistent with the requirements of https://docs.ogc.org/DRAFTS/20-004.html#clause-local-resources-catalog_query-parameters[OGC API - Records - Part 1: Core "Local Resources Catalog - Query Parameters" (Deployment)]. +This "Searchable Collections" requirement class is consistent with the requirements of https://docs.ogc.org/DRAFTS/20-004.html#clause-local-resources-catalog_query-parameters[OGC API - Records - Part 1: Core "Local Resources Catalog - Query Parameters" (Deployment)]. An implementation may gain additional interoperability by conforming to that requirement class from OGC API - Records as well. -In this case, the implementation should verify and declare conformance with these seven conformance classes defined in Records corresponding to the following URIs: +In this case, in addition to the five OGC API - Records requirement classes mentioned in the <>, the implementation should verify and declare conformance with these additional two conformance classes defined in Records corresponding to the following URIs: [cols="2,7",options="header"] |=== | OGC API - Records Requirements Class | URI -| https://docs.ogc.org/DRAFTS/20-004.html#clause-record-core[Record Core] | http://www.opengis.net/spec/ogcapi-records-1/1.0/conf/record-core -| https://docs.ogc.org/DRAFTS/20-004.html#clause-record-collection[Record Collection] | http://www.opengis.net/spec/ogcapi-records-1/1.0/conf/record-collection -| https://docs.ogc.org/DRAFTS/20-004.html#clause-crawlable-catalog[Crawlable Catalog] | http://www.opengis.net/spec/ogcapi-records-1/1.0/conf/crawlable-catalog -| https://docs.ogc.org/DRAFTS/20-004.html#clause-local-resources-catalog[Local Resources Catalog] | http://www.opengis.net/spec/ogcapi-records-1/1.0/conf/local-resources-catalog -| https://docs.ogc.org/DRAFTS/20-004.html#clause-autodiscovery[Autodiscovery] | http://www.opengis.net/spec/ogcapi-records-1/1.0/conf/autodiscovery | https://docs.ogc.org/DRAFTS/20-004.html#clause-record-core-query-parameters[Query Parameters] | http://www.opengis.net/spec/ogcapi-records-1/1.0/conf/record-query-parameters | https://docs.ogc.org/DRAFTS/20-004.html#clause-local-resources-catalog_query-parameters[Local Resources Catalog - Query Parameters] | http://www.opengis.net/spec/ogcapi-records-1/1.0/conf/local-resources-catalog-query-parameters |=== -The additional requirements include linking to the `/collections` end-point with an `http://www.opengis.net/def/rel/ogc/1.0/ogc-catalog` link relation from the landing page, as well as support for the additional -parameters `type`, `ids` and `externalIds`. +The additional requirements include also supporting the query parameters `type`, `ids` and `externalIds`. [[searchable-bbox-parameter]] === Parameter `bbox` diff --git a/collections/clause_11_sortable_collections.adoc b/collections/clause_11_sortable_collections.adoc index 0aa0425..3c80a81 100644 --- a/collections/clause_11_sortable_collections.adoc +++ b/collections/clause_11_sortable_collections.adoc @@ -17,26 +17,17 @@ If implementing https://docs.ogc.org/is/19-072/19-072.html[OGC API - Common - Pa [[sorting-api-records]] === OGC API - Records compliance -When implementing this "Sortable Collections" requirement class, the `/collections` end-point can be considered a _Local Resource Catalog_, where the local resources are the collections being cataloged. - -This requirement class is consistent with the requirements of https://docs.ogc.org/DRAFTS/20-004.html#clause-local-resources-catalog_filtering[OGC API - Records - Part 1: Core "Local Resources Catalog - Filtering" (Deployment)]. +This "Sortable Collections" requirement class is consistent with the requirements of https://docs.ogc.org/DRAFTS/20-004.html#clause-local-resources-catalog_filtering[OGC API - Records - Part 1: Core "Local Resources Catalog - Filtering" (Deployment)]. An implementation may gain additional interoperability by conforming to that requirement class from OGC API - Records as well. -In this case, the implementation should verify and declare conformance with these seven conformance classes defined in Records corresponding to the following URIs: +In this case, in addition to the five OGC API - Records requirement classes mentioned in the <>, the implementation should verify and declare conformance with these additional two conformance classes defined in Records corresponding to the following URIs: [cols="2,7",options="header"] |=== | OGC API - Records Requirements Class | URI -| https://docs.ogc.org/DRAFTS/20-004.html#clause-record-core[Record Core] | http://www.opengis.net/spec/ogcapi-records-1/1.0/conf/record-core -| https://docs.ogc.org/DRAFTS/20-004.html#clause-record-collection[Record Collection] | http://www.opengis.net/spec/ogcapi-records-1/1.0/conf/record-collection -| https://docs.ogc.org/DRAFTS/20-004.html#clause-crawlable-catalog[Crawlable Catalog] | http://www.opengis.net/spec/ogcapi-records-1/1.0/conf/crawlable-catalog -| https://docs.ogc.org/DRAFTS/20-004.html#clause-local-resources-catalog[Local Resources Catalog] | http://www.opengis.net/spec/ogcapi-records-1/1.0/conf/local-resources-catalog -| https://docs.ogc.org/DRAFTS/20-004.html#clause-autodiscovery[Autodiscovery] | http://www.opengis.net/spec/ogcapi-records-1/1.0/conf/autodiscovery -| https://docs.ogc.org/DRAFTS/20-004.html#clause-sorting | http://www.opengis.net/spec/ogcapi-records-1/1.0/req/sorting +| https://docs.ogc.org/DRAFTS/20-004.html#clause-sorting[Sorting] | http://www.opengis.net/spec/ogcapi-records-1/1.0/req/sorting | https://docs.ogc.org/DRAFTS/20-004.html#clause-local-resources-catalog_sorting[Local Resources Catalog - Sorting] | http://www.opengis.net/spec/ogcapi-records-1/1.0/req/local-resources-catalog/sorting |=== -The additional requirements include linking to the `/collections` end-point with an `http://www.opengis.net/def/rel/ogc/1.0/ogc-catalog` link relation from the landing page. - [[sorting-sortby-parameter]] === Parameter `sortby` diff --git a/collections/clause_12_filterable_collections.adoc b/collections/clause_12_filterable_collections.adoc index bf3ab3d..c3e4783 100644 --- a/collections/clause_12_filterable_collections.adoc +++ b/collections/clause_12_filterable_collections.adoc @@ -20,26 +20,17 @@ If implementing https://docs.ogc.org/is/19-072/19-072.html[OGC API - Common - Pa [[filtering-api-records]] === OGC API - Records compliance -When implementing this "Filtering Collections with CQL2" requirement class, the `/collections` end-point can be considered a _Local Resource Catalog_, where the local resources are the collections being cataloged. - -This requirement class is consistent with the requirements of https://docs.ogc.org/DRAFTS/20-004.html#clause-local-resources-catalog_filtering[OGC API - Records - Part 1: Core "Local Resources Catalog - Filtering" (Deployment)]. +This "Filtering Collections with CQL2" requirement class is consistent with the requirements of https://docs.ogc.org/DRAFTS/20-004.html#clause-local-resources-catalog_filtering[OGC API - Records - Part 1: Core "Local Resources Catalog - Filtering" (Deployment)]. An implementation may gain additional interoperability by conforming to that requirement class from OGC API - Records as well. -In this case, the implementation should verify and declare conformance with these seven conformance classes defined in Records corresponding to the following URIs: +In this case, in addition to the five OGC API - Records requirement classes mentioned in the <>, the implementation should verify and declare conformance with these additional two conformance classes defined in Records corresponding to the following URIs: [cols="2,7",options="header"] |=== | OGC API - Records Requirements Class | URI -| https://docs.ogc.org/DRAFTS/20-004.html#clause-record-core[Record Core] | http://www.opengis.net/spec/ogcapi-records-1/1.0/conf/record-core -| https://docs.ogc.org/DRAFTS/20-004.html#clause-record-collection[Record Collection] | http://www.opengis.net/spec/ogcapi-records-1/1.0/conf/record-collection -| https://docs.ogc.org/DRAFTS/20-004.html#clause-crawlable-catalog[Crawlable Catalog] | http://www.opengis.net/spec/ogcapi-records-1/1.0/conf/crawlable-catalog -| https://docs.ogc.org/DRAFTS/20-004.html#clause-local-resources-catalog[Local Resources Catalog] | http://www.opengis.net/spec/ogcapi-records-1/1.0/conf/local-resources-catalog -| https://docs.ogc.org/DRAFTS/20-004.html#clause-autodiscovery[Autodiscovery] | http://www.opengis.net/spec/ogcapi-records-1/1.0/conf/autodiscovery | https://docs.ogc.org/DRAFTS/20-004.html#clause-filtering[Filtering] | http://www.opengis.net/spec/ogcapi-records-1/1.0/req/filtering | https://docs.ogc.org/DRAFTS/20-004.html#clause-local-resources-catalog_filtering[Local Resources Catalog - Filtering] | http://www.opengis.net/spec/ogcapi-records-1/1.0/req/local-resources-catalog/filtering |=== -The additional requirements include linking to the `/collections` end-point with an `http://www.opengis.net/def/rel/ogc/1.0/ogc-catalog` link relation from the landing page. - [[filtering-filter-parameter]] === Parameter `filter` diff --git a/collections/clause_8_collections.adoc b/collections/clause_8_collections.adoc index d696fc3..9c322ed 100644 --- a/collections/clause_8_collections.adoc +++ b/collections/clause_8_collections.adoc @@ -126,3 +126,24 @@ include::recommendations/collections/PER_collections-description-extent-extensio See <> for general guidance. If the parameter `collectionId` does not exist on the server, the status code of the response will be `404` (see <>). + +[[collections-api-records]] +=== OGC API - Records compliance + +When implementing this "Collections" requirement class, the `/collections` end-point can be considered a _Local Resource Catalog_, where the local resources are the collections being cataloged. + +This requirement class is consistent with the requirements of https://docs.ogc.org/DRAFTS/20-004.html#clause-local-resources-catalog[OGC API - Records - Part 1: Core "Local Resources Catalog" (Deployment)]. +An implementation may gain additional interoperability by conforming to that requirement class from OGC API - Records as well. +In this case, the implementation should verify and declare conformance with these five conformance classes defined in Records corresponding to the following URIs: + +[cols="2,7",options="header"] +|=== +| OGC API - Records Requirements Class | URI +| https://docs.ogc.org/DRAFTS/20-004.html#clause-record-core[Record Core] | http://www.opengis.net/spec/ogcapi-records-1/1.0/conf/record-core +| https://docs.ogc.org/DRAFTS/20-004.html#clause-record-collection[Record Collection] | http://www.opengis.net/spec/ogcapi-records-1/1.0/conf/record-collection +| https://docs.ogc.org/DRAFTS/20-004.html#clause-crawlable-catalog[Crawlable Catalog] | http://www.opengis.net/spec/ogcapi-records-1/1.0/conf/crawlable-catalog +| https://docs.ogc.org/DRAFTS/20-004.html#clause-local-resources-catalog[Local Resources Catalog] | http://www.opengis.net/spec/ogcapi-records-1/1.0/conf/local-resources-catalog +| https://docs.ogc.org/DRAFTS/20-004.html#clause-autodiscovery[Autodiscovery] | http://www.opengis.net/spec/ogcapi-records-1/1.0/conf/autodiscovery +|=== + +The additional requirements include linking to the `/collections` end-point with an `http://www.opengis.net/def/rel/ogc/1.0/ogc-catalog` link relation from the landing page.