Cambios importantes

Acerca de los cambios importantes en la API REST

La API REST GitHub Enterprise Server tiene versiones. El nombre de la versión de la API se basa en la fecha en la que se publicó dicha versión. Por ejemplo, la versión 2022-11-28 de la API se publicó el Mon, 28 Nov 2022.

Todos los cambios importantes se publicarán en una nueva versión de API. Los cambios importantes son cambios que pueden interrumpir una integración. Los cambios importantes incluyen:

Eliminación de una operación completa
Eliminación o cambio del nombre de un parámetro
Eliminación o cambio del nombre de un campo de respuesta
Adición de un nuevo parámetro obligatorio
Hacer que se requiera un parámetro anteriormente opcional
Cambio del tipo de un parámetro o campo de respuesta
Eliminación de valores de enumeración
Adición de una nueva regla de validación a un parámetro existente
Cambio de los requisitos de autenticación o autorización

Todos los cambios aditivos (no importantes) estarán disponibles en todas las versiones de API admitidas. Los cambios aditivos son cambios que no deben interrumpir una integración. Los cambios aditivos incluyen:

Adición de una operación
Adición de un parámetro opcional
Adición de un encabezado de solicitud opcional
Adición de un campo de respuesta
Adición de un encabezado de respuesta
Adición de valores de enumeración

Cuando se publica una nueva versión de la API REST, la versión anterior de la API se admitirá durante al menos 24 meses más después del lanzamiento de la nueva versión de la API.

Para más información sobre las versiones de API, consulta Versiones de API.

Actualización a una nueva versión de API

Antes de actualizar a una nueva versión de la API REST, debes leer la sección de esta página que corresponde a la nueva versión de API para comprender qué cambios importantes se incluyen y para obtener más información sobre cómo actualizar a esa versión de API.

Al actualizar la integración para especificar la nueva versión de API en el encabezado X-GitHub-Api-Version, también deberás realizar los cambios necesarios para que la integración funcione con la nueva versión de API.

Una vez actualizada la integración, pruébala para comprobar que funciona con la nueva versión de API.