Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Segundo a política de versionamento do Open Finance Brasil, o ciclo de vida de uma API possui 05 status etapas após Design, considerada como status etapa de definição concepção da API, e portantologo, não incluímos como parte do processo para atualização dos dados.

No GDC, o modelo de entidade relacional, para o contexto de API, foi especificado considerando 03 entidades: API, Endpoint e Fases.

conforme o diagrama:

...

Regras de preenchimento de datas no GDC:

Quando houver mudança em uma versão, devemos alterar o Status e as datas de inicio e fim

...

. Portanto, a regra para atualização do ciclo de vida, deverá ocorrer quando:

Houver mudança de versão na API

Com isso, é necessário que sejam modificados os seguintes dados da API:

  • Status, considerando as etapas de Implementing, Certifying, Current, Deprecated ou Retired;

  • Data de Início, representado pelo formato yyyy-MM-dd, como por exemplo, 2021-01-30;

  • Data Fim, representado pelo formato yyyy-MM-dd, como por exemplo, 2021-01-30.

Regras Gerais

A alteração dos dados de uma API para cada mudança de versão, devem ser consideradas como regras gerais:

  • A API deverá conter uma ÚNICA versão Current. Exceto, para um novo produto, tendo em vista que não existem versões anteriores;

  • Se o versionamento de uma API for do tipo Patch, as datas de início e fim para os status de Certifying ou Deprecated podem ser nulas (NULL), tendo em vista que não há um período de convivência.

Além disso, o preenchimento das datas de inicio e fim devem seguir as especificações abaixo, de acordo com as mudanças de status:

Status

Data de início

Data final

Toda versão

implementing

Implementing com certificação

data

Data da divulgação da primeira versão da especificação (beta.0)

Dia do primeiro marco

Toda versão

implementing

Implementing sem certificação

data

Data da divulgação da especificação (beta.0)

data

Data do go-live

Toda versão

certifying

Certifying

Dia do primeiro marco

fim

Fim do período do processamento de pedidos de certificação

Toda versão

current

Current

data

Data do go-live

-

Toda versão

deprecated

Deprecated

data

Data do go-live

ultimo

Último dia do período de convivência

Toda versão

retired -

Retired com período de convivência

último

Último dia do período

convivencia 

convivência

 Último dia do período convivência

Toda versão

retired -

Retired sem período de convivência

dia

Dia do go-live da nova versão

 

...

 Dia do go-live da nova versão