Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

A dedicated section for links #918

Open
m-mohr opened this issue May 2, 2024 · 2 comments
Open

A dedicated section for links #918

m-mohr opened this issue May 2, 2024 · 2 comments
Assignees
Labels
Part 1: Core Issue related to Part 1 - Core

Comments

@m-mohr
Copy link
Contributor

m-mohr commented May 2, 2024

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:

  • RFC 8288 dependency
  • Schemas for the encodings
  • Use of relation types
  • etc.

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 cportele added the Part 1: Core Issue related to Part 1 - Core label May 2, 2024
@cportele cportele added this to Backlog in Part 1: Core via automation May 2, 2024
@cportele cportele added this to the Part 1, Version 1.1.0 milestone May 2, 2024
@cportele cportele self-assigned this May 2, 2024
@cportele
Copy link
Member

cportele commented May 2, 2024

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
Copy link
Member

cportele commented May 6, 2024

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

@cportele cportele moved this from Backlog to To be drafted in Part 1: Core May 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Part 1: Core Issue related to Part 1 - Core
Projects
Part 1: Core
  
To be drafted
Development

No branches or pull requests

2 participants