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

Asset schema / Further refine adding additional metadata to the asset definition #289

Closed
m-mohr opened this issue Oct 13, 2018 · 3 comments
Assignees
Milestone

Comments

@m-mohr
Copy link
Collaborator

m-mohr commented Oct 13, 2018

Taken from the old catalog recommendations.

Asset definition

It is of top priority to provide definitions of assets, so clients can know get some information as to
what is actually contained in the data they are downloading. Assets should contain the metadata that is
specific to the format of the asset. The asset must have some way to state its format.

While assets in Catalog APIs can easily represent files that are generated on demand, a static
catalog should only list assets that already exist online. This increases the reliability and speed
of the catalog and makes it easier to fully duplicate or back-up a static catalog.

Note: 0.6.0 defines Media types for assets, to provide more information about what is to download, but there is likely
more work to be done to fully define the asset, so providers should feel free to experiment and give feedback on potential asset improvments.

There are a couple of ideas on how to define metadata for assets. Providers could either

  • include a number of optional metadata fields directly in the asset that would provide additional definition for clients or
  • include a field that specifies a URI to a (JSON) file that has the additional metadata.

When adding the data via a URI, all the needed metadata for a client would be in the product level definition,
which would mean a lot less repeating of fields. But clients would have to be a bit smarter to actually follow the links.
Though ideally clients would be able to cache and reuse product definitions, and hopefully there would be a small number
of canonical product definitions online, that all static catalogs using a particular provider would be able to reference.

@m-mohr m-mohr added the prio: must-have required for release associated with label Oct 13, 2018
@m-mohr m-mohr added this to the 0.7.0 milestone Oct 13, 2018
@mojodna mojodna changed the title Further refine adding additional metadata to the asset defintion Further refine adding additional metadata to the asset definition Oct 19, 2018
@cholmes cholmes modified the milestones: 0.7.0, 0.8.0 Feb 14, 2019
@m-mohr m-mohr changed the title Further refine adding additional metadata to the asset definition Asset schema / Further refine adding additional metadata to the asset definition Apr 10, 2019
@m-mohr
Copy link
Collaborator Author

m-mohr commented Apr 10, 2019

Related to #153

@m-mohr m-mohr added the assets label Jul 22, 2019
@m-mohr m-mohr removed the prio: must-have required for release associated with label Aug 20, 2019
@m-mohr
Copy link
Collaborator Author

m-mohr commented Aug 20, 2019

Do we need to move anything from this old best practices to the new best practices, @cholmes ?

@cholmes
Copy link
Contributor

cholmes commented Aug 20, 2019

Closed with #552

@cholmes cholmes closed this as completed Aug 20, 2019
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

2 participants