Github API - Test Config

Specifies the attributes for a new or updated ruleset bypass actor. Only one of
actor_id, repository_role_database_id, or organization_admin should be specified.

Attributes

actorId ID

For Team and Integration bypasses, the Team or Integration ID

bypassMode RepositoryRulesetBypassActorBypassMode

The bypass mode for this actor.

organizationAdmin Boolean

For organization owner bypasses, true

repositoryRoleDatabaseId Int

For role bypasses, the role database ID

API:

Github GraphQL API

A list of actors that are allowed to bypass rules in this ruleset.

clientMutationId String

String [scalar]

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

API:

Github GraphQL API

A unique identifier for the client performing the mutation.

conditions RepositoryRuleConditionsInput

RepositoryRuleConditionsInput [input]

Specifies the conditions required for a ruleset to evaluate

Attributes

refName RefNameConditionTargetInput

Configuration for the ref_name condition

repositoryId RepositoryIdConditionTargetInput

Configuration for the repository_id condition

repositoryName RepositoryNameConditionTargetInput

Configuration for the repository_name condition

repositoryProperty RepositoryPropertyConditionTargetInput

Configuration for the repository_property condition

API:

Github GraphQL API

The set of conditions for this ruleset

enforcement RuleEnforcement

RuleEnforcement [enum]

The level of enforcement for a rule or ruleset.

Possible values

ACTIVE

Rules will be enforced

DISABLED

Do not evaluate or enforce rules

EVALUATE

Allow admins to test rules before enforcing them. Admins can view insights on
the Rule Insights page (evaluate is only available with GitHub Enterprise).

API:

Github GraphQL API

The enforcement level for this ruleset

name String

String [scalar]

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

API:

Github GraphQL API

The name of the ruleset.

rules RepositoryRuleInput []

RepositoryRuleInput [input]

Specifies the attributes for a new or updated rule.

Attributes

id ID

Optional ID of this rule when updating

parameters RuleParametersInput

The parameters for the rule.

type RepositoryRuleType

The type of rule to create.

API:

Github GraphQL API

The list of rules for this ruleset

sourceId ID

ID [scalar]

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

API:

Github GraphQL API

The global relay id of the source in which a new ruleset should be created in.

target RepositoryRulesetTarget

RepositoryRulesetTarget [enum]

The targets supported for rulesets

Possible values

BRANCH

Branch

TAG

Tag

API:

Github GraphQL API

The target of the ruleset.

API:

Github GraphQL API