NetTalk Central

NetTalk Web Server => Web Server - Ask For Help => Topic started by: astahl on December 23, 2015, 04:14:53 AM

Title: WebServices Feature Request
Post by: astahl on December 23, 2015, 04:14:53 AM

Hi Bruce,

When one uses a field, group, queue, or any other supported structure could you make it use the description line as documentation for an individual field?

So when you look at the Service, the parameters list would show the description for the individual parameter.

Field1 (int)  BOOL, True or False
Field2 (string) 32 characters Required
Field3 (int) This field is a decimal with 3 places after the decimal point. Format <#.### example 1.500

This would really help people understand what your service is expecting to see.
Right now one has to hand hold the programmer on what you are expecting to receive.

Thanks Bruce and Merry Christmas!!!

Ashley

Title: Re: WebServices Feature Request
Post by: Bruce on December 28, 2015, 11:11:25 PM

Hi Ashley,

Unfortunately that's not as easy as it sounds because the help is constructed at runtime, not compile time. In other words the structures are interrogated by the program at runtime - those lines are not just lines in your code being added at generate time. The Description is not available at runtime, only generate time, so there would be quite a big change there.

I'll leave it on the list of desirables, but it wouldn't be done in NT8, only NT9.

cheers
Bruce

Title: Re: WebServices Feature Request
Post by: astahl on December 29, 2015, 06:12:23 AM

Understood and thanks for keeping it on a wish list.

Ashley