Registo de alterações

Este registo de alterações realça as alterações importantes ao guia de design de APIs.

2025-06

• Convenção de nomenclatura da página de design redirecionada para a Google AIP.

2024-10

• Redirecionou as páginas de design para as APIs Google, exceto para a estrutura de diretórios e as convenções de nomenclatura.

2021-12

• Alteração da terminologia de API em rede para API de rede para consistência com https://google.aip.dev/9.

2021-09

• Documentar o formato de erro da API Google v1 e v2.

2021-04

• Introdução da gestão de versões baseada na visibilidade.

• Introdução do título da API no glossário.

2021-03

• Adicionámos anotações para campos só de saída.

• Atualize as orientações sobre os valores de enumeração para incluir sempre um valor _UNSPECIFIED explícito.

• Adicione orientações sobre como gerar e analisar nomes de recursos.

• Adicione progress_percent a campos padrão.

2021-02

• Foram adicionadas orientações sobre os campos primitivos optional do proto3.

2021-01

• Atualizámos a página Erros para abranger a melhoria mais recente relacionada com google.rpc.ErrorInfo e google.api.ErrorReason.

• Foram adicionadas orientações sobre como usar oauth2l, curl e parâmetros do sistema para resolver problemas com as APIs Google.

• Foi adicionada a explicação do código de erro 502 à página Erros. Trata-se de um erro de rede e não de um erro de API.

2020-12

• Os nomes dos pacotes devem usar nomes de componentes singulares para consistência global. Os nomes dos pacotes não podem usar sublinhados.

2020-09

• Limpeza de alguns requisitos de descrição de campos; alteração de algumas utilizações de "tem de" fora da RFC 2119 para diretivas "deve" da RFC 2119.

• O campo padrão bool deleted foi removido a favor de google.protobuf.Timestamp delete_time (que já estava listado).

2020-07

• Atualização do ficheiro documentation.md para corresponder a https://google.aip.dev/192#formatting. Não é permitido usar tabelas de marcação nem HTML não processado em comentários proto.

• Adicionou ErrorInfo para o processamento de erros.

• Foram adicionados payloads grandes para padrões de design.

2020-04

• O nome das APIs Cloud foi alterado para APIs Google Cloud no glossário.
• Introduzimos API e serviço como sinónimos de serviço API.

2020-02

• Atualização da gestão de versões para adicionar duas estratégias de gestão de versões (com base no canal e com base no lançamento), remover orientações sobre versões pontuais e alterar a forma como nos referimos à gestão de versões semântica.

2020-01

• Adicione a retenção de dados aos padrões de design.

2019-11

• Adicione APIs Cloud de terminologia ao glossário.
• Recomende aos clientes que tentem novamente apenas para erros UNAVAILABLE.

2019-06

• Adicione "Bool vs Enum vs String" aos padrões de design.

2019-03

• Adicione parâmetros do sistema a campos padrão.

2019-02

• Adicione nomes com âmbito de domínio a padrões de design.

2018-03

• Adicione semântica de fecho parcial de streaming a padrões de design.

2018-02

• Adicione read_time aos campos padrão.

2018-01

• Adicione uma referência de esquema para a definição do serviço da API.

2017-12

• Esclarecer que a versão principal da API tem de ser o último componente do nome do pacote proto.

2017-11

• Esclareça por que motivo o método Create recebe um recurso de entrada.
• Esclarecer os IDs de coleções que não têm forma plural, como evidence e weather.
• Adicione um recurso singleton a padrões de design.
• Esclarecer as convenções de nomenclatura de C# para acrónimos e versões.

2017-09

• Adicione mime_type a campos padrão.
• Adicione expire_time a campos padrão.
• Adicione start_time e end_time a campos padrão.

2017-02

• Adicione "Ponto final da API" ao glossário.
• Adicione update_mask a campos padrão.
• Adicione um link para FieldMask aos métodos padrão.
• Mencione que a especificação OpenAPI não suporta números inteiros não assinados.
• Esclarecer que os nomes dos métodos devem usar verbos no modo imperativo.