Registro de cambios

En este registro de cambios, se destacan los cambios históricos notables en la Guía de diseño de APIs, como las revisiones de las convenciones de nomenclatura, el manejo de errores y los campos estándar. También registra las migraciones de documentación en las Propuestas de Mejora de la API de Google (AIP).

2025-06

• Se redireccionó la convención de nomenclatura de la página de diseño a la AIP de Google.

2024-10

• Se redireccionaron las páginas de diseño a las AIP de Google, excepto las de estructura de directorios y convenciones de nomenclatura.

2021-12

• Se cambió la terminología de API en red a API de red para que coincida con https://google.aip.dev/9.

2021-09

• Documenta los formatos de error de las APIs de Google v1 y v2.

2021-04

• Se introdujo el control de versiones basado en la visibilidad.

• Se agregó el título de la API al glosario.

2021-03

• Se agregó una anotación para los campos de solo salida.

• Actualiza la guía de valores de enumeración para incluir siempre un valor _UNSPECIFIED explícito.

• Se agregó orientación sobre cómo generar y analizar nombres de recursos.

• Agrega progress_percent a los campos estándar.

2021-02

• Se agregó orientación sobre los campos primitivos optional de proto3.

2021-01

• Se actualizó la página Errores para incluir la mejora más reciente relacionada con google.rpc.ErrorInfo y google.api.ErrorReason.

• Se agregó orientación sobre cómo usar oauth2l, curl y los parámetros del sistema para solucionar errores con las APIs de Google.

• Se agregó la explicación del código de error 502 a la página Errors. Se trata de un error de red, no de un error de la API.

2020-12

• Los nombres de los paquetes deben usar nombres de componentes singulares para lograr coherencia global. Los nombres de los paquetes no deben usar guiones bajos.

2020-09

• Se limpiaron algunos requisitos de descripción de campos; se cambiaron algunos usos de “deben” fuera de RFC 2119 para que sean directivas de RFC 2119 “deberías”.

• Se quitó el campo estándar bool deleted a favor de google.protobuf.Timestamp delete_time (que ya estaba en la lista).

2020-07

• Se actualizó documentation.md para que coincida con https://google.aip.dev/192#formatting. Las tablas de Markdown y el HTML sin procesar no deben usarse en los comentarios de proto.

• Se agregó ErrorInfo para el manejo de errores.

• Se agregaron cargas útiles grandes para los patrones de diseño.

2020-04

• Se cambió el nombre de las API de Cloud a las API de Google Cloud en el glosario.
• Se introdujeron API y servicio como sinónimos del servicio de API.

2020-02

• Se actualizó el control de versiones para agregar dos estrategias de control de versiones (basadas en canales y en versiones), quitar orientación sobre las versiones de puntos y cambiar cómo nos referimos al control de versiones semántico.

2020-01

• Agrega retención de datos a los patrones de diseño

2019-11

• Agrega terminología de API de Cloud al glosario.
• Se recomienda que los clientes vuelvan a intentar la solicitud solo en caso de errores de UNAVAILABLE.

2019-06

• Agrega "Bool vs. Enum vs. String" a los patrones de diseño.

2019-03

• Agrega parámetros del sistema a campos estándar.

2019-02

• Agrega nombres con alcance de dominio para diseñar patrones.

03-2018

• Agrega semántica de transmisión de cierre parcial a los patrones de diseño.

02-2018

• Agrega read_time a los campos estándar.

01-2018

• Agrega una referencia de esquema para la definición del servicio de API.

12-2017

• Aclara que la versión principal de la API debe ser el último componente del nombre del paquete proto.

11-2017

• Aclara por qué el método Create toma un recurso de entrada.
• Aclara los ID de recopilación que no tienen forma plural, como análisis y caos.
• Agrega el recurso de singleton a los patrones de diseño.
• Aclara las convenciones de nombres C# para acrónimos y versiones.

09-2017

• Agrega mime_type a los campos estándar.
• Agrega expire_time a los campos estándar.
• Agrega start_time y end_time a los campos estándar.

02-2017

• Agrega "extremo de API" al glosario.
• Agrega update_mask a los campos estándar.
• Agrega un vínculo a FieldMask en los métodos estándar.
• Menciona que la especificación de OpenAPI no admite números enteros sin signo.
• Aclara que los nombres de los métodos deben usar verbos en modo imperativo.