NetTalk Central

Author Topic: WebServiceMethod and generated API documentation  (Read 4051 times)

frode

  • Newbie
  • *
  • Posts: 14
    • View Profile
    • Email
WebServiceMethod and generated API documentation
« on: November 26, 2019, 10:15:32 PM »
Hi all,

Sending group or queue as parameters to a web service method the generated api documentation
inculdes the description on the fields part of the the queue or group.
Is there an option for adding additional descriptions for fields in tables when used as parameter ?

regards,
Frode

Bruce

  • Global Moderator
  • Hero Member
  • *****
  • Posts: 11250
    • View Profile
Re: WebServiceMethod and generated API documentation
« Reply #1 on: November 27, 2019, 04:46:21 AM »
I think it takes the description from the dictionary. However in the future you may be able to add local field-level docs as well.

CaseyR

  • Sr. Member
  • ****
  • Posts: 448
    • View Profile
    • Email
Re: WebServiceMethod and generated API documentation
« Reply #2 on: March 18, 2020, 10:19:19 AM »
Hi, Bruce

As of 11.30, view and table returns do not take descriptions from the dictionary. The field documentation is limited to the data type.

Bruce

  • Global Moderator
  • Hero Member
  • *****
  • Posts: 11250
    • View Profile
Re: WebServiceMethod and generated API documentation
« Reply #3 on: April 06, 2020, 02:33:47 AM »
noted.