Update salesforce jsdocs
#799
Conversation
|
@mtuchi Please make angry noises at me if this isn't done tomorrow morning |
|
@mtuchi is this targeted at main? I expected this to be part of the next salesforce stuff, branching from |
There was a problem hiding this comment.
Yeah @mtuchi unfortunately these docs are against the wrong branch. You have examples of state.references, but we're about to remove that stuff.
This needs to be be retargeted and mapped to the epic
I've left a couple of high level comments which will need to be taken into account
| * { pollTimeout: 10000, pollInterval: 6000 } | ||
| * ); | ||
| * @example <caption>Perform a bulk query on Patient records</caption> | ||
| * bulkQuery('SELECT Id, Name FROM Patient__c'); |
There was a problem hiding this comment.
These examples don't use any dynamic state. We should make sure there's at least one example which uses state (or lazy state)
| * retrieve('ContentVersion', '0684K0000020Au7QAE/VersionData'); | ||
| * @example <caption>Retrieve a specific ContentVersion record</caption> | ||
| * retrieve('ContentVersion', '0684K0000020Au7QAE', state => { | ||
| * console.log(state.references[0]); // Log the retrieved record |
There was a problem hiding this comment.
Is the comment here useful? console.log() is a pretty easy to understand function
| * attr1: "foo", | ||
| * attr2: "bar" | ||
| * }) | ||
| * @example <caption>Create a new record if `state.isNew` is true</caption> |
There was a problem hiding this comment.
Let's not add new examples for deprecated APIs please
|
Sorry @josephjclark i wasn't able to work on change request this week, I will pick this up next week. I only manage to resolved git conflicts on #691 |
|
Closing this in favor of #821 |
Summary
Update params docs and improve examples in salesforce adaptor
Fixes #664
AI Usage
Please disclose how you've used AI in this work (it's cool, we just want to know!):
You can read more details in our Responsible AI Policy
Review Checklist
Before merging, the reviewer should check the following items:
dev only changes don't need a changeset.