Skip to main content
Ahora la API de REST tiene control de versiones. Para obtener más información, consulta "Acerca del control de versiones de la API".

Propiedades personalizadas

Usa la API de REST para enumerar las propiedades personalizadas asignadas a un repositorio por la organización.

Acerca de las propiedades personalizadas

Puedes usar la API de REST para ver las propiedades personalizadas asignadas a un repositorio por la organización que posee el repositorio. Para obtener más información, vea «Administración de propiedades personalizadas para repositorios de la organización». Para obtener más información sobre los puntos de conexión de la API de REST para administrar propiedades personalizadas, consulta “Propiedades personalizadas”.

Get all custom property values for a repository

Gets all custom property values that are set for a repository. Users with read access to the repository can use this endpoint.

Tokens de acceso específicos para "Get all custom property values for a repository"

Este punto de conexión funciona con los siguientes tipos de token:

El token debe tener el siguiente conjunto de permisos.:

  • metadata:read

Este punto de conexión se puede usar sin autenticación o los permisos mencionados anteriormente si solo se solicitan recursos públicos.

Parámetros para "Get all custom property values for a repository"

Encabezados
Nombre, Tipo, Descripción
accept string

Setting to application/vnd.github+json is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
owner string Requerido

The account owner of the repository. The name is not case sensitive.

repo string Requerido

The name of the repository without the .git extension. The name is not case sensitive.

Códigos de estado de respuesta HTTP para "Get all custom property values for a repository"

status codeDescripción
200

OK

403

Forbidden

404

Resource not found

Ejemplos de código para "Get all custom property values for a repository"

Ejemplo de solicitud

get/repos/{owner}/{repo}/properties/values
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/properties/values

Response

Status: 200
[ { "property_name": "environment", "value": "production" }, { "property_name": "service", "value": "web" }, { "property_name": "team", "value": "octocat" } ]

Create or update custom property values for a repository

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.

Tokens de acceso específicos para "Create or update custom property values for a repository"

Este punto de conexión funciona con los siguientes tipos de token:

El token debe tener el siguiente conjunto de permisos.:

  • repository_custom_properties:write

Parámetros para "Create or update custom property values for a repository"

Encabezados
Nombre, Tipo, Descripción
accept string

Setting to application/vnd.github+json is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
owner string Requerido

The account owner of the repository. The name is not case sensitive.

repo string Requerido

The name of the repository without the .git extension. The name is not case sensitive.

Parámetros del cuerpo
Nombre, Tipo, Descripción
properties array of objects Requerido

A list of custom property names and associated values to apply to the repositories.

Nombre, Tipo, Descripción
property_name string Requerido

The name of the property

value null or string or array Requerido

The value assigned to the property

Códigos de estado de respuesta HTTP para "Create or update custom property values for a repository"

status codeDescripción
204

No Content when custom property values are successfully created or updated

403

Forbidden

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

Ejemplos de código para "Create or update custom property values for a repository"

Ejemplo de solicitud

patch/repos/{owner}/{repo}/properties/values
curl -L \ -X PATCH \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/properties/values \ -d '{"properties":[{"property_name":"environment","value":"production"},{"property_name":"service","value":"web"},{"property_name":"team","value":"octocat"}]}'

No Content when custom property values are successfully created or updated

Status: 204