Skip to content

Latest commit

 

History

History
37 lines (28 loc) · 1.86 KB

DeleteFileOptions.md

File metadata and controls

37 lines (28 loc) · 1.86 KB

DeleteFileOptions

DeleteFileOptions options for deleting files (used for other File structs below) 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 [optional]
branch str branch (optional) to base this file from. if not given, the default branch is used [optional]
committer Identity [optional]
dates CommitDateOptions [optional]
message str message (optional) for the commit of this file. if not supplied, a default message will be used [optional]
new_branch str new_branch (optional) will make a new branch from `branch` before creating the file [optional]
sha str sha is the SHA for the file that already exists
signoff bool Add a Signed-off-by trailer by the committer at the end of the commit log message. [optional]

Example

from clientapi_forgejo.models.delete_file_options import DeleteFileOptions

# TODO update the JSON string below
json = "{}"
# create an instance of DeleteFileOptions from a JSON string
delete_file_options_instance = DeleteFileOptions.from_json(json)
# print the JSON string representation of the object
print(DeleteFileOptions.to_json())

# convert the object into a dict
delete_file_options_dict = delete_file_options_instance.to_dict()
# create an instance of DeleteFileOptions from a dict
delete_file_options_from_dict = DeleteFileOptions.from_dict(delete_file_options_dict)

[Back to Model list] [Back to API list] [Back to README]