Skip to content

docs: updating collection api docs#395

Draft
theodorehreuter wants to merge 2 commits into
masterfrom
tr/cumulus-4639-cmr-provider-update
Draft

docs: updating collection api docs#395
theodorehreuter wants to merge 2 commits into
masterfrom
tr/cumulus-4639-cmr-provider-update

Conversation

@theodorehreuter

Copy link
Copy Markdown

Some new fields were added to collections endpoints - cmrProvider and metricsProvider. This is updating the api docs and examples regarding that.

I also noticed there were other out of date parts of the collection documentation so I also worked to add other more recent missing fields like meta, tags, etc. Also adding a 'required' field to the table.

Comment thread content/collections.md
{
"name": "MOD11A1",
"version": "006",
"dataType": "MOD11A1",

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

this field no longer seems to exist in the data model

Comment thread content/collections.md
"timestamp": 1513020427284,
"createdAt": 1510761441174,
"updatedAt": 1513020427162,
"edpa": true,

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

this field also does not seem to exist anymore in the model

Comment thread content/collections.md
"granuleIdExtraction": "(MOD11A1\\..*)\\.hdf",
"sampleFileName": "MOD11A1.A2017025.h21v00.006.2017034065104.hdf",
"reportToEms": true,
"url_path": "{cmrMetadata.Granule.Collection.ShortName}___{cmrMetadata.Granule.Collection.VersionId}/{substring(file.name, 0, 3)}",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Do we have an example without interpolation? It doesn't matter THAT much but it'd be nice to see the resulting string. We may have some bad examples of this field in Core. I see url_path: https://fakepath.com, which doesn't match the description of this field below. Noting here just to make sure we have a good example in these docs.

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