DDS-WEB 1.0 FTF Avatar
  1. OMG Issue

DDSWEB — Inconsistent and incomplete specification of resource representations

  • Key: DDSWEB-14
  • Status: closed  
  • Source: Real-Time Innovations ( Gerardo Pardo-Castellote)
  • Summary:

    Table 5 in Section 8.3.3 lists the resource representations that appear in the bodies of the REST operations and Table 6 specifies the location in the XSD where those representations are defined.
    However the references to the XSD in Table 6 point to the definition of a “type” inside the XSD (for example participantObjectRepresentation points to the xs:complexType named “DomainParticipant”). It would be better if the specification of the representation was done in terms of an XML element (of an XSD-defined type) rather than in terms of the type itself. If the specification is done referencing just the XSD type the resulting definition does not specify an outer XML element name. This is ambiguous and could be interpreted as implying that there is no outer XML element (e.g. the information appears directly inside <body> section of the HTML). If the definition was done using an XSD element, the resource representation would appear inside a single XSD element facilitating parsing and avoiding potentially conflicting interpretations of the specification.
    In addition applicationRepresentation and qosRepresentation appear in webdds_rest1.xsd but are missing from section 8.3.4. They should be added to 8.3.4.
    Also missing is the definition of a list of participantObjectRepresentation and list of typeObjectRepresentation.
    The reference to DDS-XTYPES in Table 6, second row is incorrect. The referenced schema is in webdds_rest1.xsd, not DDS-XTYPES.

  • Reported: DDS-WEB 1.0b1 — Mon, 10 Aug 2015 08:36 GMT
  • Disposition: Resolved — DDS-WEB 1.0
  • Disposition Summary:

    Align section 8.3.4 with the XSD

    Align section 8.3.4 with the XSD. This means:

    • Update Table 5 and changing the “HTTP request and response bodies” column in the places where it says “List of <someObjectRepresentation>” to saying “<someObjectRepresentation>List” this applies to:
      • List of participantObjectRepresentation
      • List of typeObjectRepresentation
      • List of waitsetObjectRepresentation
      • List of registerTypeObjectRepresentation
      • List of topicObjectRepresentation
      • List of publisherObjectRepresentation
      • List of subscriberObjectRepresentation
      • List of datawriterObjectRepresentation
      • List of dataReaderObjectRepresentation
      • List of dataSampleRepresentation, except this should be changed to readSampleList intstead of dataSampleRepresentationList
    • Modify Table 6 adding adding participantObjectRepresentationList, applicationObjectRepresentation, applicationObjectRepresentationList, qosLibraryObjectRepresentation, qosLibraryObjectRepresentationList, qosProfileObjectRepresentation, and qosProfileObjectRepresentationList.
    • Modify Table 6 second column ( “Format for the object representation” ) so the object representation is defined as an XML element based on types in webdds_rest1.xsd rather than defined as an XSD type directly.
  • Updated: Tue, 22 Dec 2015 15:08 GMT
  • Attachments:
    • webdds_table6.docx 19 kB (application/vnd.openxmlformats-officedocument.wordprocessingml.document)