lightning icon indicating copy to clipboard operation
lightning copied to clipboard

adaptor-docs: some docs are missing

Open josephjclark opened this issue 1 year ago • 1 comments

Some documentation is missing on the docs panel in the Inspector

For example:

  • kobo 2.2.0 (latest) only shows getForms and does not show getDeploymentInfo or getSubmissions
  • surveyCTO only shows request and not fetchSubmissions
  • salesforce adaptor returns "An error occured"

Image

image

Reported on app.openfn.org by AK

Possible causes

  • We've (I've) just updated the describe-package module which drives adaptor docs. Maybe we (I) broke something?
  • The JSdoc for these functions might need to marked with @public or @operation to be listed in adaptor docs component. That should be easy to figure out if so

josephjclark avatar Apr 23 '24 13:04 josephjclark

I very strongly suspect that the missing functions just need to declare @public

EDIT June 10: No, at least some missing functions are public

josephjclark avatar Apr 23 '24 15:04 josephjclark

Hey @christad92 I think we should bump priority on this and get it fixed. It's something that ought to be on my plate, maybe next week

josephjclark avatar Jun 10 '24 13:06 josephjclark

Mailchimp shows no documentation at all!

josephjclark avatar Jun 25 '24 10:06 josephjclark