Github API - Test Config

Flexydox

RepositoryRuleset [object]

A repository ruleset.

Implements
Node

Node [interface]

An object with an ID.

Attributes
id ID

ID of the object.

API:
Github GraphQL API
Attributes
bypassActors RepositoryRulesetBypassActorConnection

RepositoryRulesetBypassActorConnection [object]

The connection type for RepositoryRulesetBypassActor.

Attributes
edges RepositoryRulesetBypassActorEdge []

A list of edges.

nodes RepositoryRulesetBypassActor []

A list of nodes.

pageInfo PageInfo

Information to aid in pagination.

totalCount Int

Identifies the total count of items in the connection.

API:
Github GraphQL API

The actors that can bypass this ruleset

conditions RepositoryRuleConditions

RepositoryRuleConditions [object]

Set of conditions that determine if a ruleset will evaluate

Attributes
refName RefNameConditionTarget

Configuration for the ref_name condition

repositoryId RepositoryIdConditionTarget

Configuration for the repository_id condition

repositoryName RepositoryNameConditionTarget

Configuration for the repository_name condition

repositoryProperty RepositoryPropertyConditionTarget

Configuration for the repository_property condition

API:
Github GraphQL API

The set of conditions that must evaluate to true for this ruleset to apply

createdAt DateTime

DateTime [scalar]

An ISO-8601 encoded UTC date string.

API:
Github GraphQL API

Identifies the date and time when the object was created.

databaseId Int

Int [scalar]

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

API:
Github GraphQL API

Identifies the primary key from the database.

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 of this ruleset

id 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 Node ID of the RepositoryRuleset object

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

Name of the ruleset.

rules RepositoryRuleConnection

RepositoryRuleConnection [object]

The connection type for RepositoryRule.

Attributes
edges RepositoryRuleEdge []

A list of edges.

nodes RepositoryRule []

A list of nodes.

pageInfo PageInfo

Information to aid in pagination.

totalCount Int

Identifies the total count of items in the connection.

API:
Github GraphQL API

List of rules.

source RuleSource

RuleSource [union]

Types which can have RepositoryRule objects.

Union
OrganizationRepository
API:
Github GraphQL API

Source of ruleset.

target RepositoryRulesetTarget

RepositoryRulesetTarget [enum]

The targets supported for rulesets

Possible values
BRANCH

Branch

TAG

Tag

API:
Github GraphQL API

Target of the ruleset.

updatedAt DateTime

DateTime [scalar]

An ISO-8601 encoded UTC date string.

API:
Github GraphQL API

Identifies the date and time when the object was last updated.

API:
Github GraphQL API