Adição de versionamento obrigatórios no header e response da API
De acordo com a deliberação no GT de Escopo de Dados da Estrutura Inicial e Conselho Deliberativo de Open Insurance as APIs person, capitalization-title e pension-plan da Fase 1 serão multiversionadas.
A convivência das versões v1.3.0 e v1.4.0 iniciará em 14/11/2024 e ira até 13/05/2025 quando se encerra o período de convivência entre as versões após 180 dias.
Mais informações sobre o multi versionamento:
O header e response das APIs deverão ficar como sugere o exemplo da API de pension plan versão 1.4.0 abaixo:
Exemplo de Header e Response
get:
...
parameters:
...
- $ref: "#/components/parameters/x-v"
- $ref: "#/components/parameters/x-min-v"
responses:
'200':
description: Dados dos Plano de Previdência com cobertura de risco
content:
application/json:
schema:
$ref: '#/components/schemas/ResponsePensionPlanList'
headers:
x-v:
description: |
Caso x-min-v e x-v tenham sido enviados, o titular dos dados deve responder
com a versao mais alta suportada entre x-min-v e x-v.
Caso x-min-v e x-v nao tenham sido enviados, o titular dos dados deve responder
com a versao que esta sendo utilizada naquele momento.
required: true
schema:
type: string
...
'500':
$ref: '#/components/responses/InternalServerError'
default:
description: Dados dos Plano de Previdência com cobertura de risco
content:
application/json:
schema:
$ref: '#/components/schemas/ResponsePensionPlanList'
headers:
x-v:
description: |
Caso x-min-v e x-v tenham sido enviados, o titular dos dados deve responder
com a versao mais alta suportada entre x-min-v e x-v.
Caso x-min-v e x-v nao tenham sido enviados, o titular dos dados deve responder
com a versao que esta sendo utilizada naquele momento.
required: true
schema:
type: string
...
parameters:
...
x-v:
name: x-v
in: header
description: |
Versão do endpoint da API requisitado pelo cliente. O titular dos dados deve
responder com a versão mais alta suportada entre x-min-v e x-v. Se o valor de
x-min-v for igual ou maior que o valor de x-v, o cabeçalho x-min-v deve ser
tratado como ausente. Se todas as versões solicitadas não forem suportadas,
o titular dos dados deve responder com o código de status 406 Not Acceptable.
required: false
schema:
type: string
example: '2.1.3'
x-min-v:
name: x-min-v
in: header
description: |
Versão mínima do endpoint da API requisitado pelo cliente. O detentor dos dados
deve responder com a versão mais alta suportada entre x-min-v e x-v. Se todas as
versões solicitadas não forem suportadas, o titular dos dados deve responder com
um código de status 406 Not Acceptable.
required: false
schema:
type: string
example: '2.0.0'
Especificação em OAS 3.0
⚙️ Download da Especificação
📑 Release Notes: