Publication Date: 2021-02-23
Approval Date: 2020-12-14
Submission Date: 2020-11-16
Reference number of this document: OGC 20-091
Reference URL for this document: http://www.opengis.net/doc/PER/OGCAPIFeaturesCommonSprint1
Category: OGC Public Engineering Report
Editor: Gobe Hobona
Title: OGC API – Common and OGC API – Features Sprint 2020: Summary Engineering Report
COPYRIGHT
Copyright © 2021 Open Geospatial Consortium. To obtain additional rights of use, visit http://www.ogc.org/
WARNING
This document is not an OGC Standard. This document is an OGC Public Engineering Report created as a deliverable in an OGC Interoperability Initiative and is not an official position of the OGC membership. It is distributed for review and comment. It is subject to change without notice and may not be referred to as an OGC Standard. Further, any OGC Public Engineering Report should not be referenced as required or mandatory technology in procurements. However, the discussions in this document could very well lead to the definition of an OGC Standard.
LICENSE AGREEMENT
Permission is hereby granted by the Open Geospatial Consortium, ("Licensor"), free of charge and subject to the terms set forth below, to any person obtaining a copy of this Intellectual Property and any associated documentation, to deal in the Intellectual Property without restriction (except as set forth below), including without limitation the rights to implement, use, copy, modify, merge, publish, distribute, and/or sublicense copies of the Intellectual Property, and to permit persons to whom the Intellectual Property is furnished to do so, provided that all copyright notices on the intellectual property are retained intact and that each person to whom the Intellectual Property is furnished agrees to the terms of this Agreement.
If you modify the Intellectual Property, all copies of the modified Intellectual Property must include, in addition to the above copyright notice, a notice that the Intellectual Property includes modifications that have not been approved or adopted by LICENSOR.
THIS LICENSE IS A COPYRIGHT LICENSE ONLY, AND DOES NOT CONVEY ANY RIGHTS UNDER ANY PATENTS THAT MAY BE IN FORCE ANYWHERE IN THE WORLD. THE INTELLECTUAL PROPERTY IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NONINFRINGEMENT OF THIRD PARTY RIGHTS. THE COPYRIGHT HOLDER OR HOLDERS INCLUDED IN THIS NOTICE DO NOT WARRANT THAT THE FUNCTIONS CONTAINED IN THE INTELLECTUAL PROPERTY WILL MEET YOUR REQUIREMENTS OR THAT THE OPERATION OF THE INTELLECTUAL PROPERTY WILL BE UNINTERRUPTED OR ERROR FREE. ANY USE OF THE INTELLECTUAL PROPERTY SHALL BE MADE ENTIRELY AT THE USER’S OWN RISK. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR ANY CONTRIBUTOR OF INTELLECTUAL PROPERTY RIGHTS TO THE INTELLECTUAL PROPERTY BE LIABLE FOR ANY CLAIM, OR ANY DIRECT, SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING FROM ANY ALLEGED INFRINGEMENT OR ANY LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR UNDER ANY OTHER LEGAL THEORY, ARISING OUT OF OR IN CONNECTION WITH THE IMPLEMENTATION, USE, COMMERCIALIZATION OR PERFORMANCE OF THIS INTELLECTUAL PROPERTY.
This license is effective until terminated. You may terminate it at any time by destroying the Intellectual Property together with all copies in any form. The license will also terminate if you fail to comply with any term or condition of this Agreement. Except as provided in the following sentence, no such termination of this license shall require the termination of any third party end-user sublicense to the Intellectual Property which is in force as of the date of notice of such termination. In addition, should the Intellectual Property, or the operation of the Intellectual Property, infringe, or in LICENSOR’s sole opinion be likely to infringe, any patent, copyright, trademark or other right of a third party, you agree that LICENSOR, in its sole discretion, may terminate this license without any compensation or liability to you, your licensees or any other party. You agree upon termination of any kind to destroy or cause to be destroyed the Intellectual Property together with all copies in any form, whether held by you or by any third party.
Except as contained in this notice, the name of LICENSOR or of any other holder of a copyright in all or part of the Intellectual Property shall not be used in advertising or otherwise to promote the sale, use or other dealings in this Intellectual Property without prior written authorization of LICENSOR or such copyright holder. LICENSOR is and shall at all times be the sole entity that may authorize you or any third party to use certification marks, trademarks or other special designations to indicate compliance with any LICENSOR standards or specifications.
This Agreement is governed by the laws of the Commonwealth of Massachusetts. The application to this Agreement of the United Nations Convention on Contracts for the International Sale of Goods is hereby expressly excluded. In the event any provision of this Agreement shall be deemed unenforceable, void or invalid, such provision shall be modified so as to make it valid and enforceable, and as so modified the entire Agreement shall remain in full force and effect. No decision, action or inaction by LICENSOR shall be construed to be a waiver of any rights or remedies available to it.
None of the Intellectual Property or underlying information or technology may be downloaded or otherwise exported or reexported in violation of U.S. export laws and regulations. In addition, you are responsible for complying with any local laws in your jurisdiction which may impact your right to import, export or use the Intellectual Property, and you represent that you have complied with any regulations or registration procedures required by applicable law to make this license enforceable.
1. Subject
The subject of this Engineering Report (ER) is a code sprint that was held from 29 to 30 September 2020 to advance the development of the OGC API - Common - Part 2: Geospatial Data draft standard and the OGC API – Features – Part 4: Simple Transactions draft standard. An Application Programming Interface (API) is a standard set of documented and supported functions and procedures that expose the capabilities or data of an operating system, application or service to other applications (adapted from ISO/IEC TR 13066-2:2016). The code sprint was hosted online. The event was sponsored by Ordnance Survey (OS).
2. Executive Summary
This Engineering Report (ER) summarizes the main achievements of the OGC API – Common and OGC API – Features Sprint, conducted between September 29 – 30, 2020. The sprint served to accelerate development of the OGC API - Common - Part 2: Geospatial Data draft standard and the OGC API – Features – Part 4: Simple Transactions draft standard.
The objectives of the code sprint were to:
-
Develop prototype implementations of OGC API – Common – Part 2: Geospatial Data
-
Develop prototype implementations of OGC API – Features – Part 4: Simple Transactions
-
Test the prototype implementations
-
Provide feedback to the Editor about what worked and what did not work
-
Provide feedback about the specification document, especially what is missing from the document
Part of the motivation for holding the sprint was:
-
APIs are a popular, effective method for rapid software development
-
There is an increasing need for interoperability between Web APIs
-
The growing uptake of location within and outside of geospatial developer communities
The OGC API - Common - Part 2: Collections draft standard provides a common connection between the API landing page and resource-specific details. That connection includes metadata that describes the collections of hosted resources, common parameters for selecting subsets of those collections, and URI templates for identifying the above. This common connection is sufficient to start the client down the path to resource discovery.
OGC API - Features is a multipart standard that provides API building blocks for creating, modifying, and querying geospatial features over the Web. The OGC API – Features – Part 4: Simple Transactions draft standard extends the core capabilities specified in the approved Part 1 standard with the ability to add, replace, modify, and/or delete individual feature instances from a single feature collection. The sprint produced very valuable results. Participants identified areas for improving the draft standards, allowing the editors of the draft standards to record their recommendations. The editors are expected to discuss the feedback from the sprint participants with the Standards Working Group (SWG).
2.1. Document contributor contact points
All questions regarding this document should be directed to the editor or the contributors:
Contacts
Name | Organization | Role |
---|---|---|
Gobe Hobona |
OGC |
Editor |
2.2. Foreword
Attention is drawn to the possibility that some of the elements of this document may be the subject of patent rights. The Open Geospatial Consortium shall not be held responsible for identifying any or all such patent rights.
Recipients of this document are requested to submit, with their comments, notification of any relevant patent claims or other intellectual property rights of which they may be aware that might be infringed by any implementation of the standard set forth in this document, and to provide supporting documentation.
3. References
The following normative documents are referenced in this document.
-
OGC: OGC 17-069r3, OGC API - Features - Part 1: Core 1.0 (2019)
-
OGC: OGC 20-002, OGC API - Features - Part 4: Simple Transactions candidate standard
-
OGC: OGC 19-072, OGC API - Common - Part 1: Core candidate standard
-
OGC: OGC 20-024, OGC API - Common - Part 2: Geospatial Data candidate standard
-
IETF: RFC-7946 The GeoJSON Format (2016)
4. Terms and definitions
For the purposes of this report, the definitions specified in Clause 4 of the OWS Common Implementation Standard OGC 06-121r9 shall apply. In addition, the following terms and definitions apply.
- ● coordinate reference system
-
coordinate system that is related to the real world by a datum term name (source: ISO 19111)
- ● feature
-
abstraction of real world phenomena [ISO 19101-1:2014]
Note
|
For those unfamiliar with the term 'feature', the explanations on Spatial Things, Features and Geometry in the W3C/OGC Spatial Data on the Web Best Practice document provide more detail. |
- ● OpenAPI Document
-
A document (or set of documents) that defines or describes an API. An OpenAPI definition uses and conforms to the OpenAPI Specification (https://www.openapis.org)
- ● Web API
-
API using an architectural style that is founded on the technologies of the Web [source: OGC API - Features - Part 1: Core]
Note
|
See Best Practice 24: Use Web Standards as the foundation of APIs (W3C Data on the Web Best Practices) for more detail. |
5. Introduction
This Engineering Report (ER) summarizes the main achievements of the OGC API – Common and OGC API – Features Sprint, conducted from 29 to 30 September 2020. The sprint had been organized to advance the development of the OGC API - Common - Part 2: Geospatial Data draft standard and the OGC API – Features – Part 4: Simple Transactions draft standard. Sprint participants prototyped implementations of the draft standards, validating the requirements and providing feedback so that the draft standards could be improved.
An OGC Code Sprint is a collaborative and inclusive event driven by innovative and rapid programming with minimal process and organization constraints to support the development of new applications and open standards. OGC Code Sprints experiment with emerging ideas in the context of geospatial standards, help improve interoperability of existing standards by experimenting with new extensions or profiles, and are used as a proof of concept for other OGC Innovation Program initiatives, or support OGC Standards Program activities.
This code sprint was held as part of a series in the third quarter of 2020. The other code sprints included:
-
OGC API – Maps Sprint held July 28th to 29th, 2020. This sprint focused on the OGC API - Maps - Part 1: Core draft standard which defines a Web API for publishing and accessing digital maps.
-
OGC API – Coverages Sprint held August 10th to 11th, 2020. This sprint focused on the OGC API - Coverages - Part 1: Core draft standard which defines a Web API for publishing and accessing coverage data.
5.1. Participants
Software developers and solutions architects from the following organizations registered to participate in the code sprint:
-
Azavea
-
Bezirksregierung Köln - Geobasis NRW
-
Camptocamp
-
Cognitics, Inc
-
CubeWerx Inc.
-
Ecere Corporation
-
Element 84
-
EOX IT Services GmbH
-
Esri
-
Geobeyond
-
Geosolutions Consulting
-
Giscorps
-
Global Nomad GIS Services
-
Heazeltech
-
Hxart
-
ICEYE
-
IIT Bombay
-
Image Matters LLC
-
Indian Institute of Technology, Bombay
-
interactive instruments GmbH
-
ISRIC - World Soil Information
-
Kitware Inc.
-
lat/lon GmbH
-
Met Office
-
Meteorological Service of Canada
-
NOAA/NOS/NGS
-
Ordnance Survey
-
Polaris Digitech Limited
-
Princeton University
-
Secure Dimensions
-
Texas A&M University
-
UAB-CREAF
-
Uppsala university
-
US Army Geospatial Center
-
virtru
-
Wuhan University
5.2. OGC API – Common – Part 2: Geospatial Data draft standard
Geospatial data is seldom considered as a single entity. Feature Collections, Coverages, Data Sets are typically considered as aggregations of Spatial or Temporal Things. A web API conforming to OGC API standards therefore should be able to expose its holdings as aggregates of spatial resources.
The purpose of the OGC API - Common - Part 2: Geospatial Data draft standard is to provide a common connection between the API landing page and resource-specific details. That connection includes metadata which describes the hosted geospatial resources, common parameters for selecting subsets of those resources, and URI templates for identifying the above.
This draft standard specifies the following conformance classes:
-
The Collections conformance class specifies the requirements necessary to discover and understand a generic collection and its contents.
-
The HTML conformance class describes how to represent collections of geospatial data in HTML encoding.
-
The JSON conformance class describes how to represent collections of geospatial data in JSON encoding.
5.3. OGC API – Features – Part 4: Simple Features draft standard
The OGC API – Features – Part 4: Simple Features draft standard specifies an extension to OGC API – Features that defines the behavior of a server that supports simple transactions. Simple transactions are transactions that add, replace, modify or delete individual resources from a single collection.
Specifically, OGC API – Features – Part 4: Simple Features describes:
-
How to add a new resource instance to a collection.
-
How to modify an existing resource from a collection; this includes entirely replacing the existing resource or simply modifying one or more parts of a resource.
-
How to remove an existing resource from a collection.
This draft standard covers the following conformance classes:
-
The Simple Transactions conformance class provides the ability to add, replace and remove individual resources from a collection.
-
The PATCH Updates conformance class provides the ability to use the HTTP PATCH method to modify parts of an existing resource without the need to transmit a complete replacement resource.
-
The Features conformance class describes requirements for the case when the resource type is a feature.
6. High-Level Architecture
The focus of the sprint was on support of the development of the OGC API - Common - Part 2: Geospatial Data draft standard and the OGC API – Features – Part 4: Simple Transactions draft standard. Implementations of these draft standards were deployed in participants’ own infrastructure in order to build a solution with the architecture shown below in Figure 1.
A detailed view of the security aspects of the sprint architecture is shown in Figure 2. This aspect of the sprint architecture partly addressed the observation made in Testbed-14 that there was a lack of a component that could utilize OpenAPI and capabilities documents, combined with a catalog of service references to completely automate the acquisition of user tokens and their use on workflows [1].
As illustrated the sprint architecture was designed with the view of allowing client applications to connect to different servers that implement OGC API - Features and OGC API - Common. The servers were provisioned with vector feature data, some of which was from the OS Open Zoomstack data product. The client applications were then configured to submit create, update and delete requests to the servers.
7. Results
Multiple organizations provided servers, API implementations, and capabilities during the event. The rest of this section describes each of the implementations.
The Centre for Ecological Research and Forestry Applications (CREAF) at the Autonomous University of Barcelona (UAB) deployed an instance of the MiraMon Map Server that implements support for multiple OGC API standard. The server is implemented as a CGI application encoded in C language as a part of the MiraMon Geographic Information System (GIS) & Remote Sensing (RS) suite and is interoperable with other vendors’ clients. During the sprint, the CREAF team was able to modify the client application to enable it to support security schemes offered by OpenAPI and supported by OGC API – Features – Part 4: Simple Transactions. A screenshot of the user interface is shown in Figure 3.