opengeospatial / ogcapi-features

An open standard for querying geospatial information on the web.
https://ogcapi.ogc.org/features
Other
341 stars 85 forks source link

A dedicated section for links #918

Open m-mohr opened 6 months ago

m-mohr commented 6 months ago

I was just looking for a dedicated section that describes the concept (and schema) of a link in OGC API - Feature - Part 1. More specifically, I was looking for the link schema in GeoJSON and the first clickable link to the schema is in 7.10. String internationalization, which is rather weird. The term link is generally used various times throughout the document, but the actual information about links (schemas, relation types, ...) are scattered around.

Examples:

I think it would be gread if there would be a central section that describes the specifics of the links:

It might just be a summary somewhere at the beginning with links to the corresponding sections, but I think a central place that people can link/point to would be good.

Edit: Common has something similar: https://docs.ogc.org/is/19-072/19-072.html#_11b9b4f7-42fc-413a-b63a-e7fb060b5e4b

cportele commented 6 months ago

Good point @m-mohr.

This belongs to clause 7 (not the conventions clause), so we could change the "Link headers" sub-clause to discuss also the other web linking aspects and rename it to "Links".

This should then also be moved forward to appear before the "String internationalization" sub-clause. Since the Landing Page also discusses links it should probably be directly after 7.1 "Overview" and before the "API landing page" sub-clause.

cportele commented 6 months ago

Meeting 2024-05-06: We agreed with the approach. @cportele will work on a pull request.