Skip to content

Commit 755628c

Browse files
authored
Merge pull request #342 from pvretano/pav-review
PAV Review edits.
2 parents e9ef0f7 + b89f958 commit 755628c

35 files changed

+184
-216
lines changed

core/openapi/ogcapi-records-1-building-blocks.yaml

+10
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,16 @@ components:
7373
type: string
7474
explode: false
7575
style: form
76+
ids:
77+
name: ids
78+
in: query
79+
required: false
80+
schema:
81+
type: array
82+
items:
83+
type: string
84+
explode: false
85+
style: form
7686
language:
7787
name: language
7888
in: query

core/openapi/ogcapi-records-1-example-ref-buildingblocks-bundle.yaml

+1
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,7 @@ paths:
151151
- $ref: 'https://raw.githubusercontent.com/opengeospatial/ogcapi-records/master/core/openapi/ogcapi-records-1-building-blocks.yaml#/components/parameters/q'
152152
- $ref: 'https://raw.githubusercontent.com/opengeospatial/ogcapi-records/master/core/openapi/ogcapi-records-1-building-blocks.yaml#/components/parameters/type'
153153
- $ref: 'https://raw.githubusercontent.com/opengeospatial/ogcapi-records/master/core/openapi/ogcapi-records-1-building-blocks.yaml#/components/parameters/externalId'
154+
- $ref: 'https://raw.githubusercontent.com/opengeospatial/ogcapi-records/master/core/openapi/ogcapi-records-1-building-blocks.yaml#/components/parameters/ids'
154155
- $ref: 'https://raw.githubusercontent.com/opengeospatial/ogcapi-records/master/core/openapi/ogcapi-records-1-building-blocks.yaml#/components/parameters/sortby'
155156
responses:
156157
'200':

core/openapi/ogcapi-records-1-example-ref-schema-repo.yaml

+1
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,7 @@ paths:
150150
- $ref: 'parameters/q.yaml'
151151
- $ref: 'parameters/type.yaml'
152152
- $ref: 'parameters/externalId.yaml'
153+
- $ref: 'parameters/ids.yaml'
153154
- $ref: 'parameters/sortby.yaml'
154155
responses:
155156
'200':

core/openapi/parameters/ids.yaml

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
name: ids
3+
in: query
4+
description:
5+
The optional ids parameter allows a specified of records to be fetched
6+
from a catalogue using their identifiers.
7+
required: false
8+
schema:
9+
type: array
10+
items:
11+
type: string
12+
explode: false
13+
style: form

core/standard/abstract_tests/ATS_class_searchable-catalog_crs.adoc

-13
This file was deleted.

core/standard/abstract_tests/searchable-catalog_crs/ATS_crs.adoc

-12
This file was deleted.

core/standard/annex_ats.adoc

+3-6
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
[appendix]
22
:appendix-caption: Annex
3+
[[annex_ats]]
34
== Conformance Class Abstract Test Suite (Normative)
45

56
=== Conformance Class: Record Core
@@ -50,7 +51,7 @@ include::abstract_tests/ATS_class_oas30.adoc[]
5051

5152
include::abstract_tests/ATS_class_record-core-query-parameters.adoc[]
5253

53-
=== Conformance Class: Filtering using the Common Query Language (CQL)
54+
=== Conformance Class: Filtering using the Common Query Language (CQL2)
5455

5556
include::abstract_tests/ATS_class_record-filter.adoc[]
5657

@@ -62,14 +63,10 @@ include::abstract_tests/ATS_class_sorting.adoc[]
6263

6364
include::abstract_tests/ATS_class_searchable-catalog.adoc[]
6465

65-
=== Conformance Class: Searchable Catalog CRS
66-
67-
include::abstract_tests/ATS_class_searchable-catalog_crs.adoc[]
68-
6966
=== Conformance Class: Searchable Catalog Filtering
7067

7168
include::abstract_tests/ATS_class_searchable-catalog_filtering.adoc[]
7269

7370
=== Conformance Class: Searchable Catalog Sorting
7471

75-
include::abstract_tests/ATS_class_searchable-catalog_sorting.adoc[]
72+
include::abstract_tests/ATS_class_searchable-catalog_sorting.adoc[]

core/standard/clause_0_front_material.adoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ A record is the atomic unit of information in a catalog, It contains descriptive
3232
* links to access the resource,
3333
* etc.
3434
35-
This information is generic and can be used to describe a wide variety of resources. This specification expects and encourages implementations to enrich the information content of a record to suit specific use cases, requirements, domains or communities.
35+
This information is generic and can be used to describe a wide variety of resources. This specification expects and encourages implementations to enrich the information content of a record to suit specific use cases, requirements, domains or communities of interest.
3636

3737
A collection of records is itself described by a record that provides descriptive information about the catalog. The collection also provides access to the records of the collection either by explicitly linking to each record that is an item of the collection or by providing a search endpoint that allows the collection of records to be searched.
3838

@@ -43,15 +43,15 @@ The search API allows collections of records to be searched using logically conn
4343
[cols="25,35,10,20",options="header"]
4444
|===
4545
|Resource |Path |HTTP method |Document reference
46-
|Landing page |`/` |GET |<<landing-page,API landing page>>
46+
|Landing page |`/` |GET |https://docs.ogc.org/is/17-069r3/17-069r3.html#_api_landing_page[API landing page]
4747
|Conformance declaration |`/conformance` |GET |<<conformance_class,Conformance>>
4848
|Record collections |`/collections` |GET |<<record-collections,Record collections>>
4949
|Record collection |`/collections/{collectionId}` |GET |<<clause-record-collection,Record Collection>>
5050
|Records |`/collections/{collectionId}/items` |GET |<<records-access,Records access>>
5151
|Record |`/collections/{collectionId}/items/{recordId}` |GET |<<clause-record-core,Record Core>>
5252
|===
5353
54-
A special use case of the catalog deployed as an API is the _local resources catalog_. A local resources catalog is a catalog deployed to make local resources offered by a provider searchable using the catalog information model and API. An example of a local resources catalog is the `/collections` endpoint of http://docs.opengeospatial.org/DRAFTS/20-024.html[OGC API - Common - Part 2: Geospatial data] or http://docs.ogc.org/is/17-069r3/17-069r3.html[OGC API - Features - Part 1: Core]. Adding catalog capabilities to this endpoint allows a client to search for collections that satisfy a specified filter expression. Any API endpoint whose function is to provide a list of resources, such as the `/collections` endpoint, can be extended to be a local resources catalog to search for records describing resources served by that API.
54+
A special use case of the catalog deployed as an API is the _local resources catalog_. A local resources catalog is a catalog deployed to make local resources offered by a provider searchable using the catalog information model and API. An example of a local resources catalog is the `/collections` endpoint of http://docs.opengeospatial.org/DRAFTS/20-024.html[OGC API - Common - Part 2: Geospatial data] or http://docs.ogc.org/is/17-069r3/17-069r3.html[OGC API - Features - Part 1: Core]. Adding catalog capabilities to this endpoint allows a client to search for collections that satisfy a specified filter expression. Any API endpoint defined in an OGC API specification whose function is to provide a list of resources, such as the `/collections` endpoint, can be extended to be a local resources catalog that can be searched for records describing resources served by that API.
5555

5656
[[keywords]]
5757
[big]*ii. Keywords*

core/standard/clause_10_security.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@
33

44
Given the dependencies on <<OACommon,OGC API - Common>> and <<OAFeat-1,OGC API - Features>> and OGC API - Features and OGC API - Common, aspects of security are discussed in those specifications.
55

6-
Metadata record encryption is out of scope for this specification, however communities who wish to implement record encryption are free to do so as needed.
6+
Metadata record encryption is out of scope for this Standard, however communities who wish to implement record encryption are free to do so as needed.

core/standard/clause_2_conformance.adoc

+23-19
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
=== Overview
55

6-
Conformance with this standard shall be checked using the tests specified in Annex A (normative) of this document. The framework, concepts, and methodology for testing, and the criteria to claim conformance, are specified in the OGC Compliance Testing Policies and Procedures and the OGC Compliance Testing web site.
6+
Conformance with this Standard shall be checked using the tests specified in <<annex_ats,Annex A (normative)>> of this document. The framework, concepts, and methodology for testing, and the criteria to claim conformance, are specified in the OGC Compliance Testing Policies and Procedures and the OGC Compliance Testing web site.
77

88
The standardization target of the conformance classes:
99

@@ -17,7 +17,7 @@ The standardization target of the conformance classes:
1717
* <<clause-record-core-query-parameters,Record query parameters>>
1818
* <<clause-records-api,Records API>>
1919
* <<clause-sorting,Sorting>>
20-
* <<clause-filter,Filtering>>
20+
* <<clause-filtering,Filtering>>
2121
* <<clause-searchable-catalog,Searchable Catalog>>
2222
* <<clause-searchable-catalog_filtering,Searchable Catalog - Filtering>>
2323
* <<clause-searchable-catalog_sorting,Searchable Catalog - Sorting>>
@@ -26,7 +26,7 @@ The standardization target of the conformance classes:
2626
* <<clause-local-resources-catalog_filtering,Local Resources Catalog - Filtering>>
2727
* <<clause-local-resources-catalog_sorting,Local Resources Catalog - Sorting>>
2828
* <<clause-autodiscovery,Autodiscovery>>
29-
* <<rc_oas30,OpenAPI 3.0>>
29+
* <<clause-oas30,OpenAPI 3.0>>
3030

3131
is "Web APIs".
3232

@@ -37,14 +37,14 @@ The standardization target of the conformance classes:
3737

3838
is "Document encoding".
3939

40-
https://docs.opengeospatial.org/is/17-069r4/17-069r4.html[OGC API - Features] provides a common foundation for OGC API standards for feature access. Therefore, this standard should be viewed as an extension to OGC API - Features. Conformance to this standard requires demonstrated conformance to the applicable Conformance Classes of https://docs.opengeospatial.org/is/17-069r4/17-069r4.html#_conformance[OGC API - Features].
40+
https://docs.opengeospatial.org/is/17-069r4/17-069r4.html[OGC API - Features] provides a common foundation for OGC API standards for feature access. Therefore, this Standard should be viewed as an extension to OGC API - Features. Conformance to this Standard requires demonstrated conformance to the applicable Conformance Classes of https://docs.opengeospatial.org/is/17-069r4/17-069r4.html#_conformance[OGC API - Features].
4141

42-
The Conformance Classes implemented by an API are advertised through the <<conformance-classes,`/conformance`>> path on the <<landing-page,landing page>>. Each Conformance Class has an associated Requirements Class. The Requirements Classes define the functional requirements which will be tested through the associated Conformance Class.
42+
The Conformance Classes implemented by an API are advertised through the <<conformance-classes,`/conformance`>> path on the https://docs.ogc.org/is/17-069r3/17-069r3.html#_api_landing_page[landing page]. Each Conformance Class has an associated Requirements Class. The Requirements Classes define the functional requirements which will be tested through the associated Conformance Test.
4343

4444
[[building-block-requirements-classes]]
4545
=== Building blocks
4646

47-
This standard also identifies nine (9) building block requirements classes:
47+
This standard also identifies ten (10) building block requirements classes:
4848

4949
* <<clause-record-core,Record Core>>
5050
* <<clause-record-collection,Record collection>>
@@ -54,6 +54,7 @@ This standard also identifies nine (9) building block requirements classes:
5454
* <<clause-filtering,Filtering>>
5555
* <<requirements-class-json-clause,JSON>>
5656
* <<requirements-class-html-clause,HTML>>
57+
* <<clause-oas30,OpenAPI 3.0>>
5758
* <<clause-autodiscovery,Autodiscovery>>
5859

5960
The <<clause-record-core,_Record Core_>> conformance class defines the requirements for the core schema of a catalog record which is a set of properties (<<core-properties,core properties>>) that can be used to make any resource discoverable via a catalog. This core set of properties can be extended as required by specific communities of interest and/or use cases.
@@ -72,12 +73,14 @@ The <<requirements-class-json-clause,_JSON_>> conformance class defines the requ
7273

7374
The <<requirements-class-html-clause,_HTML_>> conformance class defines the requirements for an HTML representation of a standard catalog record.
7475

75-
The <<clause-autodiscovery,Autodiscovery>> conformance class defines requirements that allow catalogs associated with a web page or web site to be discovered.
76+
The <<<<clause-oas30,OpenAPI 3.0>> conformance class defines the requirements for server that use an http://spec.openapis.org/oas/v3.0.3#openapi-document[OpenAPI 3.0] document to define their API.
77+
78+
The <<clause-autodiscovery,Autodiscovery>> conformance class defines requirements that allow catalogs that conform to this Standard and are associated with a web page or web site to be automatically discovered.
7679

7780
[[catalog-requirements-classes]]
7881
=== Catalog deployments
7982

80-
Using the above-mentioned building blocks, this standard identifies the following catalog requirements classes:
83+
Using the above-mentioned building blocks, this Standard identifies the following catalog requirements classes:
8184

8285
* <<clause-crawlable-catalog,Crawlable Catalog>>
8386
* <<clause-searchable-catalog,Searchable Catalog>>
@@ -104,19 +107,20 @@ The <<clause-local-resources-catalog,Local Resources Catalog>>, <<clause-local-r
104107
|<<clause-record-collection,Record collection>> |_Optional_ |Mandatory |N/A
105108
|<<clause-record-core-query-parameters,Record query parameters>> |N/A |_Mandatory_ |_Mandatory_
106109
|<<clause-records-api,Records API>> |N/A |Mandatory |N/A
107-
|<<clause-sorting,Sorting>> |N/A_ |_Optional_ |_Optional_
108-
|<<clause-filter,Filtering>> |N/A |_Optional_ |_Optional_
110+
|<<clause-sorting,Sorting>> |N/A |_Optional_ |_Optional_
111+
|<<clause-filtering,Filtering>> |N/A |_Optional_ |_Optional_
109112
|<<requirements-class-json-clause,JSON>> |_Optional_ |_Optional_ |_Optional_
110113
|<<requirements-class-html-clause,HTML>> |_Optional_ |_Optional_ |_Optional_
114+
|<<clause-oas30,OpenAPI 3.0>> |N/A |_Optional_ |_Optional_
111115
|===
112116

113117
=== Implementations
114118

115-
Implementors of this specification select one or more of the <<catalog-requirements-classes,catalog requirements classes>> they wish to implement and then implement the required building block requirements classes.
119+
Implementors of this Standard select one or more of the <<catalog-requirements-classes,catalog deployment requirements classes>> they wish to implement and then implement the required building block requirements classes.
116120

117121
=== Conformance testing
118122

119-
Conformance with this standard shall be checked using all the relevant tests
123+
Conformance with this Standard shall be checked using all the relevant tests
120124
specified in <<ats,Annex A>> of this document. The framework, concepts, and
121125
methodology for testing, and the criteria to be achieved to claim conformance
122126
are specified in the OGC Compliance Testing Policies and Procedures and the
@@ -127,9 +131,9 @@ OGC Compliance Testing web site.
127131
[cols="30,70",options="header"]
128132
|===
129133
|Conformance class |URI
130-
|<<ats_crawlable-catalog,Crawlable Catalog>> |http://www.opengis.net/spec/ogcapi-records-1/1.0/conf/crawlable-catalog
134+
|<<ats_crawlable_catalog,Crawlable Catalog>> |http://www.opengis.net/spec/ogcapi-records-1/1.0/conf/crawlable-catalog
131135
|<<ats_searchable-catalog,Searchable Catalog>> |http://www.opengis.net/spec/ogcapi-records-1/1.0/conf/searchable-catalog
132-
|<<ats_searchable-catalog_filtering,Searchable Catalog - Filtering>> |http://www.opengis.net/spec/ogcapi-records-1/1.0/conf/searchable-catalog-filtering
136+
|<<ats_searchable_catalog_filtering,Searchable Catalog - Filtering>> |http://www.opengis.net/spec/ogcapi-records-1/1.0/conf/searchable-catalog-filtering
133137
|<<ats_searchable-catalog_sorting,Searchable Catalog - Sorting>> |http://www.opengis.net/spec/ogcapi-records-1/1.0/conf/searchable-catalog-sorting
134138
|<<ats_local-resources-catalog,Local Resources Catalog>> |http://www.opengis.net/spec/ogcapi-records-1/1.0/conf/local-resources-catalog
135139
|<<ats_local-resources-catalog_filtering,Local Resources Catalog - Filtering>> |http://www.opengis.net/spec/ogcapi-records-1/1.0/conf/local-resources-catalog-filtering
@@ -141,12 +145,12 @@ OGC Compliance Testing web site.
141145
[cols="30,70",options="header"]
142146
|===
143147
|Conformance class |URI
144-
|<<ats_core_record,Record Core>> |http://www.opengis.net/spec/ogcapi-records-1/1.0/conf/record-core
145-
|<<ats_record_collection,Record Collection>> |http://www.opengis.net/spec/ogcapi-records-1/1.0/conf/record-collection
146-
|<<ats_record_core-query-parameters,Record query parameters>> |http://www.opengis.net/spec/ogcapi-records-1/1.0/conf/record-core-query-parameters
147-
|<<ats_record_api,Records API>> |http://www.opengis.net/spec/ogcapi-records-1/1.0/conf/record-api
148+
|<<ats_record-core,Record Core>> |http://www.opengis.net/spec/ogcapi-records-1/1.0/conf/record-core
149+
|<<ats_record-collection,Record Collection>> |http://www.opengis.net/spec/ogcapi-records-1/1.0/conf/record-collection
150+
|<<ats_record-core-query-parameters,Record query parameters>> |http://www.opengis.net/spec/ogcapi-records-1/1.0/conf/record-core-query-parameters
151+
|<<ats_records-api,Records API>> |http://www.opengis.net/spec/ogcapi-records-1/1.0/conf/record-api
148152
|<<ats_sorting,Sorting>> |http://www.opengis.net/spec/ogcapi-records-1/1.0/conf/sorting
149-
|<<ats_filtering,Filtering>> |http://www.opengis.net/spec/ogcapi-records-1/1.0/conf/filtering
153+
|<<ats_cql-filter,Filtering>> |http://www.opengis.net/spec/ogcapi-records-1/1.0/conf/filtering
150154
|<<ats_json,JSON>> |http://www.opengis.net/spec/ogcapi-records-1/1.0/conf/json
151155
|<<ats_html,HTML>> |http://www.opengis.net/spec/ogcapi-records-1/1.0/conf/html
152156
|<<ats_oas30,OpenAPI 3.0>> |http://www.opengis.net/spec/ogcapi-records-1/1.0/conf/oas30

0 commit comments

Comments
 (0)