tracker issue : CF-3504378

select a category, or use search below
(searches all categories and all time range)
Title:

map displayName or hint attribute of cfargument to <doc> element in WADL

| View in Tracker

Status/Resolution/Reason: To Fix//

Reporter/Name(from Bugbase): No Way / No Way (Janga_Jack)

Created: 02/21/2013

Components: REST Services

Versions: 10.0

Failure Type: Enhancement Request

Found In Build/Fixed In Build: Final /

Priority/Frequency: Trivial / Unknown

Locale/System: English / Platforms All

Vote Count: 0

The WADL for REST service self-description can include a <doc> element in the <param> element of a method's parameter definition. The <doc> element is meant to hold adhoc text describing the parameter which I see is exactly the same as the displayName or hint attributes of cfargument. It would be beneficial if 1 of those attributres mapped to a <doc> element. See the below example:

.cfm
...
<cfargument name="Language" displayname="Specifies the business card's language. en-ca, fr-ca, etc." hint="Must be a valid ISO639 language code." type="string" required="true" 
				   restargname="Language" restargsource="Form"  default="en-us"/>
...


wadl
...
<param name="Language" style="query" type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" default="en-ca">
  <doc>Specifies the business card's language. en-ca, fr-ca, etc. Hint: Must be a valid ISO639 language code.</doc>
</param>
...

----------------------------- Additional Watson Details -----------------------------

Watson Bug ID:	3504378

External Customer Info:
External Company:  
External Customer Name: Janga_Jack
External Customer Email:  
External Test Config: App Language(s)	 English

OS Language(s)	 English

Platform(s)	 Win 2008 Server R2 64 bit

Browser(s)	 Browsers All

Attachments:

Comments: