Pular para o conteúdo principal

Entendendo os números das Versões

Veja agora como são formados os números de cada Versão de uma Documentação.​

A Documentação BASE serve como parâmetro para as Versões geradas e publicadas nos Portais.

A numeração de cada Versão é gerada automaticamente no formato XYZ, onde:

  • “X” representa a Versão da API;
  • “Y” representa a criação de Versões derivadas da Documentação Base: no Versionamento, esse é o número que será alterado na nova Versão.
  • “Z” representa a criação de uma Versão, quando uma Versão já publicada em um Portal é salva.

Essas informações também podem ser encontradas na Central de Ajuda da Documentação.

Acesse a Integração e clique em (1) Documentação > (2) Histórico de Versões > (3) Ícone de interrogação “?”

A Central de Ajuda mostrará os detalhes o Versionamento.

A primeira versão da Documentação gerada será sempre denominada vX.0.0; no qual o “X” representa a Versão da API na qual o usuário está atuando.

Exemplos:

  • Na Versão v1 da API, o número gerado será v1.0.0.
  • Na Versão v3 da API, o número será v3.0.0 e, assim, sucessivamente.

A Versão da API visualizada é mostrada no topo da tela, ao lado do nome da API, onde também é possível selecionar uma outra Versão para acesso.

Ao confirmar o Versionamento da Documentação, o número da Versão “X” é gerado automaticamente e, a cada novo Versionamento, é alterado o número “Y” de forma crescente.

Exemplo:

  • 1º Versionamento da Versão v1 da API: será gerada a v1.0.0
  • 2º Versionamento da Versão v1 da API: será gerada a v1.1.0
  • 3º Versionamento da Versão v1 da API: será gerada a v1.2.0

Ainda na aba ‘Histórico de Versões’, é possível abrir a Documentação Base, clicando no botão ABRIR, para criar uma nova Documentação a partir da Base.

A lista das Versões geradas é mostrada em ordem cronológica, da mais recente para a mais antiga.

A 'Lista de Versões' traz as seguintes informações:

  • Versão: número da Versão gerada, seguindo o padrão vX.Y.Z;
  • Data de criação: data em que a Versão foi criada;
  • Data de atualização: data em que a Versão foi atualizada pela última vez;
  • Criado por: exibe o nome do usuário que criou a Versão;
  • Publicação: status de Publicação da Versão, que pode aparecer “em branco” ou com a tag "Publicada", caso a Versão já tenha sido Publicada;
  • Ações: exibe as opções "Abrir" e "Excluir" para cada Versão da Documentação.

Cada página da lista mostra até 10 Versões. Para visualizar mais Versões, basta clicar na seta no canto inferior direito, para visualizar a próxima página.