UNPKG

cberg

Version:

Node.js Client for the Codeberg API

36 lines (28 loc) 1.74 kB
# ChangeFilesOptions ChangeFilesOptions options for creating, updating or deleting multiple 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] **dates** | [**CommitDateOptions**](CommitDateOptions.md) | | [optional] [default to undefined] **files** | [**Array<ChangeFileOperation>**](ChangeFileOperation.md) | list of file operations | [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` before creating the file | [optional] [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] ## Example ```typescript import { ChangeFilesOptions } from 'berg'; const instance: ChangeFilesOptions = { author, branch, committer, dates, files, message, new_branch, signoff, }; ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)