Registro de cambios

Este Changelog destaca los cambios notables en la Guía de diseño de la API.

2021-12

  • Se cambió la terminología de la API de Networked a la API de Network para mantener la coherencia con https://google.aip.dev/9.

2021-09

  • Documenta los formatos de error v1 y v2 de la API de Google.

2021-04

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

  • Se introdujo el título de la API en el glosario.

2021-03

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

  • Actualiza la orientación sobre valores enum para incluir siempre un valor _UNSPECIFIED explícito.

  • Agrega orientación para 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 abarcar la mejora más reciente relacionada con google.rpc.ErrorInfo y google.api.ErrorReason.

  • Se agregó orientación sobre el uso de oauth2l, curl y 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 Errores. Es un error de red, y no de 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 a los clientes que vuelvan a intentarlo solo para errores 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.

2018-01

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

2017-12

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

2017-11

  • 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.

2017-09

  • 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.
Anterior
Glosario