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

updates to browseable #377

Merged
merged 13 commits into from
Feb 12, 2023
Merged

Conversation

philvarner
Copy link
Collaborator

Related Issue(s):

Proposed Changes:

  1. Update description as to what Browseable actually defines on an API
  2. Add diagram of child-item relations
  3. Clarify use cases a bit

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.

Copy link
Collaborator

@cholmes cholmes left a comment

Choose a reason for hiding this comment

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

Looks great, nice updates.

core/README.md Outdated Show resolved Hide resolved
core/README.md Outdated
to advertise that all Items in the Catalog presented by a STAC API may be reached by following `child` and
`item` link relations. In a non-API STAC Catalog, all items must be reachable via these relations to be
considered in the catalog. With a STAC API Catalog, items are considered to be in the catalog if they are
accessible via search operations. However, a STAC API Catalog may also have child and item link relations.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I have a couple of questions:

  • While I like this way of thinking, but what about APIs that don't support item search?
  • Would it in this case mean that all items can be reached via item/child links that are part of STAC API - Features?
  • Should Browsable be used if an API only implements STAC API - Collections and Collection Search and exposes all Collections via child links (but has no items at all)?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

* While I like this way of thinking, but what about APIs that don't support item search?

Good point. I'll clarify this language, since it should be considered in the catalog of it's accessible via link relations or search via /search or /items

* Would it in this case mean that all items can be reached via item/child links that are part of STAC API - Features?

Yes -- I clarified that search includes both /search and /items

* Should Browsable be used if an API only implements STAC API - Collections and Collection Search and exposes all Collections via child links (but has no items at all)?

Yes, I think so. I'm reluctant to add this as an example because it seems like a very uncommon case.

core/README.md Show resolved Hide resolved
1 Outdated Show resolved Hide resolved
@philvarner
Copy link
Collaborator Author

@m-mohr did you have any other issues you wanted addressed, or is this ok to merge?

@philvarner philvarner added this to the 1.0.0-rc.3 milestone Feb 11, 2023
@m-mohr
Copy link
Collaborator

m-mohr commented Feb 11, 2023

The PR itself is good. I have general concerns about this conformance class as part of Core as it's not implemented anywhere yet (afaik). Even the newly mentioned clients like STAC Browser, pystac-client and stac-nb don't implement it, right? I also don't really know how I could implement it in STAC Browser so that it's beneficial for users. Thoughts? What were your ideas when you mentioned it? @philvarner

@philvarner
Copy link
Collaborator Author

I think that's a reasonable concern. I think originally it was part of Core instead of an Extension when all of the extensions were still in this repo, but now that they're separate, I would be in favor of separating it out into an extension that can be versioned and matured independently. This would also align with some of the concerns I have about how much "best practices" text we have in the spec, and this conformance class has a lot of explanatory text for being effectively one sentence of semantics.

Maybe we merge this PR, and then I'll move it to an extension before rc.3?

@m-mohr
Copy link
Collaborator

m-mohr commented Feb 11, 2023

@philvarner Makes sense to me. Go ahead.

@philvarner philvarner merged commit 8357d9f into radiantearth:main Feb 12, 2023
@philvarner philvarner deleted the pv/browseable branch February 12, 2023 16:26
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.

3 participants