Neste registro de alterações, você verá as mudanças relevantes no Guia de design da API.
2021-12
- Alteração da terminologia de API de rede para API de rede a fim de manter a consistência com https://google.aip.dev/9.
2021-09
- Documentação dos formatos de erro da API do Google v1 e v2.
2021-04
Lançamento do controle de versão baseado em visibilidade.
Inclusão do título da API ao glossário.
2021-03
Adição de anotação apenas a campos de saída.
Atualização da orientação do valor de enumeração para sempre incluir um valor
_UNSPECIFIED
explícito.Adição de orientações sobre como gerar e analisar nomes de recursos.
Adicione
progress_percent
aos campos padrão.
2021-02
- Adição de orientações sobre os campos primitivos do proto3
optional
.
2021-01
Atualização da página de erros para incluir as melhorias mais recentes relacionadas a
google.rpc.ErrorInfo
egoogle.api.ErrorReason
.Inclusão de orientações sobre como usar os parâmetros
oauth2l
,curl
e do sistema para resolver erros com as APIs do Google.Adição de uma explicação sobre o código de erro
502
à página "Erros". Trata-se de um erro de rede em vez de um erro de API.
2020-12
- Nomes de pacotes devem usar nomes de componentes no singular para consistência global. Os nomes dos pacotes não podem usar sublinhados.
2020-09
Alguns requisitos de descrição do campo foram limpos. Foram alterados alguns usos de "obrigatório" fora do RFC 2119 para serem diretivas "necessárias" do RFC 2119.
O campo padrão
bool deleted
foi removido em favor dogoogle.protobuf.Timestamp delete_time
(que já estava listado).
2020-07
Updated documentation.md to match https://google.aip.dev/192#formatting. As tabelas Markdown e HTML bruto não podem ser usadas em comentários de proto.
Adição de
ErrorInfo
para tratamento de erros.Adição de grandes payloads para padrões de projetos.
2020-04
- Renomeação de APIs do Cloud para APIs do Google Cloud no glossário.
- Introdução da API e do serviço como sinônimos do serviço da API.
2020-02
- Atualização do controle de versão para adicionar duas estratégias de controle de versão (com base no canal e na versão), remover orientações sobre versões de pontos e alterar a forma como nos referimos ao controle de versão semântico.
2020-01
- Adição da retenção de dados aos padrões de design.
2019-11
- Adição da terminologia das APIs do Cloud ao glossário.
- Recomende que os clientes tentem novamente somente no caso de erros UNAVAILABLE.
2019-06
- Adicione "Bool x Enum x String" aos padrões de design.
2019-03
- Adiciona parâmetros do sistema aos campos padrão.
2019-02
- Adiciona nomes com escopo de domínio para criar padrões.
2018-03
- Adiciona a semântica de fechamento de streaming aos padrões de design.
2018-02
- Adicione
read_time
aos campos padrão.
2018-01
- Adiciona referência de esquema à definição do serviço da API.
2017-12
- Esclarece que a versão principal da API precisa ser o último componente do nome do pacote proto.
2017-11
- Esclareça por que o método
Create
usa um recurso de entrada. - Explica códigos de coleção que não têm forma plural, como evidência e clima.
- Adiciona o recurso singleton aos padrões de design.
- Esclarece convenções de nomenclatura C# para siglas e versões.
2017-09
- Adicione
mime_type
aos campos padrão. - Adicione
expire_time
aos campos padrão. - Adicione
start_time
eend_time
aos campos padrão.
2017-02
- Adiciona "ponto de extremidade da API" ao glossário.
- Adicione
update_mask
aos campos padrão. - Adicione um link para
FieldMask
aos métodos padrão. - Menciona que as especificações do OpenAPI não aceitam números inteiros sem assinatura.
- Esclarece que os nomes dos métodos precisam usar verbos no modo imperativo.