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"
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/deletefileoptions"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.