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

Proposal: add concestor link relation #378

Closed
wants to merge 2 commits into from

Conversation

philvarner
Copy link
Collaborator

Related Issue(s):

Proposed Changes:

  1. Add concestor link relation to furthest back parent

PR Checklist:

  • This PR has no breaking changes.
  • This PR does not make any changes to the core spec in the stac-spec directory (these are included as a subtree and should be updated directly in radiantearth/stac-spec)
  • I have added my changes to the CHANGELOG or a CHANGELOG entry is not required.

| **rel** | **href** | **From** | **Description** |
| ------------- | ----------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `service-doc` | `/api.html` | OAFeat | A human-consumable service description. The path for this endpoint is only recommended to be `/api.html`, but may be another path. |
The `concestor` link is to the most distant ancestor catalog if this catalog is in a tree of sub-catalogs.
Copy link
Collaborator

@m-mohr m-mohr Jan 30, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure I understand. First of all, concestor I've never heard before but I'm also a non-native spreaker. Assuming I'm somewhat "average", this might not be as ituitive as the other relation types.

Also, from the description below I'm not sure what the difference between root and concestor is. Initially, I'd think that if I follow all parent links I'd get to the root. So this likely needs more explanation.

Would this be a good extension as it seems relatively niche?

PS: There are a lot of unrelated changes in this PR. Is this intentional? Makes the review pretty time-consuming.

@m-mohr
Copy link
Collaborator

m-mohr commented Jan 31, 2023

After the discussion yesterday, I think we were coming from different directions. Assuming we are looking at CMR which has a catalog structure as "real" root and a couple of APIs underneath it.

  1. Point the root to the API landing pages and point concestor to the "real" root
  2. Point the root to the "real" root and something like "parent-api" to the API landing pages

I'm honestly not sure what the initial desire in #239 was, maybe the involved users were actually looking at different use cases, too.
Point 2 feels more logical to me though as calling something root which is not the actual root is confusing. Also I feel it is more explicit. I'd struggle to implement 1 in STAC Browser, I think.

Should APIs that are just "normal" (i.e. root = API landing page) also use "parent-api"? Seems rather repetitive.

@philvarner philvarner changed the title add concestor link relation Proposal: add concestor link relation Feb 11, 2023
@philvarner philvarner marked this pull request as draft February 11, 2023 02:16
@philvarner philvarner closed this Sep 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants