Skip to content
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

Open
wants to merge 8 commits into
base: v1.15
Choose a base branch
from

Conversation

arslanmusta
Copy link

@arslanmusta arslanmusta commented Nov 2, 2024

Thank you for helping make the Dapr documentation better!

Please follow this checklist before submitting:

  • Commits are signed with Developer Certificate of Origin (DCO - learn more)
  • Read the contribution guide
  • Commands include options for Linux, MacOS, and Windows within codetabs
  • New file and folder names are globally unique
  • Page references use shortcodes instead of markdown or URL links
  • Images use HTML style and have alternative text
  • Places where multiple code/command options are given have codetabs

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

Signed-off-by: Mustafa Arslan <[email protected]>
Copy link
Member

@msfussell msfussell left a 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)

arslanmusta and others added 6 commits November 4, 2024 20:27
…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]>
Copy link

Stale PR, paging all reviewers

Copy link
Collaborator

@hhunter-ms hhunter-ms left a 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"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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"` |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| `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:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants