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

[Proposal] Consolidate the attributes of document and asset elements in the manifest.xml #9

Open
ghost opened this issue Aug 6, 2018 · 0 comments

Comments

@ghost
Copy link

ghost commented Aug 6, 2018

Hello,

the attributes of the <document /> and <asset /> elements in the manifest.xml file should be consolidated.

Attributes in the Spec

Right now in the specs I find traces of the following attributes:

  • id: The id of the asset/document
  • mime-type: The mime type of the asset/document
  • name: The name of the asset/document
  • path: The path of the asset/document relative to the Dar it pertains to
  • type: The (structural) type the asset/resource represents

Attributes in the dar-server responses

Furthermore, the dar-server in it's response format returns other attributes describing a resource which in my opinion might also be worthwile to add to the set of allowed attributes for the <document /> and <asset /> elements:

  • encoding: The encoding of the asset/document
  • size: The size of the asset/document in Bytes(?)
  • createdAt: The date an asset/document has been created
  • updatedAt: The date an asset/document has been updated

mime-type and type

I would have three proposals regarding these two attributes:

Make the mime-type attribute mandatory for all <asset /> and <document /> elements since it might be helpful on the backend-side when it comes to serializing/deserializing a resource. Right now this doesn't seem to be the case.

Be strict regarding the allowed values of these two attributes. With regards to the mime-type attribute this shouldn't be a problem since the values are already defined and standardized (see here). Regarding the values of the type attribute I'm pretty sure that there is exists some sort of controlled vocabulary relating to document types.

Change the attribute name mime-type to media-type as this seems to be the standard now.

[RFC2046] specifies that Media Types (formerly known as MIME types) and Media
Subtypes will be assigned and listed by the IANA.

Source

@ghost ghost changed the title [Proposal] Consolidate the attributes of <document/> and <asset/> element in the manifest.xml [Proposal] Consolidate the attributes of document and asset elements in the manifest.xml Aug 6, 2018
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

0 participants