Expose rest mappings in documentation

[josephjclark]

Every datasource we interact with exposes a REST API. It's fair to expect that developers who know that datasource will be familar with that API.

And almost every adaptor function maps to one or more endpoints in that API.

It would likely be helpful for our docs to expose that mapping. So you want to write job code to to create a new sObject, you'll be expecting to post to salesforce.com/services/data/v60.0/sobjects/whatever. Maybe that URL - or part of it - should be listed in the docs.

Something like this:

We should support an @map jsdoc tag so that adaptor functions can declare the endpoints they map to.

/**
 * @map POST https://{domain}.my.salesforce.com/services/data/v60.0/sobjects/{object}
 */

[josephjclark]

An alternative to this would be to:

• Allow an adaptor to declare a list of arbitrary tags (create, sObject)
• Show tags in the adaptor docs and provide some kind of navigation (filter by tag maybe? Or list by tag?)

I suppose it depends on how focused on the URL might be. Maybe the tags [create] and [sobject] are all you need?