Skip to content

Commit 83d8ce3

Browse files
authored
Merge pull request #201479 from mcevoy-building7/dicom-version-required
versioning is now required for DICOM APIs
2 parents ffe8514 + daeae31 commit 83d8ce3

File tree

2 files changed

+18
-10
lines changed

2 files changed

+18
-10
lines changed

articles/healthcare-apis/dicom/api-versioning-dicom-service.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
2-
title: API Versioning for DICOM service - Azure Health Data Services
2+
title: API versioning for DICOM service - Azure Health Data Services
33
description: This guide gives an overview of the API version policies for the DICOM service.
44
services: healthcare-apis
55
author: stevewohl
66
ms.service: healthcare-apis
77
ms.subservice: fhir
88
ms.topic: reference
9-
ms.date: 02/24/2022
10-
ms.author: aersoy
9+
ms.date: 06/11/2022
10+
ms.author: v-smcevoy
1111
---
1212

1313
# API versioning for DICOM service
@@ -18,11 +18,12 @@ All versions of the DICOM APIs will always conform to the DICOMweb™ Standard s
1818

1919
## Specifying version of REST API in requests
2020

21-
The version of the REST API should be explicitly specified in the request URL as in the following example:
21+
The version of the REST API must be explicitly specified in the request URL as in the following example:
2222

2323
`<service_url>/v<version>/studies`
2424

25-
Currently routes without a version are still supported. For example, `<service_url>/studies` has the same behavior as specifying the version as v1.0-prerelease. However, we strongly recommend that you specify the version in all requests via the URL as routes without a version won't be supported after the General Availability release of the DICOM service.
25+
> [!NOTE]
26+
> Routes without a version are no longer supported.
2627
2728
## Supported versions
2829

@@ -32,8 +33,8 @@ Currently the supported versions are:
3233
* v1
3334

3435
The OpenApi Doc for the supported versions can be found at the following url:
35-
36-
`<service_url>/{version}/api.yaml`
36+
37+
`<service_url>/v<version>/api.yaml`
3738

3839
## Prerelease versions
3940

articles/healthcare-apis/dicom/dicom-services-conformance-statement.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ author: stevewohl
66
ms.service: healthcare-apis
77
ms.subservice: fhir
88
ms.topic: reference
9-
ms.date: 02/24/2022
10-
ms.author: aersoy
9+
ms.date: 06/10/2022
10+
ms.author: v-smcevoy
1111
---
1212

1313
# DICOM Conformance Statement
@@ -22,7 +22,14 @@ Additionally, the following non-standard API(s) are supported:
2222

2323
- [Delete](#delete)
2424

25-
Our service also makes use of REST API versioning. For information on how to specify the version when making requests visit the [API Versioning for DICOM service Documentation](api-versioning-dicom-service.md).
25+
Our service makes use of REST API versioning.
26+
27+
> [!NOTE]
28+
> The version of the REST API must be explicitly specified in the request URL as in the following example:
29+
>
30+
> `https://<service_url>/v<version>/studies`
31+
32+
For information on how to specify the version when making requests visit the [API Versioning for DICOM service documentation](api-versioning-dicom-service.md).
2633

2734
## Store (STOW-RS)
2835

0 commit comments

Comments
 (0)