Skip to content

Commit

Permalink
Issue #128: Add default Connectors in connector.md
Browse files Browse the repository at this point in the history
* Added default variables section under connector.md.
  • Loading branch information
CherfaElyes committed Oct 14, 2024
1 parent 931a437 commit 9b79f6b
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions src/site/markdown/develop/connector.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ connector:
projectVersion: # <string> | default: {esc.d}${project.version}
information: # <string>
detection: # <object>
variables: # <object>
```
### Properties
Expand All @@ -43,6 +44,7 @@ connector:
| `projectVersion` | The current version of the connector library project. |
| `version` | The current version of the connector. |
| `detection` | Defines all the information required to perform connector’s detection. See specification in [Detection](detection.md). |
|`variables`| The name, description & default value of each connector default variable. If the user does not specify values for these variables, default variables are used instead.|

## Embedded Files

Expand Down Expand Up @@ -175,6 +177,11 @@ connector:
expectedResult: # <string>
forceSerialization: # <boolean>
variables:
<variableName>:
description: # <string>
defaultValue: # <string>
sudoCommands: # <string-array>
extends: # <string-array>
Expand Down

0 comments on commit 9b79f6b

Please sign in to comment.