search

alps-io / spec

ALPS Specification documents.
59 stars 13 forks source link

Use contentType and contentEncoding to specify doc element content and encoding #91

Closed filip26 closed 3 years ago

filip26 commented 3 years ago

A motivation is to let a user choose any 'doc' content (including non-text).

e.g.

<doc contentType="application/xml" (contentEncoding="text")?><![CDATA[
...
]]></doc>
"doc": {
   "contentType": "text/markdown",
   "contentEncoding": "text"
   "value": "...."
}
"doc": {
  "contentType": "application/pdf",
  "contentEncoding": "base64",
  "value": "dG....VzdA=="
}

This change implicates deprecation of the 'format' on 'doc' element.

mamund commented 3 years ago

@filip26

can you prepare some remarks for an upcoming AOOH to help us discuss/decide this one?

mamund commented 3 years ago

add contentType if value is not understood, assume contentType="text/plain"

we'll skipp contentEncoding for now

just on the DOC element.

mamund commented 3 years ago

issue closed.

start a new issue for contentEncoding if/when ready.