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

Required root links #340

Closed
m-mohr opened this issue Oct 12, 2022 · 3 comments
Closed

Required root links #340

m-mohr opened this issue Oct 12, 2022 · 3 comments
Assignees
Milestone

Comments

@m-mohr
Copy link
Collaborator

m-mohr commented Oct 12, 2022

I wasn't aware of the requirement that self and root are required for some endpoints (e.g. /collections).

@philvarner has shown that self is required by OAFeat, which is fine. But root itself seems only required by some endpoints which seems inconsistent.

For example, /search doesn't seem to require it. Static STAC also doesn't require it. OAFeat also doesn't require it in /collections. I'm wondering whether it should be more consistent and only be recommended in all endpoints?

More an issue for discussion rather than a request for change. I'm not sure either yet, but would like to see this being somewhat consistent.

Started by @m-mohr in #331 (comment)

@m-mohr m-mohr changed the title I wasn't aware of this requirement and I can't find it in OAFeat. Why do we require it? Required root links Oct 12, 2022
@philvarner
Copy link
Collaborator

My understanding was that root was always required. I think it is an oversight that it's not required by all conformance classes. For a HATEOAS style of web API, I think always having a link back to the root is important.

@philvarner philvarner added this to the 1.0.0-rc.3 milestone Oct 26, 2022
@philvarner philvarner self-assigned this Jan 17, 2023
@philvarner
Copy link
Collaborator

Current status of this is:

  • Core requires it on the landing page
  • Features (and thereby Collections) requires it for all endpoint responses require root
  • Item Search does not list is as a link rel, but the example has it. Planetary Computer (stac-fastapi) has it, Earth Search (stac-server) does not (but I will add it in the next release!).

I would be in favor of adding this to Item Search.

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

No branches or pull requests

2 participants