Add 5 new formats: CDF, FITS, ASDF, Zarr, and GPX#46
Conversation
Added GPX, CDF, FITS, ASDF, and Zarr. Those without registered MIME types were added with the mediaType fields left blank (GPX, ASDF, and Zarr).
updating MIME types based on discussions on the open issues.
mbjones
left a comment
mbjones
left a comment
There was a problem hiding this comment.
This looks great! Thanks @rebeccaringuette so much. A few things we should consider and changes to be made. See my inline code comments too:
- We need to update the total object count in the root element
<d1v2:objectFormatList count="155" start="0" total="155"to a count of 160 - For the
x-*mime types, I like your choices of mime type andformatId. But for the FITS standard, because the MIME type is an accepted and registered type (application/fits), we generally try to use that as theformatIdas well. How does that sound? - Can you cluster all of the new formats at the end, as we have been just appending them in the past in chronological order.
| <extension>xml</extension> | ||
| </objectFormat> | ||
| <objectFormat> | ||
| <formatId>CDF</formatId> |
There was a problem hiding this comment.
is application/x-cdf well-enough established to make a good formatId as well? see general comments in review.
There was a problem hiding this comment.
It'd be more useful if the formatID could stay as CDF for user-friendliness when this gets plugged into Zenodo.
There was a problem hiding this comment.
@datadavev thoughts on this decision? In the past we;ve tried to use the mime type when it makes sense (e.g., text/csv) and left the human-readable name to the formatName field.
In general, @rebeccaringuette , I think UIs should be using formatName in displays and formatId as the unique identifier of the format.
There was a problem hiding this comment.
Oh yeah, that makes sense. I'll change it for CDF and FITS.
| <formatName>Common Data Format (CDF)</formatName> | ||
| <formatType>DATA</formatType> | ||
| <mediaType name="application/x-cdf"/> | ||
| <extension>ncdf</extension> |
There was a problem hiding this comment.
is this the correct extension, or is it cdf?
There was a problem hiding this comment.
no, cdf is correct. Typo fixed.
| <extension>xml</extension> | ||
| </objectFormat> | ||
| <objectFormat> | ||
| <formatId>FITS</formatId> |
There was a problem hiding this comment.
I suggest this formatId should be application/fits. See review comments.
There was a problem hiding this comment.
I am expecting Zenodo to use the formatID as the item in the drop down list. It would be more user-friendly if the formatID could stay as FITS. Will that work?
There was a problem hiding this comment.
same discussion as above -- maybe Zenodo can/should use formatName for display? Let's see what Dave and others pitch in...
| <extension>nc</extension> | ||
| </objectFormat> | ||
| <objectFormat> | ||
| <formatId>Zarr</formatId> |
There was a problem hiding this comment.
Is application/x-zarr well-enough established to use it as the formatId?
There was a problem hiding this comment.
No, they are still debating this, but also see response on the FITS formatID.
| <extension>zarr</extension> | ||
| </objectFormat> | ||
| <objectFormat> | ||
| <formatId>GPX-1.1</formatId> |
There was a problem hiding this comment.
Is the 1.1 version of GPX not self-describing? Can we generalize this to GPX? Generally its better to only have one formatId if it suffices across versions. @iannesbitt thoughts?
There was a problem hiding this comment.
I have no idea on this one. I have never heard of a GPX file before.
There was a problem hiding this comment.
@iannesbitt can you weigh in on this GPX question please?
There was a problem hiding this comment.
I do need these new items included before February for Zenodo to build with. If including the GPX term will delay this, then I (or you) could remove it easily and proceed. Github's notification emails for this thread aren't being sent to me anymore, but I will check again in January. Thanks.
There was a problem hiding this comment.
@mbjones @rebeccaringuette Sorry for the delay, I didn't get a notification for this for some reason. Yes, GPX files are self-describing. I think we should go ahead with generalizing in this case. The formatId should be GPX and not GPX-1.1.
There was a problem hiding this comment.
Got it. I updated the formatID and name to remove the 1.1. Is this ready?
There was a problem hiding this comment.
@rebeccaringuette yes, that looks correct! Thanks
|
Items 1 and 3 done, comments left on item 2. |
addressed items 1 and 3.
updating the formatID for CDF and FITS to be the MIME type
updating the GPX details per feedback
Modify the name for ASDF to remove the commentary. Modify the formatId for GPX to use the mime type. Merged PR #46 into develop from @rebeccaringuette.
|
@rebeccaringuette I merged your PR into the
You can see the final proposed changes in the develop branch objectFormatListV2.xml |
3 participants
See issues #41, #42, #43, #44, and #45 for discussion of the new formats, particularly the MIME mediaTypes.