Improve scripts reference docs #1905
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
TBonnin
reviewed
Mar 25, 2024
docs-v2/reference/scripts.mdx
Outdated
| ```js | ||
| const res = await nango.get({ | ||
| endpoint: '/endpoint', | ||
| baseUrlOverride: 'https://base-url.com' |
There was a problem hiding this comment.
why do we mention baseUrlOverride (here and in the example below)? It is a optional param that is defined below. I would keep the example as simple as possible imho
docs-v2/reference/scripts.mdx
Outdated
| </ResponseField> | ||
| </Expandable> | ||
| </ResponseField> | ||
| </Expandable> |
There was a problem hiding this comment.
would it make sense to have a section describing the fields common to all the methods instead of repeating them?
docs-v2/reference/scripts.mdx
Outdated
| </ResponseField> | ||
| <ResponseField name="data" type="unknown"> | ||
| The body of the request. | ||
| </ResponseField> |
There was a problem hiding this comment.
I don't think get has a data field
There was a problem hiding this comment.
If I'm not mistaken, it's not standard but technically possible.
| </ResponseField> | ||
| <ResponseField name="data" type="unkown"> | ||
| The body of the request. | ||
| </ResponseField> |
There was a problem hiding this comment.
same a get. deletedoesn't take a body
khaliqgant
reviewed
Mar 25, 2024
docs-v2/reference/scripts.mdx
Outdated
| <Tip> | ||
| The script helper object shares some methods, but not all, with the [Node backend SDK](/reference/sdks/node), which is why this reference will link to the Node SDK reference a lot. | ||
| Note that all HTTP requests benefit from automatic credential injection. Because scripts are executed in the context of a specific integration & connection, Nango can automatically retrieve & refresh the relevant API credentials. |
There was a problem hiding this comment.
Suggested change
| Note that all HTTP requests benefit from automatic credential injection. Because scripts are executed in the context of a specific integration & connection, Nango can automatically retrieve & refresh the relevant API credentials. | |
| Note that all HTTP requests benefit from automatic credential injection. Because scripts are executed in the context of a specific integration & connection, Nango can automatically retrieve & refresh the relevant API credentials. |
khaliqgant
reviewed
Mar 25, 2024
docs-v2/reference/scripts.mdx
Outdated
|
|
||
| ### Edit connection metadata | ||
|
|
||
| Edit custom metadata for the connection. Only overrides specified properties, not the entire metadata. |
There was a problem hiding this comment.
Is it clear that it overrides and also adds properties potentially?
await nango.updateMetadata({
'CUSTOM_KEY1': 'CUSTOM_VALUE1',
'new-prop': 'new-value
});
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Describe your changes
Issue ticket number and link
Checklist before requesting a review (skip if just adding/editing APIs & templates)