Forgejo · Schema

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)

GitSource Code ManagementSelf-HostedDevOpsCI/CDOpen-SourceForgeRepositoriesIssuesPull Requests

Properties

Name Type Description
author object
branch string branch (optional) to base this file from. if not given, the default branch is used
committer object
dates object
force_overwrite_new_branch boolean (optional) will do a force-push if the new branch already exists
message string message (optional) for the commit of this file. if not supplied, a default message will be used
new_branch string new_branch (optional) will make a new branch from `branch` before creating the file
sha string sha is the SHA for the file that already exists
signoff boolean Add a Signed-off-by trailer by the committer at the end of the commit log message.
View JSON Schema on GitHub

JSON Schema

deletefileoptions.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DeleteFileOptions",
  "description": "DeleteFileOptions options for deleting files (used for other File structs below)\nNote: `author` and `committer` are optional (if only one is given, it will be used for the other, otherwise the authenticated user will be used)",
  "type": "object",
  "required": [
    "sha"
  ],
  "properties": {
    "author": {
      "$ref": "#/definitions/Identity"
    },
    "branch": {
      "description": "branch (optional) to base this file from. if not given, the default branch is used",
      "type": "string",
      "x-go-name": "BranchName"
    },
    "committer": {
      "$ref": "#/definitions/Identity"
    },
    "dates": {
      "$ref": "#/definitions/CommitDateOptions"
    },
    "force_overwrite_new_branch": {
      "description": "(optional) will do a force-push if the new branch already exists",
      "type": "boolean",
      "x-go-name": "ForceOverwriteNewBranch"
    },
    "message": {
      "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
      "type": "string",
      "x-go-name": "Message"
    },
    "new_branch": {
      "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
      "type": "string",
      "x-go-name": "NewBranchName"
    },
    "sha": {
      "description": "sha is the SHA for the file that already exists",
      "type": "string",
      "x-go-name": "SHA"
    },
    "signoff": {
      "description": "Add a Signed-off-by trailer by the committer at the end of the commit log message.",
      "type": "boolean",
      "x-go-name": "Signoff"
    }
  },
  "x-go-package": "forgejo.org/modules/structs"
}