...
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.
Toda API precisa ter uma versão em current, exceto para os novos produtos.
...
Status
...
Data de início
...
Data final
...
Toda versão implementing com certificação
...
. Portanto, a regra para atualização do ciclo de vida, deverá ocorrer quando:
Houverem mudanças 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 Status, deverão ser consideradas como regras gerais:
A API DEVERÁ conter um ÚNICO Status
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 deCertifying
ouDeprecated
podem ser nulas (NULL
), tendo em vista que não há um período de convivência.As datas de início e fim do Status NÃO DEVERÃO ser IDÊNTICAS, EXCETO para os Status de
Retired
.
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 FIM |
Todo Status | Data da divulgação da primeira versão da especificação (beta.0) | Dia do primeiro marco |
Todo Status |
Data da divulgação da especificação (beta.0) |
Data do go-live |
Todo Status | Dia do primeiro marco |
Fim do período do processamento de pedidos de certificação |
Toda versão current
Todo Status | Data do go-live |
|
Todo Status | Data do go-live | Último dia do período convivência |
Todo Status | Data do go- |
Toda versão deprecated
live | Dia do go-live da nova versão |
Todo Status | Data do go-live |
Último dia do período de convivência |
Todo Status |
|
|
Todo Status |
Último dia do período |
convivência | Último dia do período convivência |
Todo Status |
Dia do go-live da nova versão |
...
Dia do go-live da nova versão |