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

Mimetype for datapackage.json #245

Closed
rufuspollock opened this issue Feb 21, 2016 · 13 comments
Closed

Mimetype for datapackage.json #245

rufuspollock opened this issue Feb 21, 2016 · 13 comments
Assignees
Milestone

Comments

@rufuspollock
Copy link
Contributor

@rufuspollock rufuspollock commented Feb 21, 2016

Propose to add a section "MediaType and File Extensions" to Data Package spec containing the following:

The MediaType [RFC4288] for Data Package JSON SHOULD be application/x-datapackage.

We could look also to register an official mimetype e.g.

 application/datapackage

/cc @rossjones

@rossjones
Copy link

@rossjones rossjones commented Feb 22, 2016

Sounds good, and would definitely be useful for discovery. I guess if we use think in a link rel, dpm (and other tools) could point directly at the (for instance) dataset page and find the link to the package.

@amercader
Copy link
Member

@amercader amercader commented Feb 22, 2016

Is this referring to just the datapackage.json file (eg is that what the rel links would point to)? If it's the Media type for the JSON file then it probably makes more sense to use a JSON vendor media type, eg:

application/vnd.datapackage+json

If it's a zip or some other resource, then a custom one would make sense, but note that x. or x- media types are frown upon.

@rossjones
Copy link

@rossjones rossjones commented Feb 22, 2016

@amercader You're right, vnd is probably more appropriate until its registered, but I'd hope that would be quick enough that it wasn't a major problem :)

Edit: Just to clarify, I'm not overly keen on vnd media types because I think the +json is unnecessary. You need to discover what vnd.datapackage is anyway to make use of it, so that +json is a bit superfluous to requirements, but I guess the world has moved on since x-something was enough.

@pwalsh
Copy link
Member

@pwalsh pwalsh commented Mar 7, 2016

+1 for @amercader

@rufuspollock
Copy link
Contributor Author

@rufuspollock rufuspollock commented Mar 7, 2016

OK, so i guess the new proposal is:

The MediaType [RFC4288] for Data Package JSON SHOULD be application/vnd.datapackage

Question: do we add the +json. My sense is that you are not always pointing to the datapackage.json itself (e.g. you may be pointing to the directory etc). Given this we can't always add the +json - but should we add an extra line like:

If you are pointing directly to the datapackage.json file then you may add +json

application/vnd.datapackage+json

Final comments please and then this will go in :-)

@pwalsh
Copy link
Member

@pwalsh pwalsh commented Mar 7, 2016

@rgrp LGTM

@rossjones
Copy link

@rossjones rossjones commented Mar 7, 2016

@rgrp am ambivalent about +json but otherwise looks good.

@rufuspollock
Copy link
Contributor Author

@rufuspollock rufuspollock commented Mar 8, 2016

OK, the change has gone in to the spec.

Final step before closing is to register this with IANA as per https://tools.ietf.org/html/rfc6838#section-3.2 - @danfowler can you look into what is required here.

@rufuspollock
Copy link
Contributor Author

@rufuspollock rufuspollock commented Apr 19, 2016

@danfowler can you please update here on your research (if any) 😄

@pwalsh
Copy link
Member

@pwalsh pwalsh commented Jul 12, 2016

@danfowler could you please report here any findings

@roll roll added the backlog label Aug 8, 2016
@roll roll removed the backlog label Aug 29, 2016
@danfowler
Copy link
Contributor

@danfowler danfowler commented Sep 7, 2016

Here's our form: http://www.iana.org/form/media-types

Also relevant to: #289

@rufuspollock rufuspollock added this to the Current milestone Sep 27, 2016
@rufuspollock
Copy link
Contributor Author

@rufuspollock rufuspollock commented Sep 27, 2016

@danfowler can you prep the info for a submission and we review.

@pwalsh pwalsh changed the title Mimetype for Data Packages Mimetype for datapackage.json Dec 11, 2016
@pwalsh
Copy link
Member

@pwalsh pwalsh commented Dec 11, 2016

DUPLICATE (now). Closing in favour of #333 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
6 participants