Versão da API para o serviço DICOM

Importante

As APIs de serviços de saúde do Azure estão atualmente em VERSÃO PRÉVIA. Os Termos de Uso Complementares para Versões Prévias do Microsoft Azure incluem termos legais adicionais que se aplicam aos recursos do Azure que estão em versão beta, versão prévia ou que, de outra forma, ainda não foram lançados em disponibilidade geral.

Este guia de referência fornece uma visão geral das políticas de versão da API para o serviço DICOM.

Todas as versões das APIs diCOM sempre estarão em conformidade com as especificações DICOMweb™ Standard, mas as versões podem expor DIFERENTES APIs com base na Instrução de conformidade diCOM.

Especificando a versão da API REST em solicitações

A versão da API REST deve ser especificada explicitamente na URL de solicitação, como no exemplo a seguir:

<service_url>/v<version>/studies

Atualmente, ainda há suporte para rotas sem uma versão. Por exemplo, <service_url>/studies tem o mesmo comportamento de especificar a versão como v1.0-prerelease. No entanto, é altamente recomendável que você especifique a versão em todas as solicitações por meio da URL.

Versões com suporte

Atualmente, as versões com suporte são:

  • v1.0-prerelease

O OpenApi Doc para as versões com suporte pode ser encontrado na seguinte URL:

<service_url>/{version}/api.yaml

Versões de pré-lançamento

Uma versão da API com o rótulo "pré-lançamento" indica que a versão não está pronta para produção e só deve ser usada em ambientes de teste. Esses pontos de extremidade podem ter alterações significativas sem aviso prévio.

Como as versões são incrementadas

Atualmente, incrementamos apenas a versão principal sempre que há uma alteração da quebra, que é considerada não compatível com versões anteriores. Todas as versões secundárias são implícitas como 0. Todas as versões estão no formato Major.0 .

Abaixo estão alguns exemplos de alterações significativas (a versão principal é incrementada):

  1. Renomeando ou removendo pontos de extremidade.
  2. Removendo parâmetros ou adicionando parâmetros obrigatórios.
  3. Alterando o código de status.
  4. Excluir uma propriedade em uma resposta ou alterar um tipo de resposta, mas não há problema em adicionar propriedades à resposta.
  5. Alterando o tipo de uma propriedade.
  6. Comportamento quando uma API muda, como alterações na lógica de negócios usadas para fazer foo, mas agora ela faz a barra.

Alterações não significativas (a versão não é incrementada):

  1. Adição de propriedades que são anuladas ou têm um valor padrão.
  2. Adição de propriedades a um modelo de resposta.
  3. Alterando a ordem das propriedades.

Header em resposta

ReportApiVersions está ligado, o que significa que retornaremos os headers api-supported-versions e api-deprecated-versions quando apropriado.

  • as versões com suporte da API listam quais versões têm suporte para a API solicitada. Ele só é retornado ao chamar um ponto de extremidade anotado com ApiVersion("<someVersion>") .

  • api-deprecated-versions lista quais versões foram preterida para a API solicitada. Ele só é retornado ao chamar um ponto de extremidade anotado com ApiVersion("<someVersion>", Deprecated = true) .

Exemplo:

ApiVersion("1.0")

ApiVersion("1.0-prerelease", Preterido = true)

Versões com suporte e preterido da API.