[OASIS Issue Tracker] Commented: (SRAMP-34) Where did 'Document' go?

[OASIS Issues Tracker <workgroup_mailer@lists.oasis-open.org>]

    [ http://tools.oasis-open.org/issues/browse/SRAMP-34?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=31081#action_31081 ] 

Vincent Brunssen commented on SRAMP-34:
---------------------------------------

After looking in to this issue further, I believe that DocumentArtifactType is sufficient as a top level artifact.  It does extend BaseArtifactType which is the base type for all of the models in S-RAMP, whether they be DocumentArtifact Types or DerivedArtifact Types.  The BaseArtifactType also contains all the information that is referenced above that could be considered common to all Artifact Types.

Below is a snippet from the schema to show the inheritance of BaseArtifactType by DocumentArtifactType.

<!-- Base type for almost all Artifacts in S-RAMP.  Most other types in S-RAMP extend 
  	   this one. Extensions of BaseArtifactType are limited to attributes. -->         
  <xsd:complexType abstract="true" name="BaseArtifactType">
    <xsd:sequence>
      <xsd:element ref="tns:classifiedBy" minOccurs="0" maxOccurs="unbounded"/>
      <xsd:element ref="tns:relationship" minOccurs="0" maxOccurs="unbounded"/>
      <xsd:element ref="tns:property" minOccurs="0" maxOccurs="unbounded" />    
    </xsd:sequence> 
    <xsd:attribute name="name" type="xsd:string" use="required"/>
    <xsd:attribute name="description" type="xsd:string" use="optional"/>
    <xsd:attribute name="createdBy" type="xsd:string" use="required"/>
    <xsd:attribute name="version" type="xsd:string" use="optional"/>
    <xsd:attribute name="uuid" type="xsd:string" use="required"/>
    <xsd:attribute name="createdTimestamp" type="xsd:dateTime" use="required"/>
    <xsd:attribute name="lastModifiedTimestamp" type="xsd:dateTime" use="required"/>
    <xsd:attribute name="lastModifiedBy" type="xsd:string" use="required"/>
	<xsd:anyAttribute namespace="##any"/>
  </xsd:complexType>
  
  <!-- Base type for all Derived Artifacts in S-RAMP -->
  <xsd:complexType abstract="true" name="DerivedArtifactType">
    <xsd:complexContent>
      <xsd:extension base="s-ramp:BaseArtifactType">
      	 <xsd:sequence>
 		 	<xsd:element name="relatedDocument" type="tns:target" minOccurs="1" maxOccurs="1"/> 
      	 </xsd:sequence>
      </xsd:extension>
    </xsd:complexContent>
  </xsd:complexType>
  
  <!-- Base type for all Documents in S-RAMP -->
  <xsd:complexType abstract="true" name="DocumentArtifactType">
    <xsd:complexContent>
      <xsd:extension base="s-ramp:BaseArtifactType">
      	<xsd:attribute name="contentType" type="xsd:string"/>
        <xsd:attribute name="contentSize" type="xsd:long"/>   
        <xsd:anyAttribute namespace="##any"/>
      </xsd:extension>
    </xsd:complexContent>
  </xsd:complexType>


Based on this research I feel like the correct course of action is to leave this as is.  There is no need for a "Document" type.

However, as the issue states, there are references to Document in the Foundation Document and the UML diagrams.  I feel like these should be removed for clarity to matchup with what is in the schema.  As it says in the beginning of the document, the schemas in the appendix are authoritative.  The text from the Foundation Document shown below states this:

When there is a discrepancy between a binding specific document and this Foundation document, the binding specific document always takes precedence.  If there is a discrepancy between schema representations provided in this document and the S-RAMP schemas of record on s-ramp.org, the schemas of record SHALL take precedence.

I further recommend that this issues should be closed as working as designed as the issues of addressing the schemas and making sure the documents correspond with the schema are being addressed in another issue.

> Where did 'Document' go?
> ------------------------
>
>                 Key: SRAMP-34
>                 URL: http://tools.oasis-open.org/issues/browse/SRAMP-34
>             Project: OASIS SOA Repository Artifact Model and Protocol (S-RAMP) TC
>          Issue Type: Task
>          Components: Foundation
>    Affects Versions: 1.0
>            Reporter: Kurt Stam 
>            Assignee: Vincent Brunssen
>             Fix For: 1.0
>
>
> The 'Document' Element is mentioned in the Foundation Document, and in the UML diagrams, but it does not appear in the xsds. In is not clear from the history if Document was removed on purpose or lost in the iterations of generating XSD and UML diagrams.
> It maybe that DocumentArtifactType is a sufficient top level artifact, but there maybe a need to move some content from lower document type up to DocumentArtifactType (contentEncoding).  Or we may need to convert XMLDocument to Document. 

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://tools.oasis-open.org/issues/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira