9. open standardised APIs

[BerkvensNick]

The SoilWise Repository functionality will be offered via open, standardised APIs (e.g. CSW, OGC REST API – Records, WMS, etc.) and a demonstration on how SWR can be used by other Soil Health Mission projects will be performed (e.g. BENCHMARKS and BonaRes already offered their participation). https://github.com/soilwise-he/Soilwise-userstories/issues/23

Origin: D1.3 Repository architecture

• offer SWR functionality via open, standardised APIs: CSW
• offer SWR functionality via open, standardised APIs: OGC REST API
• offer SWR functionality via open, standardised APIs: WMS
• show how SWR can be used by other Soil Health Mission projects (e.g. BENCHMARKS and ISLANDER)

---

With acceptance criteria:

• Offer SWR Functionality via Open, Standardised APIs: CSW
  User Story: As a user, I want to access the SWR functionality using the CSW (Catalog Service for the Web) API so that I can easily search and retrieve metadata about soil health documents.

• API Endpoint Availability: The CSW API endpoint is accessible and returns a successful response for valid requests.

• Metadata Retrieval: The CSW API allows users to retrieve metadata about documents, including title, abstract, keywords, and publication date.

• Search Functionality: Users can perform search queries using various parameters (e.g., keyword, date range, author) and receive relevant results.

• Standard Compliance: The CSW API adheres to the latest OGC CSW specification.

• Response Formats: The API supports multiple response formats (e.g., XML, JSON) as specified in the standard.

• Error Handling: The API provides meaningful error messages and handles invalid requests gracefully.

• Offer SWR Functionality via Open, Standardised APIs: OGC REST API
  User Story: As a user, I want to access the SWR functionality using the OGC REST API so that I can interact with the soil health records in a standardised way.

• API Endpoint Availability: The OGC REST API endpoint is accessible and returns a successful response for valid requests.

• Record Retrieval: The API allows users to retrieve records of soil health documents, including detailed metadata.

• Search Functionality: Users can search for records using various parameters (e.g., spatial extent, time range, keywords) and receive relevant results.

• Standard Compliance: The OGC REST API adheres to the latest OGC API - Records specification (https://ogcapi.ogc.org/records/).

• Response Formats: The API supports responses in JSON format.

• Pagination Support: The API supports pagination to handle large sets of search results.

• Error Handling: The API provides clear error messages and handles invalid requests appropriately.

• Offer SWR Functionality via Open, Standardised APIs: WMS
  User Story: As a user, I want to access the SWR functionality using the WMS (Web Map Service) API so that I can visualise soil health data on a map.

• API Endpoint Availability: The WMS API endpoint is accessible and returns a successful response for valid requests.

• Map Layers: The WMS API provides access to various map layers related to soil health data.

• Layer Retrieval: Users can retrieve and display specific layers of soil health data on a map interface.

• Standard Compliance: The WMS API adheres to the latest OGC WMS specification.

• Image Formats: The API supports multiple image formats for map rendering (e.g., PNG, JPEG).

• GetCapabilities: The API supports the GetCapabilities request to provide metadata about available layers.

• GetMap and GetFeatureInfo: The API supports GetMap and GetFeatureInfo requests to retrieve map images and feature information, respectively.

• Error Handling: The API provides meaningful error messages and handles invalid requests appropriately.

• Show How SWR Can Be Used by Other Soil Health Mission Projects
  User Story: As a project stakeholder, I want to understand how the SWR functionality can be integrated and used by other Soil Health Mission projects (e.g., BENCHMARKS and ISLANDER).

• Integration Documentation: Clear documentation is provided, detailing how to integrate SWR functionality into other projects using the provided APIs (CSW, OGC REST, WMS).

• Use Case Examples: Practical examples and use cases are provided, demonstrating the use of SWR functionality for e.g. BENCHMARKS and ISLANDER projects.

• API Endpoints: Specific API endpoints are highlighted, showing how they can be used to access and retrieve relevant data.

• Technical Support: A support mechanism (e.g., email, forum) is available for projects needing assistance with integration.

• Demonstration: A live or recorded demonstration is available, showcasing the integration process and benefits for Soil Health Mission projects.

• Feedback Loop: A feedback loop is established to gather input from BENCHMARKS and ISLANDER projects to improve the SWR functionality and its integration process.

[KathiSchleidt]

On Offer SWR Functionality via Open, Standardised APIs: OGC REST API, to my understanding, this only pertains to OGC API - Records, not the other OGC APIs (btw - there is no such thing as OGC REST API, just OGC API) - maybe update this point to indicate working on OGC API - Records

Also, Offer SWR Functionality via Open, Standardised APIs: WMS is also a bit misleading. WMS is still one of the old OGC Web Services (OWS), not yet one of the new OGC APIs. There is an OGC API - Maps, but I'm not sure how well that standard is developed at present.