chore: add snap-in version upgrade compatibility doc #147
Conversation
🌟 EkLine ReviewerHello! I’m here to help improve your docs. I’ve reviewed your pull request, and left in-line suggestions for quick fixes. For details, visit the Analytics Page. For questions or feedback, please email [email protected]. |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit
EkLine
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
🚫 [EkLine] reported by reviewdog 🐶
'Snap Kit Actions' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
🚫 [EkLine] reported by reviewdog 🐶
'Snap Components' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
🚫 [EkLine] reported by reviewdog 🐶
'Service Account' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
🚫 [EkLine] reported by reviewdog 🐶
'Inputs (Global Variables)' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
🚫 [EkLine] reported by reviewdog 🐶
'User Level Keyrings' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
🚫 [EkLine] reported by reviewdog 🐶
'User Level Inputs' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
🚫 [EkLine] reported by reviewdog 🐶
'Keyring Types' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
🚫 [EkLine] reported by reviewdog 🐶
'Functions Build Config' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
🚫 [EkLine] reported by reviewdog 🐶
'Configuration Handler' should use sentence-style capitalization. (EK00037)
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
| - Optional connections cannot be made required | ||
| - Required connections can be made optional | ||
|
|
||
| ## Event Sources |
|
Published docs preview URL: https://devrev-preview-ed4bcbd6-fe7a-4023-b558-d28107a84148.docs.buildwithfern.com |
| - Display name can be changed. | ||
| - Type cannot be changed. | ||
| - Connection can be removed but cannot be changed. | ||
| - Source config can be changed (test changes thoroughly). |
| - Full flexibility - can be added, removed, or modified. | ||
| - All properties can be changed. | ||
|
|
||
| ## Snap Kit Actions |
| - All properties can be changed. | ||
|
|
||
| ## Snap Kit Actions | ||
| - Can be removed |
There was a problem hiding this comment.
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
| - Can be removed | |
| - Can be removed. |
| - Description can be changed. | ||
| - Function can be changed. | ||
|
|
||
| ## Snap Components |
| - Function can be changed. | ||
|
|
||
| ## Snap Components | ||
| - Can be removed |
There was a problem hiding this comment.
🚫 [EkLine] reported by reviewdog 🐶
Must put the ending punctuation at the end of a list item. (EK00041)
| - Can be removed | |
| - Can be removed. |
| - Function name can be changed. | ||
| - Loader function cannot be removed once set. | ||
|
|
||
| ## User Level Keyrings |
| - Existing allowed types cannot be removed. | ||
| - Required keyrings can be made optional. | ||
|
|
||
| ## User Level Inputs |
| - Type cannot be changed. | ||
| - All other properties can be modified. | ||
|
|
||
| ## Keyring Types |
| - Keyring type template cannot be changed. | ||
| - OAuth secret ID cannot be changed. | ||
|
|
||
| ## Functions Build Config |
| - Full flexibility - can be added, removed, or modified. | ||
| - All properties can be changed. | ||
|
|
||
| ## Configuration Handler |
|
Published docs preview URL: https://devrev-preview-943d84de-192c-4d91-b468-0ed1cb004513.docs.buildwithfern.com |
| - New keyring types can be added. | ||
| - Existing keyring types cannot be removed. |
There was a problem hiding this comment.
Let's rename it to allowed_connection_types or what is present in the manifest. Keyring Types have a different meaning
| - Required connections can be made optional. | ||
|
|
||
| ## Event Sources | ||
| - New event sources cannot be added. |
There was a problem hiding this comment.
We can add new event sources
| - Loader function cannot be removed once set. | ||
|
|
||
| ## User Level Keyrings | ||
| - New keyrings can be added. |
There was a problem hiding this comment.
We don't allow required user level keyrings
|
|
||
| ## Keyring Types | ||
| - Can be added or removed. | ||
| - For existing keyring types: |
There was a problem hiding this comment.
@SathishKumarHS Please check
There was a problem hiding this comment.
- scope delimiter cannot be changed
- lets add one more,
secret_config cannot be changed
| - Keyring type template cannot be changed. | ||
| - OAuth secret ID cannot be changed. | ||
|
|
||
| ## Functions Build Config |
There was a problem hiding this comment.
Remove this section. Build config is not documented
| - For existing imports: | ||
| - Display name can be changed. | ||
| - Description can be changed. | ||
| - Function cannot be changed. |
| - Function cannot be changed. | ||
| - New allowed keyring types can be added. | ||
| - Existing allowed keyring types cannot be removed. | ||
| - Function name can be changed. |
|
|
||
| ## Service Account | ||
| - Display name can be changed. | ||
| - Description can be changed. |
There was a problem hiding this comment.
We cannot set description from the manifest
There was a problem hiding this comment.
Let's also add that there is no notion for rename. Only Delete and Add.
If someone is renaming event_sources, inputs etc. They will be deleting it and a new one will get created. This will cause loss of values set in the org.
Better way will be to just update the ui.display_name instead
|
@altafDevRev please either complete this PR or close it. |
No description provided.