Argo CD · Schema

v1alpha1PullRequestGeneratorGithub

PullRequestGeneratorGithub defines connection info specific to GitHub.

Continuous DeliveryContainersDeploymentGitOpsKubernetesCNCFOpen Source

Properties

Name	Type	Description
api	string	The GitHub API URL to talk to. If blank, use https://api.github.com/.
appSecretName	string	AppSecretName is a reference to a GitHub App repo-creds secret with permission to access pull requests.
labels	array
owner	string	GitHub org or user to scan. Required.
repo	string	GitHub repo name to scan. Required.
tokenRef	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/argo-cd/refs/heads/main/json-schema/argo-cd-v1alpha1-pull-request-generator-github-schema.json",
  "title": "v1alpha1PullRequestGeneratorGithub",
  "description": "PullRequestGeneratorGithub defines connection info specific to GitHub.",
  "type": "object",
  "properties": {
    "api": {
      "description": "The GitHub API URL to talk to. If blank, use https://api.github.com/.",
      "type": "string"
    },
    "appSecretName": {
      "description": "AppSecretName is a reference to a GitHub App repo-creds secret with permission to access pull requests.",
      "type": "string"
    },
    "labels": {
      "type": "array",
      "title": "Labels is used to filter the PRs that you want to target",
      "items": {
        "type": "string"
      }
    },
    "owner": {
      "description": "GitHub org or user to scan. Required.",
      "type": "string"
    },
    "repo": {
      "description": "GitHub repo name to scan. Required.",
      "type": "string"
    },
    "tokenRef": {
      "$ref": "#/definitions/v1alpha1SecretRef"
    }
  }
}