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

Requiring title, id, description #1317

Closed
777arc opened this issue Aug 26, 2024 · 3 comments
Closed

Requiring title, id, description #1317

777arc opened this issue Aug 26, 2024 · 3 comments
Milestone

Comments

@777arc
Copy link

777arc commented Aug 26, 2024

Just wanted to share some thoughts while I learned about STAC for the first time. I would have expected title to be required and description to be optional. Eg one might not have any description because there might be nothing more to say besides what's already in the required metadata, and it's easily treated as an empty string (if left out) by applications like STAC Index. This also brings up the question if applications that display Collections should use id instead of title as the primary label since title is optional. Looking at STAC Index (first screenshot below) it looks like it uses title (id) as the overall title. Meanwhile in Items, the id is used as the labeled title (see 2nd screenshot), bringing up the question why the title field even exists at all. For folks creating applications around STAC it's nice to have one really clear way things are done.

image

image

Thanks!

@emmanuelmathot
Copy link
Collaborator

The best practises document recommends to always set the title field in order to avoid discrepancies

One further recommendation to help tools is to always include the 'title' field when including a link, especially in the item, child, parent and root links, even if it repeats several times. This should be the same as the 'title' in the link destination. Having this enables clients to display a nice human readable name of the link without having to open the link destination.

In the version 1.x, the title field cannot be mandatory without a breaking change and thus shall be expected for version 2.x also for aligning with OGC features

@777arc
Copy link
Author

777arc commented Aug 26, 2024

Awesome! Will description be mandatory in 2.x?

@m-mohr
Copy link
Collaborator

m-mohr commented Aug 26, 2024

I'd assume that description is still mandatory in 2.x, but it can always be discussed to be optional in 2.x.
Please not thet description can not be empty in the 1.1 and later schemas. We fixed the schemas accordingly as it was an oversight in 1.0 to not require it to be filled in some cases.

Please note that STAC Index is just one implementation and STAC Browser for example handles it differently (title is preferred over id unless there's no title). Also not that there's a difference between Collections/Catalogs and Items. Finding titles for items is often much more difficult in comparison to Collections.

Closing as duplicate of #1300

@m-mohr m-mohr added this to the 2.0 milestone Aug 26, 2024
@m-mohr m-mohr closed this as not planned Won't fix, can't repro, duplicate, stale Aug 26, 2024
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

3 participants