Comparação de Páginas

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 etapas após Design, considerada como etapa de concepção da API, logo, não incluímos como parte do processo. Portanto, a regra para atualização do ciclo de vida, deverá ocorrer quando:

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

...

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

...

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 de Certifying ou Deprecated 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:

...