custom_property_values
Creates, updates, deletes, gets or lists a custom_property_values resource.
Overview
| Name | custom_property_values |
| Type | Resource |
| Id | github.repos.custom_property_values |
Fields
The following fields are returned by SELECT queries:
- custom_properties_for_repos_get_repository_values
Response
| Name | Datatype | Description |
|---|---|---|
property_name | string | The name of the property |
value | string | The value assigned to the property |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
custom_properties_for_repos_get_repository_values | select | owner, repo | Gets all custom property values that are set for a repository. Users with read access to the repository can use this endpoint. | |
custom_properties_for_repos_create_or_update_repository_values | update | owner, repo, properties | Create new or update existing custom property values for a repository. Using a value of null for a custom property will remove or 'unset' the property value from the repository.Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint. |
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 |
|---|---|---|
owner | string | The account owner of the repository. The name is not case sensitive. |
repo | string | The name of the repository without the .git extension. The name is not case sensitive. |
SELECT examples
- custom_properties_for_repos_get_repository_values
Gets all custom property values that are set for a repository.
Users with read access to the repository can use this endpoint.
SELECT
property_name,
value
FROM github.repos.custom_property_values
WHERE owner = '{{ owner }}' -- required
AND repo = '{{ repo }}' -- required
;
UPDATE examples
- custom_properties_for_repos_create_or_update_repository_values
Create new or update existing custom property values for a repository.
Using a value of null for a custom property will remove or 'unset' the property value from the repository.
Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint.
UPDATE github.repos.custom_property_values
SET
properties = '{{ properties }}'
WHERE
owner = '{{ owner }}' --required
AND repo = '{{ repo }}' --required
AND properties = '{{ properties }}' --required;