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

CUMULUS-2688: Granule doc updates #321

Merged
merged 3 commits into from
Aug 9, 2022

Conversation

npauzenga
Copy link
Contributor

@npauzenga npauzenga commented Jul 22, 2022

This updates the Granule docs to reflect changes in https://bugs.earthdata.nasa.gov/browse/CUMULUS-2688. The key updates here are modifying all impacted Granule endpoints to fetch granules by both granuleId and collectionId, not just granuleId as before.

These doc updates correspond to the changes made in these PRs:

nasa/cumulus#2978
nasa/cumulus#3000
nasa/cumulus#3022

Notes:

  • This PR targets a new rds-phase-3 branch that should be merged when phase 3 is released.
  • The old method of fetching granules by granuleId alone is still technically available in the API, though deprecated. Users could use e.g. GET /granules/:granuleId. I removed references to this behavior from the docs because we don't want to encourage these lookups after phase 3.

@npauzenga
Copy link
Contributor Author

@jennyhliu what would you think about merging this to the rds-phase-3 branch? We have more work to do on the core side to validate that we support multiple granules with the same granuleId but that would all need to be done before phase-3 and these docs are released I think.

Copy link
Contributor

@jennyhliu jennyhliu left a comment

Choose a reason for hiding this comment

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

Make sure we have the tickets (https://bugs.earthdata.nasa.gov/issues/?jql=labels%20%3D%20RDS_Phase_3) done before merging the rds-phase-3 to master.

@jennyhliu jennyhliu removed the Needs Review Looking for a reviewer label Aug 9, 2022
@npauzenga npauzenga merged commit 0417aec into rds-phase-3 Aug 9, 2022
@npauzenga npauzenga deleted the feature/CUMULUS-2688-granule-doc-updates branch August 9, 2022 14:52
@npauzenga
Copy link
Contributor Author

Added a note to the "Release Phase 3" ticket to also merge the feature branch in the cumulus-api repo: https://bugs.earthdata.nasa.gov/browse/CUMULUS-2987

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