NetTalk Central

Author Topic: Internal API - I don't want any documentation to show  (Read 790 times)

rjolda

  • Sr. Member
  • ****
  • Posts: 304
    • View Profile
    • Email
Internal API - I don't want any documentation to show
« on: June 09, 2024, 01:13:49 AM »
Hi,
Using NT 14.21  C11.0.136.
I have written an API which is going to reside as part of my secure web server.  It will be used ONLY BY OUR PROGRAM.  It provides useful information ONLY TO OUR Kiosks and never to our users.
I want to suppress the documentation so that the methods and data remain proprietary and undiscoverable.
Can I do this with removing the entries from Documentation tab for Database properties.   i.e. Document Formats:  'XML & JSON & WebEncoded'.   I found the "None" drop for all the documentation.  Will that suffice?
Or is there a better way?
Thanks,
Ron
« Last Edit: June 09, 2024, 01:15:32 AM by rjolda »

Jane

  • Sr. Member
  • ****
  • Posts: 364
  • Expert on nothing with opinions on everything.
    • View Profile
    • Email
Re: Internal API - I don't want any documentation to show
« Reply #1 on: June 09, 2024, 09:09:54 AM »
Try ticking the Private checkbox on the Security tab of the WebServiceMethod you don't want documented.

rjolda

  • Sr. Member
  • ****
  • Posts: 304
    • View Profile
    • Email
Re: Internal API - I don't want any documentation to show
« Reply #2 on: June 10, 2024, 02:26:45 AM »
Thanks Jane
Ron