A política para atualização dos dados tem como propósito estabelecer as diretrizes necessárias para governança do ciclo de vida de uma API, sendo essencial para garantir a integridade dos dados, além de reduzir os riscos associados a conformidade e promover a eficiência operacional ao definir processos eficazes para gerenciar as atualizações desses dados.
Utilizaremos como base para definição das diretrizes de atualização dos dados de API, a política de versionamento do Open Finance Brasil, uma vez que as termogias e padrões utilizados, são de conhecimento do ecossistema.
Atualização do Ciclo de Vida
Segundo a política de versionamento do Open Finance Brasil, o ciclo de vida de uma API possui 05 status após Design, considerada como status de definição da API, e portanto, 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 | data da divulgação da primeira versão da especificação (beta.0) | Dia do primeiro marco |
Toda versão implementing sem certificação | data da divulgação da especificação (beta.0) | data do go-live |
Toda versão certifying | Dia do primeiro marco | fim do período do processamento de pedidos de certificação |
Toda versão current | data do go-live | - |
Toda versão deprecated | data do go-live | ultimo dia do período de convivência |
Toda versão retired - com período de convivência | último dia do período convivencia |
|
Toda versão retired - sem período de convivência | dia do go-live da nova versão |
|
Data de deprecated ou certifying porque é uma versão PATCH