Re: [sca-assembly] ISSUE 49: Add an optional description attributeto promoted properties, references and services

[Anish Karmarkar <Anish.Karmarkar@oracle.com>]

I think such description is potentially useful for all the SCA elements.
Proposal:
Create a base type for all the SCA types. Such a base type may look like 
this:

<complexType name="SCABaseType" abstract="true">
   <sequence>
     <element name="documentation" minOccurs="0" />
   </sequence>
</complexType>

-Anish
--

Scott Vorthmann wrote:
> 
> http://www.osoa.org/jira/browse/ASSEMBLY-49
> 
> On Feb 13, 2008, at 3:08 AM, Mark Combellack wrote:
> 
>> RAISER:           Mark Combellack
>>
>> TARGET:          SCA Assembly Specification
>>
>> DESCRIPTION:
>>
>> It is currently envisioned that an Application Assembler can take a 
>> Composite written by another person and use it in their own 
>> applications. Often these “3rdparty” Composites will have promoted 
>> Properties and References that will need to be set by the Application 
>> Assembler. From the SCDL, the Application Assembler has only the name 
>> of the promoted Properties and References to document what they do.
>>
>> What is missing is the ability for the Composite Developer to add a 
>> short description to promoted Properties and References that would 
>> inform the Application Assembler what they are for.
>>
>> It may also be desirable to add a description to promoted Services as 
>> well.
>>
>> PROPOSAL:
>>
>> Add an optional “description” attribute to Property, Reference and 
>> Service that would allow the Composite Developer to write a brief 
>> description of them.
>>
> 
> 
> ---------------------------------------------------------------------
> To unsubscribe from this mail list, you must leave the OASIS TC that
> generates this mail.  You may a link to this group and all your TCs in 
> OASIS
> at:
> https://www.oasis-open.org/apps/org/workgroup/portal/my_workgroups.php