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

Specification mime types #333

Closed
pwalsh opened this issue Dec 11, 2016 · 10 comments
Closed

Specification mime types #333

pwalsh opened this issue Dec 11, 2016 · 10 comments
Assignees
Milestone

Comments

@pwalsh
Copy link
Member

pwalsh commented Dec 11, 2016

Data Package

Commonly implemented as datapackage.json

  • descriptor datapackage
  • default serialisation: .json
  • mime type: application/datapackage+json

JSON Table Schema

Commonly implemented as tableschema.json

  • descriptor tableschema
  • default serialisation: .json
  • mime type: application/tableschema+json

Suggestion: Rename to Table Schema.

Resource

Commonly implemented as dataresource.json

  • descriptor dataresource
  • default serialisation: .json
  • mime type: application/dataresource+json
@pwalsh
Copy link
Member Author

pwalsh commented Dec 11, 2016

Considering these together highlights some important points. So I'm merging in #245 #289 to this issue, and also working on a dataresource.json mime type.

@pwalsh
Copy link
Member Author

pwalsh commented Dec 11, 2016

From #245

@rufuspollock suggested

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

I'm suggesting

The MediaType [RFC4288] for Data Package as JSON SHOULD be application/datapackage+json

There is no need to vendor, and we should make a distinction between the thing (datapackage), and the serialisation of it (json)

@pwalsh
Copy link
Member Author

pwalsh commented Dec 11, 2016

From #289

I'm suggesting

The MediaType [RFC4288] for Table Schema as JSON SHOULD be application/tableschema+json

@pwalsh pwalsh added this to the Version-1 milestone Dec 11, 2016
@rufuspollock
Copy link
Contributor

@pwalsh I'm +1 on all of these.

Is next step is to start the submission process to register these?

@pwalsh
Copy link
Member Author

pwalsh commented Dec 11, 2016

@rufuspollock yes, I started researching it now. I need to understand a few things the form requires before I can submit.

@pwalsh
Copy link
Member Author

pwalsh commented Dec 13, 2016

Registration with IANA happens here and is according to this RFC

@pwalsh
Copy link
Member Author

pwalsh commented Dec 13, 2016

note: all media types will be submitted to the vendor tree - submitting to the standards tree requires a formal publication by a recognised standards body (so, after our RFC to IETF, we could apply for the standards tree).

So:

  • application/vnd.tableschema+json
  • application/vnd.datapackage+json
  • application/vnd.dataresource+json

@pwalsh
Copy link
Member Author

pwalsh commented Dec 13, 2016

The form(s) as submitted:

  • Type name: application
  • Subtype name: vendor tree
  • Required parameters: not applicable.
  • Optional parameters: not applicable.
  • Encoding considerations: 8bit text
  • Security considerations: not applicable.
  • Interoperability considerations: Interoperability is enabled via JSON support in the platform.
  • Published specification: http://specs.frictionlessdata.io/data-packages/ (and the others for each submission)
  • Applications that use this media type: Applications which use this media type handle raw, often text-based data sources, and require additional metadata on those data sources. The payload accompanying this media type is a descriptor for that metadata and data.
  • Fragment identifier considerations: not applicable.
  • Restrictions on Usage
  • Provisional Registrations: not applicable.
  • Additional information: not applicable.
  • Deprecated alias names for this type: not applicable.
  • Magic number(s): not applicable.
  • File extension(s): json
  • Macintosh file type code(s): not applicable.
  • Intended usage: "Common"; To transport data and metadata.
  • Person & email address to contact for further information: Paul Walsh paul.walsh@okfn.org

@pwalsh
Copy link
Member Author

pwalsh commented Dec 13, 2016

Submitted to IANA. Now need to do PR on the specs.

@pwalsh
Copy link
Member Author

pwalsh commented Dec 13, 2016

Closing this issue.

@pwalsh pwalsh closed this as completed Dec 13, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

No branches or pull requests

2 participants