ruleset_history

Creates, updates, deletes, gets or lists a ruleset_history resource.

Overview

Name	ruleset_history
Type	Resource
Id	github.orgs.ruleset_history

Fields

The following fields are returned by SELECT queries:

get_org_ruleset_version

Response

Name	Datatype	Description
version_id	integer	The ID of the previous version of the ruleset
actor	object	The actor who updated the ruleset
state	string	The state of the ruleset version (opaque JSON object)
updated_at	string (date-time)

get_org_ruleset_history

Response

Name	Datatype	Description
version_id	integer	The ID of the previous version of the ruleset
actor	object	The actor who updated the ruleset
updated_at	string (date-time)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_org_ruleset_version	select	org, ruleset_id, version_id		Get a version of an organization ruleset.
get_org_ruleset_history	select	org, ruleset_id	per_page, page	Get the history of an organization ruleset.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
org	string	The organization name. The name is not case sensitive.
ruleset_id	integer	The ID of the ruleset.
version_id	integer	The ID of the version
page	integer	The page number of the results to fetch. For more information, see "Using pagination in the REST API."
per_page	integer	The number of results per page (max 100). For more information, see "Using pagination in the REST API."

SELECT examples

get_org_ruleset_version

Get a version of an organization ruleset.

SELECT
version_id,
actor,
state,
updated_at
FROM github.orgs.ruleset_history
WHERE org = '{{ org }}' -- required
AND ruleset_id = '{{ ruleset_id }}' -- required
AND version_id = '{{ version_id }}' -- required
;

get_org_ruleset_history

Get the history of an organization ruleset.

SELECT
version_id,
actor,
updated_at
FROM github.orgs.ruleset_history
WHERE org = '{{ org }}' -- required
AND ruleset_id = '{{ ruleset_id }}' -- required
AND per_page = '{{ per_page }}'
AND page = '{{ page }}'
;