Forgejo · Schema

DispatchWorkflowOption

DispatchWorkflowOption options when dispatching a workflow

GitSource Code ManagementSelf-HostedDevOpsCI/CDOpen-SourceForgeRepositoriesIssuesPull Requests

Properties

Name	Type	Description
inputs	object	Input keys and values configured in the workflow file.
ref	string	Git reference for the workflow
return_run_info	boolean	Flag to return the run info

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DispatchWorkflowOption",
  "description": "DispatchWorkflowOption options when dispatching a workflow",
  "type": "object",
  "required": [
    "ref"
  ],
  "properties": {
    "inputs": {
      "description": "Input keys and values configured in the workflow file.",
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "x-go-name": "Inputs"
    },
    "ref": {
      "description": "Git reference for the workflow",
      "type": "string",
      "x-go-name": "Ref"
    },
    "return_run_info": {
      "description": "Flag to return the run info",
      "type": "boolean",
      "default": false,
      "x-go-name": "ReturnRunInfo"
    }
  },
  "x-go-package": "forgejo.org/modules/structs"
}