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

Make datetime nullable for stac items for which a nominal datatime makes no sense #798

Merged
merged 1 commit into from
May 5, 2020

Conversation

m-mohr
Copy link
Collaborator

@m-mohr m-mohr commented May 5, 2020

Related Issue(s): #792

Proposed Changes:

  1. Make datetime nullable for stac items for which a nominal datatime makes no sense, but require start/end_datetime then.

PR Checklist:

  • This PR is made against the dev branch (all proposed changes except releases should be against dev, not master).
  • This PR has no breaking changes.
  • I have added my changes to the CHANGELOG or a CHANGELOG entry is not required.
  • This PR affects the STAC API spec, and I have opened issue/PR #XXX to track the change.

### Date and Time Range
| Field Name | Type | Description |
| ---------- | ------------ | ----------- |
| datetime | string\|null | See the [Item Spec Fields](item-spec.md#properties-object) for more information. |
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I think it's valuable to mention this here so that we have a full overview here. Otherwise you have one field in the Item Spec and all the other here, which is a bit confusing.

Copy link
Contributor

Choose a reason for hiding this comment

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

+1

Copy link
Contributor

@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 good. I think I would like to add a 'best practices' section that discusses datetimes, explaining why it's good to have a nominal date time if possible, and explaining the use cases (zarr, etc) where it doesn't make sense. Plus more encouraging people to define extensions for their data (not just for ones with time ranges), that are more precise with what the datetime means (satellite imagery is acquisition time, mosaics are a representative time for search, and should use start/end, etc) And the implications for servers / clients.

But I can do it in its own PR, this one is the core spec mods we need.

### Date and Time Range
| Field Name | Type | Description |
| ---------- | ------------ | ----------- |
| datetime | string\|null | See the [Item Spec Fields](item-spec.md#properties-object) for more information. |
Copy link
Contributor

Choose a reason for hiding this comment

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

+1

@matthewhanson matthewhanson merged commit 58b3cf9 into dev May 5, 2020
@matthewhanson matthewhanson deleted the nullable-datetime branch May 5, 2020 20:42
This was referenced May 6, 2020
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.

Make datetime nullable for stac items for which a nominal datatime makes no sense
3 participants