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

[docs] Improve the update_file docs #513

Merged
merged 1 commit into from
Jan 9, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions src/api/repos.rs
Original file line number Diff line number Diff line change
Expand Up @@ -287,6 +287,17 @@ impl<'octo> RepoHandler<'octo> {
)
}

/// Update an existing file.
///
/// - `path`: the path of the updated file.
/// - `message`: the message of the commit used to update the file
/// - `content`: the updated contents of the file (base64 encoding is done
/// automatically).
/// - `sha`: the blob SHA of the file being updated. This can be obtained
/// using the [RepoHandler::get_content] function.
///
/// [GitHub API documentation](https://docs.github.com/en/rest/repos/contents?apiVersion=2022-11-28#create-or-update-file-contents)
///
/// ```no_run
/// # async fn run() -> octocrab::Result<()> {
/// # let blob_sha = "";
Expand Down
Loading