cberg
Version:
Node.js Client for the Codeberg API
40 lines (32 loc) • 1.95 kB
Markdown
UpdateFileOptions options for updating files Note: `author` and `committer` are optional (if only one is given, it will be used for the other, otherwise the authenticated user will be used)
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**author** | [**Identity**](Identity.md) | | [optional] [default to undefined]
**branch** | **string** | branch (optional) to base this file from. if not given, the default branch is used | [optional] [default to undefined]
**committer** | [**Identity**](Identity.md) | | [optional] [default to undefined]
**content** | **string** | content must be base64 encoded | [default to undefined]
**dates** | [**CommitDateOptions**](CommitDateOptions.md) | | [optional] [default to undefined]
**from_path** | **string** | from_path (optional) is the path of the original file which will be moved/renamed to the path in the URL | [optional] [default to undefined]
**message** | **string** | message (optional) for the commit of this file. if not supplied, a default message will be used | [optional] [default to undefined]
**new_branch** | **string** | new_branch (optional) will make a new branch from `branch&
**sha** | **string** | sha is the SHA for the file that already exists | [default to undefined]
**signoff** | **boolean** | Add a Signed-off-by trailer by the committer at the end of the commit log message. | [optional] [default to undefined]
```typescript
import { UpdateFileOptions } from 'berg';
const instance: UpdateFileOptions = {
author,
branch,
committer,
content,
dates,
from_path,
message,
new_branch,
sha,
signoff,
};
```
[[Back to Model list]](../README.md