piece reference

activepieces · Jan 14, 2023 · 6e43731 · 6e43731
1 parent c5ba828
commit 6e43731
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 10 deletions.
diff --git a/docs/contributing/building-pieces/action.mdx → .../contributing/pieces-reference/action.mdx b/docs/contributing/building-pieces/action.mdx → .../contributing/pieces-reference/action.mdx
diff --git a/docs/contributing/building-pieces/piece.mdx → docs/contributing/pieces-reference/piece.mdx b/docs/contributing/building-pieces/piece.mdx → docs/contributing/pieces-reference/piece.mdx
diff --git a/docs/contributing/building-pieces/input.mdx → ...ontributing/pieces-reference/property.mdx b/docs/contributing/building-pieces/input.mdx → ...ontributing/pieces-reference/property.mdx
@@ -9,7 +9,7 @@ All properties `name` should be a snake case.
 
 # Schema
 
-Here is the schema of each property type.
+The following is the schema for each property type:
 
 ## Short text
 
@@ -51,7 +51,7 @@ Property.Number({
     required: boolean,
     authUrl: string, // The url used for redirection
     tokenUrl: string, // The url used for claiming token
-    scope: string[]],
+    scope: string[],
 })
 ```
 
@@ -68,13 +68,14 @@ Property.Number({
 
 ## Dropdown 
 
-Options is function, so you can load options dynmiucally depends on the user props value.
+Options can be loaded dynamically based on the user's props value.
 
 ```typescript
 Property.Dropdown({
     displayName: string;
     description: string | undefined;
     required: boolean;
+    refreshers: string[], // properties that when changed, will trigger the options function to execute
     options: async (propsValue): DropdownState {
         if (props['authentication'] === undefined) {
             return {

diff --git a/.../contributing/building-pieces/trigger.mdx → ...contributing/pieces-reference/trigger.mdx b/.../contributing/building-pieces/trigger.mdx → ...contributing/pieces-reference/trigger.mdx
@@ -22,10 +22,4 @@ export const createNewIssue = createTrigger({
     // a seperate flow run.
     run: async run(context, propsValue): unknown[] => {}
 })
-```
-
-# Examples
-
-## Webhook Trigger
-
-## Polling Trigger
+```