-
Notifications
You must be signed in to change notification settings - Fork 724
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Sftp Binding Component Docs #4418
base: v1.15
Are you sure you want to change the base?
Conversation
Signed-off-by: Mustafa Arslan <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@arslanmusta Looks great. Thanks for creating this. Generally keeping acronym to caps at the start of the doc with a full name description of the binding (similar to SMTP binding)
daprdocs/content/en/reference/components-reference/supported-bindings/sftp.md
Outdated
Show resolved
Hide resolved
daprdocs/content/en/reference/components-reference/supported-bindings/sftp.md
Outdated
Show resolved
Hide resolved
daprdocs/content/en/reference/components-reference/supported-bindings/sftp.md
Outdated
Show resolved
Hide resolved
daprdocs/content/en/reference/components-reference/supported-bindings/sftp.md
Outdated
Show resolved
Hide resolved
daprdocs/content/en/reference/components-reference/supported-bindings/sftp.md
Outdated
Show resolved
Hide resolved
…indings/sftp.md Co-authored-by: Mark Fussell <[email protected]> Signed-off-by: Mustafa Arslan <[email protected]>
…indings/sftp.md Co-authored-by: Mark Fussell <[email protected]> Signed-off-by: Mustafa Arslan <[email protected]>
…indings/sftp.md Co-authored-by: Mark Fussell <[email protected]> Signed-off-by: Mustafa Arslan <[email protected]>
…indings/sftp.md Co-authored-by: Mark Fussell <[email protected]> Signed-off-by: Mustafa Arslan <[email protected]>
Co-authored-by: Mark Fussell <[email protected]> Signed-off-by: Mustafa Arslan <[email protected]>
…indings/sftp.md Co-authored-by: Mark Fussell <[email protected]> Signed-off-by: Mustafa Arslan <[email protected]>
Stale PR, paging all reviewers |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
quick consistency check
--- | ||
type: docs | ||
title: "SFTP binding spec" | ||
linkTitle: "Sftp" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
linkTitle: "Sftp" | |
linkTitle: "SFTP" |
for consistency
|
||
## Component format | ||
|
||
To set up the SMTP binding, create a component of type `bindings.sftp`. See this guide on how to create and apply a binding configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To set up the SMTP binding, create a component of type `bindings.sftp`. See this guide on how to create and apply a binding configuration. | |
To set up the SFTP binding, create a component of type `bindings.sftp`. See [this guide]({{ ref bindings-overview.md }}) on how to create and apply a binding configuration. |
| Field | Required | Binding support | Details | Example | | ||
|--------------------|:--------:|------------|-----|---------| | ||
| `rootPath` | Y | Output | Root path for default working directory | `"/path"` | | ||
| `address` | Y | Output | Address of Sftp server | `"localhost:22"` | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| `address` | Y | Output | Address of Sftp server | `"localhost:22"` | | |
| `address` | Y | Output | Address of SFTP server | `"localhost:22"` | |
|
||
### Create file | ||
|
||
To perform a create file operation, invoke the Sftp binding with a `POST` method and the following JSON body: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To perform a create file operation, invoke the Sftp binding with a `POST` method and the following JSON body: | |
To perform a create file operation, invoke the SFTP binding with a `POST` method and the following JSON body: |
|
||
### Get file | ||
|
||
To perform a get file operation, invoke the Sftp binding with a `POST` method and the following JSON body: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To perform a get file operation, invoke the Sftp binding with a `POST` method and the following JSON body: | |
To perform a get file operation, invoke the SFTP binding with a `POST` method and the following JSON body: |
|
||
### List files | ||
|
||
To perform a list files operation, invoke the Sftp binding with a `POST` method and the following JSON body: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To perform a list files operation, invoke the Sftp binding with a `POST` method and the following JSON body: | |
To perform a list files operation, invoke the SFTP binding with a `POST` method and the following JSON body: |
|
||
### Delete file | ||
|
||
To perform a delete file operation, invoke the Sftp binding with a `POST` method and the following JSON body: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To perform a delete file operation, invoke the Sftp binding with a `POST` method and the following JSON body: | |
To perform a delete file operation, invoke the SFTP binding with a `POST` method and the following JSON body: |
Thank you for helping make the Dapr documentation better!
Please follow this checklist before submitting:
In addition, please fill out the following to help reviewers understand this pull request:
Description
Adding Sftp Binding component documentation.
Issue reference
Related PR: dapr/components-contrib#3505