From c2d0b696a0ae17bad764ce4fb7c0cd2501bb26b7 Mon Sep 17 00:00:00 2001 From: Kunlin Yu Date: Thu, 24 Jul 2025 09:51:41 +0800 Subject: [PATCH] Rename updateFrequency to samplingInterval Signed-off-by: Kunlin Yu --- openapi/examples/collection.json | 4 ++-- openapi/examples/collections.json | 2 +- openapi/examples/collections_post.json | 4 ++-- openapi/ogcapi-movingfeatures-1.bundled.json | 16 ++++++++-------- openapi/ogcapi-movingfeatures-1.bundled.yaml | 16 ++++++++-------- openapi/openapi-movingfeatures-1.yaml | 4 ++-- openapi/schemas/collection.yaml | 2 +- openapi/schemas/requestBody/collection.yaml | 4 ++-- ...lause_8_requirements_resource_collection.adoc | 4 ++-- standard/examples/collection-post.adoc | 2 +- .../collection/REQ_operation-collection-put.adoc | 10 +++++----- .../common/REQ_parameter-datetime.adoc | 4 ++-- 12 files changed, 36 insertions(+), 36 deletions(-) diff --git a/openapi/examples/collection.json b/openapi/examples/collection.json index eeecbdd..bde2f37 100644 --- a/openapi/examples/collection.json +++ b/openapi/examples/collection.json @@ -2,7 +2,7 @@ "id": "mfc-1", "title": "moving_feature_collection_sample", "itemType": "movingfeature", - "updateFrequency": 1000, + "samplingInterval": 1000, "extent": { "spatial": { "bbox": [ @@ -28,4 +28,4 @@ "type": "application/json" } ] -} \ No newline at end of file +} diff --git a/openapi/examples/collections.json b/openapi/examples/collections.json index 3c70cd8..798a5ad 100644 --- a/openapi/examples/collections.json +++ b/openapi/examples/collections.json @@ -5,7 +5,7 @@ "title": "MovingFeatureCollection_1", "description": "a collection of moving features to manage data in a distinct (physical or logical) space", "itemType": "movingfeature", - "updateFrequency": 1000, + "samplingInterval": 1000, "extent": { "spatial": { "bbox": [ diff --git a/openapi/examples/collections_post.json b/openapi/examples/collections_post.json index 261dbae..f4e2f73 100644 --- a/openapi/examples/collections_post.json +++ b/openapi/examples/collections_post.json @@ -1,6 +1,6 @@ { "title": "moving_feature_collection_sample", - "updateFrequency": 1000, + "samplingInterval": 1000, "description": "example", "itemType": "movingfeature" -} \ No newline at end of file +} diff --git a/openapi/ogcapi-movingfeatures-1.bundled.json b/openapi/ogcapi-movingfeatures-1.bundled.json index f756226..dfccf60 100644 --- a/openapi/ogcapi-movingfeatures-1.bundled.json +++ b/openapi/ogcapi-movingfeatures-1.bundled.json @@ -126,7 +126,7 @@ }, "example": { "title": "moving_feature_collection_sample", - "updateFrequency": 1000, + "samplingInterval": 1000, "description": "example", "itemType": "movingfeature" } @@ -204,7 +204,7 @@ "put": { "operationId": "replaceMetadata", "summary": "Replace metadata about the collection", - "description": "A user SHOULD replace metadata with id `collectionId`.\n\nThe request body schema is the same the POST's one. \n\nHowever, `updateFrequency` property is NOT updated.\n", + "description": "A user SHOULD replace metadata with id `collectionId`.\n\nThe request body schema is the same the POST's one. \n\nHowever, `samplingInterval` property is NOT updated.\n", "tags": [ "MovingFeatureCollection" ], @@ -221,7 +221,7 @@ }, "example": { "title": "moving_feature_collection_sample", - "updateFrequency": 1000, + "samplingInterval": 1000, "description": "example", "itemType": "movingfeature" } @@ -1504,7 +1504,7 @@ "https://www.opengis.net/def/crs/EPSG/0/4326" ] }, - "updateFrequency": { + "samplingInterval": { "description": "a time interval of sampling location. The unit is millisecond.", "type": "number" } @@ -1541,7 +1541,7 @@ "description": "human readable title of the collection", "type": "string" }, - "updateFrequency": { + "samplingInterval": { "description": "a time interval of sampling location. The unit is millisecond.", "type": "number" }, @@ -2719,7 +2719,7 @@ "title": "MovingFeatureCollection_1", "description": "a collection of moving features to manage data in a distinct (physical or logical) space", "itemType": "movingfeature", - "updateFrequency": 1000, + "samplingInterval": 1000, "extent": { "spatial": { "bbox": [ @@ -2769,7 +2769,7 @@ "id": "mfc-1", "title": "moving_feature_collection_sample", "itemType": "movingfeature", - "updateFrequency": 1000, + "samplingInterval": 1000, "extent": { "spatial": { "bbox": [ @@ -3389,4 +3389,4 @@ } } } -} \ No newline at end of file +} diff --git a/openapi/ogcapi-movingfeatures-1.bundled.yaml b/openapi/ogcapi-movingfeatures-1.bundled.yaml index bccacf1..2101ea6 100644 --- a/openapi/ogcapi-movingfeatures-1.bundled.yaml +++ b/openapi/ogcapi-movingfeatures-1.bundled.yaml @@ -86,7 +86,7 @@ paths: $ref: '#/components/schemas/collection-body' example: title: moving_feature_collection_sample - updateFrequency: 1000 + samplingInterval: 1000 description: example itemType: movingfeature responses: @@ -141,7 +141,7 @@ paths: The request body schema is the same the POST's one. - However, `updateFrequency` property is NOT updated. + However, `samplingInterval` property is NOT updated. tags: - MovingFeatureCollection parameters: @@ -153,7 +153,7 @@ paths: $ref: '#/components/schemas/collection-body' example: title: moving_feature_collection_sample - updateFrequency: 1000 + samplingInterval: 1000 description: example itemType: movingfeature responses: @@ -1085,7 +1085,7 @@ components: example: - https://www.opengis.net/def/crs/OGC/1.3/CRS84 - https://www.opengis.net/def/crs/EPSG/0/4326 - updateFrequency: + samplingInterval: description: a time interval of sampling location. The unit is millisecond. type: number collections: @@ -1110,7 +1110,7 @@ components: title: description: human readable title of the collection type: string - updateFrequency: + samplingInterval: description: a time interval of sampling location. The unit is millisecond. type: number description: @@ -1883,7 +1883,7 @@ components: title: MovingFeatureCollection_1 description: a collection of moving features to manage data in a distinct (physical or logical) space itemType: movingfeature - updateFrequency: 1000 + samplingInterval: 1000 extent: spatial: bbox: @@ -1915,7 +1915,7 @@ components: id: mfc-1 title: moving_feature_collection_sample itemType: movingfeature - updateFrequency: 1000 + samplingInterval: 1000 extent: spatial: bbox: @@ -2426,4 +2426,4 @@ components: description: local identifier of a temporal primitive value required: true schema: - type: string \ No newline at end of file + type: string diff --git a/openapi/openapi-movingfeatures-1.yaml b/openapi/openapi-movingfeatures-1.yaml index f4dfd86..0ae4c93 100644 --- a/openapi/openapi-movingfeatures-1.yaml +++ b/openapi/openapi-movingfeatures-1.yaml @@ -160,7 +160,7 @@ paths: The request body schema is the same the POST's one. - However, `updateFrequency` property is NOT updated. + However, `samplingInterval` property is NOT updated. tags: - MovingFeatureCollection parameters: @@ -620,4 +620,4 @@ paths: - Or a temporal property with the specified id was not found. - Or a temporal primitive primitive with the specified id was not found. '500': - $ref: "responses/ServerError.yaml" \ No newline at end of file + $ref: "responses/ServerError.yaml" diff --git a/openapi/schemas/collection.yaml b/openapi/schemas/collection.yaml index d37e300..bf596e2 100644 --- a/openapi/schemas/collection.yaml +++ b/openapi/schemas/collection.yaml @@ -42,6 +42,6 @@ properties: example: - 'https://www.opengis.net/def/crs/OGC/1.3/CRS84' - 'https://www.opengis.net/def/crs/EPSG/0/4326' - updateFrequency: + samplingInterval: description: a time interval of sampling location. The unit is millisecond. type: number diff --git a/openapi/schemas/requestBody/collection.yaml b/openapi/schemas/requestBody/collection.yaml index 2973f07..8a80a8f 100644 --- a/openapi/schemas/requestBody/collection.yaml +++ b/openapi/schemas/requestBody/collection.yaml @@ -5,7 +5,7 @@ properties: title: description: human readable title of the collection type: string - updateFrequency: + samplingInterval: description: a time interval of sampling location. The unit is millisecond. type: number description: @@ -14,4 +14,4 @@ properties: itemType: description: indicator about the type of the items in the moving features collection (the default value is 'movingfeature'). type: string - default: "movingfeature" \ No newline at end of file + default: "movingfeature" diff --git a/standard/clause_8_requirements_resource_collection.adoc b/standard/clause_8_requirements_resource_collection.adoc index 8032885..f74b918 100644 --- a/standard/clause_8_requirements_resource_collection.adoc +++ b/standard/clause_8_requirements_resource_collection.adoc @@ -19,7 +19,7 @@ The schema for the collection information object presented in this clause is an |_links_ |M |A list of links for navigating the API (e.g. link to previous or next pages; links to alternative representations, etc.) |_extent_ |O |The spatiotemporal coverage of the collection. |*_itemType_* |M |Fixed to the value "movingfeature". -|*_updateFrequency_* |O |A time interval of sampling location. The time unit of this property is millisecond. +|*_samplingInterval* |O |A time interval of sampling location. The time unit of this property is millisecond. |=== NOTE: The _id_, _title_, _description_, _links_, _extent_, and _itemType_ properties were inherited from link:https://docs.ogc.org/DRAFTS/20-024.html#collection-description[OGC API — Common] and link:https://docs.ogc.org/is/17-069r3/17-069r3.html#_collections_[OGC API — Features]. @@ -113,4 +113,4 @@ A successful response to the *Collection* DELETE operation is an HTTP status cod include::requirements/collection_catalog/collection/REQ_response-collection-delete.adoc[] ==== Error situations -General guidance on HTTP status codes and how they should be handled is provided in <>. \ No newline at end of file +General guidance on HTTP status codes and how they should be handled is provided in <>. diff --git a/standard/examples/collection-post.adoc b/standard/examples/collection-post.adoc index e731c6d..14ca77d 100644 --- a/standard/examples/collection-post.adoc +++ b/standard/examples/collection-post.adoc @@ -7,7 +7,7 @@ | | | { | | "title": "MovingFeatureCollection_1", | - | "updateFrequency": 1000, | + | "samplingInterval": 1000, | | "description": "a collection of moving features to manage data | | in a distinct (physical or logical) space", | | "itemType": "movingfeature" | diff --git a/standard/requirements/collection_catalog/collection/REQ_operation-collection-put.adoc b/standard/requirements/collection_catalog/collection/REQ_operation-collection-put.adoc index 1205063..cff8007 100644 --- a/standard/requirements/collection_catalog/collection/REQ_operation-collection-put.adoc +++ b/standard/requirements/collection_catalog/collection/REQ_operation-collection-put.adoc @@ -5,8 +5,8 @@ ^|*Requirement {counter:req-id}* |*/req/mf-collection/collection-put* ^|A |An implementation of the OGC API - Moving Features Standard SHALL comply with the OGC API — Features `PUT` operation requirement http://docs.ogc.org/DRAFTS/20-002.html#_operation_2[`/req/create-replace-delete/update-put-op`]. ^|B |An implementation of the OGC API - Moving Features Standard SHALL comply with the OGC API — Features `PUT` request body requirements http://docs.ogc.org/DRAFTS/20-002.html#_request_body_2[`/req/create-replace-delete/update-put-body` and `/req/create-replace-delete/update-put-content-type`]. -^|C |The content of the request body SHALL be based upon the <>, except `updateFrequency`. + -If the `updateFrequency` is included in the request body, the server SHALL ignore it. +^|C |The content of the request body SHALL be based upon the <>, except `samplingInterval`. + +If the `samplingInterval` is included in the request body, the server SHALL ignore it. |=== //// @@ -19,9 +19,9 @@ identifier:: /req/mf-collection/collection-put // part:: An implementation of the OGC API - Moving Features Standard SHALL comply with the OGC API — Features `PUT` request body requirements http://docs.ogc.org/DRAFTS/20-002.html#_request_body_2[`/req/create-replace-delete/put-body` and `/req/create-replace-delete/put-content-type`]. part:: For every resource in the collection, the server SHALL support the HTTP PUT operation. part:: The `Content-Type` header SHALL be used to indicate the media type of the request body containing the representation of the new resource content. -part:: The content of the request body SHALL be based upon the <>, except `updateFrequency`. + -If the `updateFrequency` is included in the request body, the server SHALL ignore it. +part:: The content of the request body SHALL be based upon the <>, except `samplingInterval`. + +If the `samplingInterval` is included in the request body, the server SHALL ignore it. ==== [NOTE] -See link:https://www.rfc-editor.org/rfc/rfc9110#field.content-type[section 8.3 of RFC 9110] for details of `Content-Type`. \ No newline at end of file +See link:https://www.rfc-editor.org/rfc/rfc9110#field.content-type[section 8.3 of RFC 9110] for details of `Content-Type`. diff --git a/standard/requirements/common/REQ_parameter-datetime.adoc b/standard/requirements/common/REQ_parameter-datetime.adoc index a14c5e6..0debb5b 100644 --- a/standard/requirements/common/REQ_parameter-datetime.adoc +++ b/standard/requirements/common/REQ_parameter-datetime.adoc @@ -35,7 +35,7 @@ Only features that have a temporal primitive geometry (and temporal primitive va -- [.component,class=part] -- -Temporal primitive geometries (and temporal primitive values) are a half-bounded time interval (i.e., *_(t_s, t_e + updateFrequency]_*). The parameter value SHALL conform to the following syntax (using link:https://tools.ietf.org/html/rfc5234[ABNF]): +Temporal primitive geometries (and temporal primitive values) are a half-bounded time interval (i.e., *_(t_s, t_e + samplingInterval]_*). The parameter value SHALL conform to the following syntax (using link:https://tools.ietf.org/html/rfc5234[ABNF]): [source] interval-bounded = date-time "/" date-time interval-half-bounded-start = [".."] "/" date-time @@ -55,4 +55,4 @@ When a double-dot (`..`) or an empty string is specified in a time interval, the -- If the `datetime` parameter is provided by the client and supported by the server, then only collections whose temporal extent intersects the interval or instant of the `datetime` parameter and collections that do not describe a temporal extent SHALL be part of the result set. -- -==== \ No newline at end of file +====