Skip to content

Interface.md

Latest commit

 

History

History
43 lines (34 loc) · 4.52 KB

Interface.md

File metadata and controls

43 lines (34 loc) · 4.52 KB
Raw

Interface (Accessibility)

Previous | Table of contents | Next

Interfaces allow diversified resources within and across the organization to seamlessly communicate, discover and exchange data. Interfaces are realized in the form of services and follow standards. Interfaces enable data users to have easy and efficient ways of discovering and accessing data and associated services through the exploitation of standard protocols and the harmonizing of search and data retrieval processes

Data Discovery

ID Recommendations
DISC#1 Collection and granule discovery interfaces should comply with the CEOS STAC Collection and Granule Discovery Best Practices (preferred) or CEOS OpenSearch Best Practices.
DISC#2 Service and tool discovery interfaces should comply with CEOS Service Discovery Best Practice.
DISC#3 Collection and granule metadata obtained via the discovery interfaces should advertise the existence of the corresponding file-level online data access and subfile or pixel-based access services and endpoints (e.g., OGC WCS, WMTS, WCPS, OGC API Maps, OGC API Tiles, etc.).
DISC#4 Granule metadata obtained via the discovery interfaces should include the online data access URL to the granule (in full resolution) and to a low resolution representation (i.e., quicklook or thumbnail). The low resolution representation should be provided in Web-friendly format, e.g. JPEG or PNG, and may be a static file or an OGC WMS/WMTS or API Maps/Tiles response.
DISC#5 Discovery interfaces should be accessible and return responses without requiring authentication.
DISC#6 Collection and granule metadata obtained via the discovery interfaces should advertise the existence of the corresponding authentication endpoint for human and machine access to the data (if required).
DISC#7 Resource metadata including keywords should link each keyword to its URI and to the appropriate thesaurus (i.e., controlled vocabularies).
DISC#8 Resource metadata should contain the persistent identifier (e.g., DOI) of the corresponding resource.
DISC#9 Collection metadata should refer to the level of maturity with respect to the WGISS Data Management and Stewardship Maturity Matrix.
DISC#10 For facilitating discovery and access, data shall be organised in collections according to the principles outlined in the WGISS Data Collections Management Practices White Paper.

Data Access

ID Recommendations
DACC#1 Granule data stored in the cloud should be accessible directly via a web-based protocol, for example the S3 (Simple Storage Service) and HTTP(S).
DACC#2 Data access should support file-level access and subfile or pixel-based access. Data download interfaces over HTTPS should support "Range Requests" to allow clients to request a portion of a file. Typical use case: access to a portion of a Cloud-Optimized GeoTIFF (COG) file.
DACC#3 In case a granule consists of many individual assets (files), it shall be possible to access each asset individually and it is recommended to provide access to all subcomponents of a granule with a single request.

Authentication and Authorization

ID Recommendations
AUTH#1 Authorization should be available at a file level for both human and machine-to-machine access.
AUTH#2 Authentication interfaces should comply with open standards, such as the OpenID Connect protocol.
AUTH#3 HTTPS requests for data access that require authorisation will support well known methods for both human and machine-to-machine interface, such as those specified in the OpenAPI 3.0.

Previous | Table of contents | Next