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:
- quitar una operación completa
- quitar un parámetro o cambiar su nombre
- quitar un campo de respuesta o cambiar su nombre
- agregar un nuevo parámetro obligatorio
- hacer que se requiera un parámetro opcional anteriormente
- cambiar el tipo de un parámetro o campo de respuesta
- quitar valores de enumeración
- agregar una nueva regla de validación a un parámetro existente
- cambiar 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:
- agregar una operación
- agregar un parámetro opcional
- agregar un encabezado de solicitud opcional
- agregar un campo de respuesta
- agregar un campo de respuesta
- agregar 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.
Cambios importantes para 2022-11-28
La versión 2022-11-28 es la primera versión de la API REST de GitHub Enterprise Server después de la introducción del control de versiones basado en fechas. Esta versión no incluye ningún cambio importante.