fix: Add trigger message details documentation #1398
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
doubleface
requested review from
Crash--,
Merkur39 and
paultranvan
as code owners
6 tasks
|
@Crash-- @paultranvan @Merkur39 Can I have a review for this please ? |
Crash--
reviewed
Oct 10, 2023
packages/cozy-client/src/types.js
Outdated
| @@ -75,6 +75,10 @@ import { QueryDefinition } from './queries/dsl' | |||
| * @property {String} type - type of the trigger. Can be "at", "cron", "event", "every", "in", "webhook", "client" | |||
| * @property {String} worker - type of worker. Can be "konnector" or "sendmail" | |||
| * @property {object} message - Parameters to pass to the the worker. For example, when the worker is set to konnector, message contains the related konnector and the related account. | |||
| * @property {String} [message.account] - Id of the account associated to this trigger, if any | |||
| * @property {String} [message.konnector] - Slug of the konnector associated to this trigger, if any | |||
| * @property {String} [message.folder_to_save] - Id of the destination folder of the konnector associated to this trigger, if any | |||
There was a problem hiding this comment.
Let's use something like this:
* @property {IOCozyAccount['id']} [message.account] - Id of the account associated to this trigger, if any
* @property {IOCozyKonnector['slug']} [message.konnector] - Slug of the konnector associated to this trigger, if any
* @property {IOCozyFolder['path']} [message.folder_to_save] - Id of the destination folder of the konnector associated to this trigger, if any
Like that, we add the "relation" between data.
There was a problem hiding this comment.
Ok I see.
I just fixed the message.folder_to_save attribute which is actually the id of the folder and not the path.
doubleface
force-pushed
the
doc/TriggerMessage
branch
from
ddd15d6
to
0e8ffaf
Compare
|
Last thing... If you tag a commit Since you are editing the types and that types are used everywhere, you can tag it as a |
doubleface
force-pushed
the
doc/TriggerMessage
branch
from
0e8ffaf
to
46b5d1f
Compare
doubleface
changed the title
Crash--
approved these changes
Oct 10, 2023
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.
No description provided.