You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: extensions/schemas/standard/clause_10_returnables_and_receivables.adoc
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,23 +14,23 @@ The Requirements Class "Returnables and Receivables" specifies the web resources
14
14
This requirements class supports clients that want to discover the list of resource properties with their types and constraints that is returned when fetching a representation of the resource or when creating a new or updating an existing resource.
^|A |A Returnables and Receivables resource SHALL be referenced from all Collection resources with a link with the link relation type `\http://www.opengis.net/def/rel/ogc/1.0/schema`.
Copy file name to clipboardExpand all lines: extensions/schemas/standard/clause_11_queryables.adoc
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,23 +18,23 @@ OGC API Standards do not assume that the content schema of a resource being quer
18
18
In addition, a <<publisher-def,publisher>> may want to support <<queryable-def,queryables>> that are not directly represented as resource properties in the content schema of the resource. Or the <<publisher-def,publisher>> may want to restrict filtering on certain properties. For example, because the backend datastore has not been configured to allow high-performance queries on those properties.
^|A |A Queryables resource SHALL be referenced from all Collection resources with a link with the link relation type `\http://www.opengis.net/def/rel/ogc/1.0/queryables`.
Copy file name to clipboardExpand all lines: extensions/schemas/standard/clause_12_sortables.adoc
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,23 +18,23 @@ OGC API Standards do not assume that the content schema of a resource being quer
18
18
In addition, a <<publisher-def,publisher>> may want to support <<sortable-def,sortable>> that are not directly represented as resource properties in the content schema of the resource. Or the <<publisher-def,publisher>> may want to restrict sorting on certain properties. For example, because the backend datastore has not been configured to allow high-performance queries on those properties.
^|A |A Sortables resource SHALL be referenced from all Collection resources with a link with the link relation type `\http://www.opengis.net/def/rel/ogc/1.0/sortables`.
@@ -26,11 +26,11 @@ The requirements stated in this Standard cover only simple cases. More complex c
26
26
For features, the query parameter "profile" will be applicable to the GET operation on the paths `/collections/{collectionId}/items` and `/collections/{collectionId}/items/{resourceId}`.
^|A |In the profile "rel-as-key" (`\http://www.opengis.net/def/profile/OGC/0/rel-as-key`) a reference in the response SHALL be represented by the `resourceId` of the referenced resource (a string or integer, depending on the type of the identifier property in the referenced collection), if the property with role "reference" has the keyword "x-ogc-collectionId" with a string value (a fixed collection).
33
+
^|A |In the profile "rel-as-key" (`\http://www.opengis.net/def/profile/OGC/0/rel-as-key`) a reference in the response SHALL be represented by the `resourceId` of the referenced resource (a string or integer, depending on the type of the identifier property in the referenced collection), if the property with role "reference" has the keyword "x-ogc-collectionId".
34
34
|===
35
35
36
36
[[example_14_1]]
@@ -67,7 +67,7 @@ The examples in this Clause use the <<example_9_1,example road accident feature
@@ -156,7 +156,7 @@ Servers will typically not support the profile "rel-as-link" for media types tha
156
156
"rel-as-link" will typically be the most useful representation, if a human user interacts with the resource. This is because of the possibility to include a descriptive label of the referenced resource. Of course, this only applies if the server can provide a meaningful title for each link, in which case this information can help the user to understand the referenced resource.
^|A |Each property SHALL include a "type" member, except for spatial properties.
44
44
^|B |Each spatial property SHALL not include a "type" or "$ref" member.
45
45
^|C |Each spatial property SHALL include a "format" member with a string value "geometry", followed by a hyphen, followed by the name of the geometry type in lower case. I.e., the values for the core Simple Feature geometry types are: "geometry-point", "geometry-multipoint", "geometry-linestring", "geometry-multilinestring", "geometry-polygon", "geometry-multipolygon", and "geometry-geometrycollection". In addition, the following special values are supported: "geometry-any" as the wildcard for any geometry type, "geometry-point-or-multipoint" for a Point or MultiPoint, "geometry-linestring-or-multilinestring" for a LineString or MultiLineString, and "geometry-polygon-or-multipolygon" for a Polygon or MultiPolygon.
46
-
^|D |Each temporal property SHALL be a "string" literal with the appropriate format (e.g., "date-time" or "date" for instances, depending on the temporal granularity).
47
-
^|E |As a general rule, if the data type of a property has to be more specific than the JSON Schema data types ("number", "integer", "string"), the "format" keyword SHALL be used.
48
-
^|F |Properties that are only applicable when creating new data or updating existing data SHALL include "writeOnly: true".
49
-
^|G |Properties that are only applicable when data is fetched SHALL include "readOnly: true".
46
+
^|D |Each temporal property that represents an instant (including the start or end of an interval) SHALL be a "string" literal with the appropriate format (e.g., "date-time" or "date", depending on the temporal granularity).
47
+
^|E |Each temporal property that represents an interval SHALL either be a "string" literal with format "interval-iso8601" (two instants with the same granularity separated by a "/") or an array with format "interval-array" consisting of two "string"s representing the interval start and end instants. In both variants, unbounded interval ends are represented by the string "..".
48
+
^|F |As a general rule, if the data type of a property has to be more specific than the JSON Schema data types ("number", "integer", "string"), the "format" keyword SHALL be used.
49
+
^|G |Properties that are only applicable when creating new data or updating existing data SHALL include "writeOnly: true".
50
+
^|H |Properties that are only applicable when data is fetched SHALL include "readOnly: true".
50
51
|===
51
52
52
53
The following recommendations are intended to simplify parsing a schema and to help understanding the meaning and representation of the properties:
@@ -88,7 +89,7 @@ NOTE: The OGC format register needs to be established.
88
89
In order to be able to map the logical schema to a format-specific schema, extensions to the JSON Schema vocabulary are needed.
@@ -127,7 +128,7 @@ For cases, where the properties of the resource should be ordered in some repres
127
128
- the representation of the data in a format that requires a specific order of properties (e.g., XML based on an XML Schema that uses a `sequence` for the property elements).
@@ -148,7 +149,7 @@ For cases, where the properties of the resource should be ordered in some repres
148
149
In geospatial data, numeric property values often represent a measurement and have a unit of measure. For fixed units, this can be expressed in the schema using the keyword "x-ogc-unit".
0 commit comments