Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Other updates for v1.2 #472

Closed
wants to merge 35 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
5a733d1
Add paragraph
m-burgoyne Nov 9, 2023
db03dce
Create annex_measurement_type_methods.adoc
m-burgoyne Nov 9, 2023
c6b8ea8
Add a definition for repeating intervals
m-burgoyne Nov 9, 2023
a1a09d9
Add optional limit parameter
m-burgoyne Nov 9, 2023
3813b3a
add limit query parameter
m-burgoyne Nov 9, 2023
f9eb139
add limit query parameter
m-burgoyne Nov 9, 2023
f3613e4
Add limit query parameter
m-burgoyne Nov 9, 2023
eb901d5
Add limit query parameter
m-burgoyne Nov 9, 2023
474083a
Add limit query parameter
m-burgoyne Nov 9, 2023
2aa581e
add limit query parameter
m-burgoyne Nov 9, 2023
e4b1b47
add limit query parameter
m-burgoyne Nov 9, 2023
823503f
add limit query parameter
m-burgoyne Nov 9, 2023
42eca77
Add limit query parameter
m-burgoyne Nov 9, 2023
2882408
Add limit query parameter
m-burgoyne Nov 9, 2023
a3d4063
Create limit.yaml
m-burgoyne Nov 9, 2023
b21d529
Add limit query parameter
m-burgoyne Nov 9, 2023
37e9c68
Add limit query parameter
m-burgoyne Nov 9, 2023
f49fdf1
Add limit query parameter
m-burgoyne Nov 9, 2023
215902d
Add limit query parameter
m-burgoyne Nov 9, 2023
2f25ee1
add limit query parameter
m-burgoyne Nov 9, 2023
f6cfa20
Add include for annex_measurement_type_methods.adoc
m-burgoyne Nov 9, 2023
f461229
Update clause_3_references.adoc
m-burgoyne Nov 23, 2023
64cd5de
Fix typo
m-burgoyne Feb 28, 2024
90b39d3
Add limit definition
m-burgoyne Mar 21, 2024
7905f6f
Add limit definition
m-burgoyne Mar 21, 2024
145b43f
Add limit definition
m-burgoyne Mar 21, 2024
9216ee4
Update limit definition
m-burgoyne Mar 21, 2024
6cb7890
fix reference
m-burgoyne Mar 21, 2024
324718c
fix reference
m-burgoyne Mar 21, 2024
b617c99
Fix reference
m-burgoyne Mar 21, 2024
81a3555
Add limit definition
m-burgoyne Mar 21, 2024
26b7a0a
fix typo
m-burgoyne Mar 21, 2024
919d66a
fix typo
m-burgoyne Mar 21, 2024
05f34bf
Fix typo
m-burgoyne Mar 21, 2024
4bf5478
Merge branch 'master' into Other-updates-for-v1.2
chris-little Jun 19, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions core/standard/document.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,8 @@ include::sections/annex_collection_response.adoc[]

include::sections/annex_examples.adoc[]

include::sections/annex_measurement_type_methods.adoc[]

include::sections/annex_relationship.adoc[]

include::sections/annex_glossary.adoc[]
Expand Down
7 changes: 7 additions & 0 deletions core/standard/openapi/parameters/core/limit.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
name: limit
in: query
description: Defines the maximum number of features to return in a request
required: false
example: 10
schema:
type: number
3 changes: 2 additions & 1 deletion core/standard/openapi/paths/queries/area.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ get:
- $ref: ../../parameters/core/resolution-x.yaml
- $ref: ../../parameters/core/resolution-y.yaml
- $ref: ../../parameters/core/f.yaml
- $ref: ../../parameters/core/limit.yaml
responses:
200:
$ref: ../../responses/queries/200.yaml
Expand Down Expand Up @@ -54,4 +55,4 @@ post:
413:
$ref: ../../responses/queries/413.yaml
default:
$ref: ../../responses/core/exception.yaml
$ref: ../../responses/core/exception.yaml
1 change: 1 addition & 0 deletions core/standard/openapi/paths/queries/instance-area.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ get:
- $ref: ../../parameters/core/resolution-y.yaml
- $ref: ../../parameters/core/crs.yaml
- $ref: ../../parameters/core/f.yaml
- $ref: ../../parameters/core/limit.yaml
responses:
200:
$ref: ../../responses/queries/200.yaml
Expand Down
1 change: 1 addition & 0 deletions core/standard/openapi/paths/queries/instance-location.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ get:
- $ref: https://beta.schemas.opengis.net/ogcapi/common/part2/0.1/collections/openapi/parameters/datetime.yaml
- $ref: ../../parameters/core/crs.yaml
- $ref: ../../parameters/core/f.yaml
- $ref: ../../parameters/core/limit.yaml
responses:
200:
$ref: ../../responses/queries/200.yaml
Expand Down
4 changes: 2 additions & 2 deletions core/standard/openapi/paths/queries/instance-locations.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ get:
- Instance data queries
summary: List available location identifers for the instance
description: List the locations available for the instance of the collection
operationId: ListDataInstanceLocations
operationId: GetListDataInstanceLocations
parameters:
- $ref: ../../parameters/collections/collectionId.yaml
- $ref: ../../parameters/queries/instanceId.yaml
Expand All @@ -30,7 +30,7 @@ post:
- Instance data queries
summary: List available location identifers for the instance
description: List the locations available for the instance of the collection
operationId: ListDataInstanceLocations
operationId: PostListDataInstanceLocations
parameters:
- $ref: ../../parameters/collections/collectionId.yaml
- $ref: ../../parameters/queries/instanceId.yaml
Expand Down
1 change: 1 addition & 0 deletions core/standard/openapi/paths/queries/instance-position.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ get:
- $ref: ../../parameters/core/parameter-name.yaml
- $ref: ../../parameters/core/crs.yaml
- $ref: ../../parameters/core/f.yaml
- $ref: ../../parameters/core/limit.yaml
responses:
200:
$ref: ../../responses/queries/200.yaml
Expand Down
3 changes: 2 additions & 1 deletion core/standard/openapi/paths/queries/instance-radius.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ get:
- Instance data queries
summary: 'Query end point to return data within defined radius of a point for an instance {instanceId} of collection {collectionId}'
description: Query end point to return all data within a defined radius of the defined point location queries
operationId: PostInstanceDataForRadius
operationId: GetInstanceDataForRadius
parameters:
- $ref: ../../parameters/collections/collectionId.yaml
- $ref: ../../parameters/queries/instanceId.yaml
Expand All @@ -16,6 +16,7 @@ get:
- $ref: ../../parameters/core/parameter-name.yaml
- $ref: ../../parameters/core/crs.yaml
- $ref: ../../parameters/core/f.yaml
- $ref: ../../parameters/core/limit.yaml
responses:
200:
$ref: ../../responses/queries/200.yaml
Expand Down
1 change: 1 addition & 0 deletions core/standard/openapi/paths/queries/location.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ get:
- $ref: ../../parameters/core/parameter-name.yaml
- $ref: ../../parameters/core/crs.yaml
- $ref: ../../parameters/core/f.yaml
- $ref: ../../parameters/core/limit.yaml
responses:
200:
$ref: ../../responses/queries/200.yaml
Expand Down
1 change: 1 addition & 0 deletions core/standard/openapi/paths/queries/position.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ get:
- $ref: ../../parameters/core/parameter-name.yaml
- $ref: ../../parameters/core/crs.yaml
- $ref: ../../parameters/core/f.yaml
- $ref: ../../parameters/core/limit.yaml
responses:
200:
$ref: ../../responses/queries/200.yaml
Expand Down
1 change: 1 addition & 0 deletions core/standard/openapi/paths/queries/radius.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ get:
- $ref: ../../parameters/core/parameter-name.yaml
- $ref: ../../parameters/core/crs.yaml
- $ref: ../../parameters/core/f.yaml
- $ref: ../../parameters/core/limit.yaml
responses:
200:
$ref: ../../responses/queries/200.yaml
Expand Down
2 changes: 2 additions & 0 deletions core/standard/openapi/request-bodies/area.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,6 @@ content:
type: string
f:
type: string
limit:
type: number

2 changes: 2 additions & 0 deletions core/standard/openapi/request-bodies/location.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,6 @@ content:
type: string
f:
type: string
limit:
type: number

2 changes: 2 additions & 0 deletions core/standard/openapi/request-bodies/locations.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,6 @@ content:
type: string
datetime:
type: string
limit:
type: number

2 changes: 2 additions & 0 deletions core/standard/openapi/request-bodies/position.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,6 @@ content:
type: string
f:
type: string
limit:
type: number

2 changes: 2 additions & 0 deletions core/standard/openapi/request-bodies/radius.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,6 @@ content:
type: string
f:
type: string
limit:
type: number

5 changes: 3 additions & 2 deletions core/standard/requirements/core/REQ_rc-time-response.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,9 @@ The temporal information is either a date-time or a time interval. The parameter
interval-closed = date-time "/" date-time
interval-open-start = "../" date-time
interval-open-end = date-time "/.."
interval = interval-closed / interval-open-start / interval-open-end
datetime = date-time / interval
repeating interval = R[number of repetitions] / date-time / interval
datetime = date-time
list of datetimes = date-time, date-time, date-time
----
---
*E:*
Expand Down
7 changes: 7 additions & 0 deletions core/standard/requirements/edr/query_type/area.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,13 @@ a| **f**
* `f=netCDF4`
* `f=CoverageJSON`
* `f=CSV`
a| **limit**

* <<req_edr_rc-limit-definition,definition>>

* <<req_edr_rc-limit-response,rules>> |String|No|The limit parameter may be used to control the subset of the selected features that should be returned in the response, the page size.
Each page may include information about the number of selected and returned features (numberMatched and numberReturned) as well as links to support paging (link relation next).
**This value will be ignored if the requested format or the server does not support paging** a| * `limit=100`
|====

#If a client request has a *coords* value which includes a height value and defines a *z* query parameter the *z* query parameter will be the requested height value.#
4 changes: 3 additions & 1 deletion core/standard/requirements/edr/query_type/item.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,9 @@ a| **limit**

* <<req_edr_rc-limit-definition,definition>>

* <<req_edr_rc-limit-response,rules>> |String |No| Maximum number of items to return a| * `limit=10`
* <<req_edr_rc-limit-response,rules>> |String |No| The limit parameter may be used to control the subset of the selected features that should be returned in the response, the page size.
Each page may include information about the number of selected and returned features (numberMatched and numberReturned) as well as links to support paging (link relation next).
**This value will be ignored if the requested format or the server does not support paging** a| * `limit=10`

|====

Expand Down
7 changes: 7 additions & 0 deletions core/standard/requirements/edr/query_type/locations.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,13 @@ a| **f**
* `f=netCDF4`
* `f=CoverageJSON`
* `f=CSV`
a| **limit**

* <<req_edr_rc-limit-definition,definition>>

* <<req_edr_rc-limit-response,rules>> |String|No|The limit parameter may be used to control the subset of the selected features that should be returned in the response, the page size.
Each page may include information about the number of selected and returned features (numberMatched and numberReturned) as well as links to support paging (link relation next).
**This value will be ignored if the requested format or the server does not support paging** a| * `limit=100`
|====


7 changes: 7 additions & 0 deletions core/standard/requirements/edr/query_type/point.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,13 @@ a| **f**
* `f=netCDF4`
* `f=CoverageJSON`
* `f=CSV`
a| **limit**

* <<req_edr_rc-limit-definition,definition>>

* <<req_edr_rc-limit-response,rules>> |String|No|The limit parameter may be used to control the subset of the selected features that should be returned in the response, the page size.
Each page may include information about the number of selected and returned features (numberMatched and numberReturned) as well as links to support paging (link relation next).
**This value will be ignored if the requested format or the server does not support paging** a| * `limit=100`
|====

#If a client request has a *coords* value which includes a height value and defines a *z* query parameter, the *z* query parameter will be the requested height value.#
7 changes: 7 additions & 0 deletions core/standard/requirements/edr/query_type/radius.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,13 @@ a| **f**
* `f=netCDF4`
* `f=CoverageJSON`
* `f=CSV`
a| **limit**

* <<req_edr_rc-limit-definition,definition>>

* <<req_edr_rc-limit-response,rules>> |String|No|The limit parameter may be used to control the subset of the selected features that should be returned in the response, the page size.
Each page may include information about the number of selected and returned features (numberMatched and numberReturned) as well as links to support paging (link relation next).
**This value will be ignored if the requested format or the server does not support paging** a| * `limit=100`
|====

#If a client request has a *coords* value which includes a height value and defines a *z* query parameter the *z* query parameter will be the requested height value.#
Expand Down
93 changes: 93 additions & 0 deletions core/standard/sections/annex_measurement_type_methods.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
[appendix,obligation="informative"]

[[measurementType_methods_desc]]
== Parameter measurementType Methods (Informative)

The parameter-names object provides information about the data parameters supported by the collection, each `parameter-names`` object has an optional `measurementType` attribute which provides basic information about how the parameter is calculated and over what time period. The table below provides a list of recommended definitions for the `method` property of the `measurementType` attribute.

[width="100%",cols="22%,22%,14%,42%",frame="topbot",options="header"]
.Recommended method values
|==========================
|Method | Description
|instantaneous | The data values are representative of points in space or time
|sum | The data values are representative of a sum or accumulation
|maximum | Maximum
|median | Median
|mid_range | Average of maximum and minimum
|minimum | Minimum
|mean | Mean (average value)
|mode | Mode (most common value)
|range | Absolute difference between maximum and minimum
|root_mean_square | Root mean square (RMS)
|standard_deviation | Standard deviation
|==========================


In the example below the data in the collection consists of:

Air temperature values which represent an instantaneous value for the validity time
Wind Speed and Wind direction values which represent a average value over the 10 minute period upto the validity time.

[source,json]
----

"parameter_names": {
"air_temperature": {
"type": "Parameter",
"description": "Air temperature measured at screen level",
"unit": {
"label": "K",
"symbol": {
"value": "K",
"type": "http://qudt.org/vocab/unit/K"
}
},
"observedProperty": {
"id": "http://codes.wmo.int/bufr4/b/12/004",
"label": "Air Temperature"
},
"measurementType": {
"method": "instantaneous",
"period": "PT0S"
}
},
"wind_speed": {
"type": "Parameter",
"description": "10m wind speed value",
"unit": {
"label": "m/s",
"symbol": {
"value": "m%20s",
"type": "http://qudt.org/vocab/unit/M-PER-SEC.html"
}
},
"observedProperty": {
"id": "http://codes.wmo.int/bufr4/b/11/012",
"label": "10m Wind Speed"
},
"measurementType": {
"method": "mean",
"period": "-PT10M/PT0M"
}
},
"wind_direction": {
"type": "Parameter",
"description": "10m wind direction value",
"unit": {
"label": "",
"symbol": {
"value": "deg",
"type": "https://qudt.org/vocab/unit/DEG.html"
}
},
"observedProperty": {
"id": "http://codes.wmo.int/bufr4/b/11/011",
"label": "10m wind direction"
},
"measurementType": {
"method": "mean",
"period": "-PT10M/PT0M"
}
}
}
----
2 changes: 1 addition & 1 deletion core/standard/sections/clause_3_references.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The following normative documents contain provisions that, through reference in
* [[[post,HTTP POST]]] Fielding, R., Reschke, J.: IETF RFC 7231, Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content, https://datatracker.ietf.org/doc/html/rfc7231#section-4.3.3[https://datatracker.ietf.org/doc/html/rfc7231#section-4.3.3]
* [[[html5,html5]]] W3C: HTML5, W3C Recommendation, https://www.w3.org/TR/html5/[https://www.w3.org/TR/html5/]
* [[[schema_org,schema_org]]]Schema.org: https://schema.org/docs/schemas.html[https://schema.org/docs/schemas.html]
* [[[covjson,covjson]]] Blower, J., Riechert, M., Roberts, B.: Overview of the CoverageJSON format, https://www.w3.org/TR/covjson-overview/[https://www.w3.org/TR/covjson-overview/]
* [[[OGC21-069r2,OGC 21-069r2]]] Little, C., Blower, J., Riechert, M., Kralidis, T., Davies, E., Olson, S., McGibbney, L.: OGC CoverageJSON Community Standard, https://docs.ogc.org/cs/21-069r2/21-069r2.html[https://docs.ogc.org/cs/21-069r2/21-069r2.html]
* [[[rfc2413,rfc2413]]] Weibel, S., Kunze, J., Lagoze, C., Wolf, M.: IETF RFC 2413, Dublin Core Metadata for Resource Discovery, https://tools.ietf.org/rfc/rfc2413.txt[https://tools.ietf.org/rfc/rfc2413.txt]
* [[[OGC06-103r4,OGC 06-103r4]]] Herring, J.: Simple Feature Access - Part 1: Common Architecture, http://portal.opengeospatial.org/files/?artifact_id=25355[http://portal.opengeospatial.org/files/?artifact_id=25355]
* [[[OGC18-010r7,OGC 18-010r7]]] Lott, R.: Well-Known Text representation of Coordinate Reference Systems, http://docs.opengeospatial.org/is/18-010r7/18-010r7.html[http://docs.opengeospatial.org/is/18-010r7/18-010r7.html]
Expand Down
2 changes: 2 additions & 0 deletions core/standard/sections/clause_8_queries.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@ The OGC API — Common standard does not define any information resource typ
[[query-resources-section]]
=== Query Resources

**The following tables define the query parameters for each of the EDR query types, the query types support a mix of optional and required query parameters. Where necessary an EDR implementation can use its OpenAPI document response (i.e. `/api`) to override the default for query parameters from optional to required or only advertise the query parameters that are supported by the API (ALL EDR implementations MUST implement query parameters that are required by the EDR standard). The OpenAPI document for an EDR service SHALL be the definitive reference of whether a query parameter is required in any request to the EDR server.**

[#query-resource-table,reftext='{table-caption} {counter:table-num}']
.Query Types
[width="90%",cols=",,",options="header"]
Expand Down
Loading