Uploaded image for project: 'OASIS Topology and Orchestration Specification for Cloud Applications (TOSCA) TC'
  1. OASIS Topology and Orchestration Specification for Cloud Applications (TOSCA) TC
  2. TOSCA-77

Documentation attribute doesn't specify mime-type

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Minor
    • Resolution: Unresolved
    • Affects Version/s: V1.1_CSD01
    • Fix Version/s: V1.1_CSD01
    • Component/s: Spec
    • Labels:
      None
    • Proposal:
      Hide

      At the most simple, consider adding an optional contentType attribute to indicate the type of content so that processors will know how to render it. For example: contentType="text/html" or contentType="text/plain"

      <xs:attribute name="contentType" type="xs:string"/>

      Show
      At the most simple, consider adding an optional contentType attribute to indicate the type of content so that processors will know how to render it. For example: contentType="text/html" or contentType="text/plain" <xs:attribute name="contentType" type="xs:string"/>

      Description

      The documentation element has the following description:

      "All TOSCA elements MAY use the documentation element to provide annnotation for users. The content could be a plain text, HTML, and so on."

      There is no standard way for a processor to know how to interpret / display the documentation. Just directly embedding any kind of content could be problematic for visually rendering the documentation. Or course, it would likely be entity escaped text or have a nested CDATA section if it is HTML, however the processor should be given a clue on the format of the embedded documentation.

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              travis.tripp Travis Tripp (Inactive)
            • Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated: