Skip to content

Commit c6c7c5d

Browse files
authored
Merge pull request #235280 from mmitrik/mmitrik/v2-api-changes
Adds DICOM Conformance Statement V2
2 parents 78b7f95 + a7201fa commit c6c7c5d

File tree

4 files changed

+1137
-181
lines changed

4 files changed

+1137
-181
lines changed

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

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -14,28 +14,34 @@ ms.author: mmitrik
1414

1515
This reference guide provides you with an overview of the API version policies for the DICOM service.
1616

17-
All versions of the DICOM APIs will always conform to the DICOMweb™ Standard specifications, but versions may expose different APIs based on the [DICOM Conformance Statement](dicom-services-conformance-statement.md).
18-
1917
## Specifying version of REST API in requests
2018

2119
The version of the REST API must be explicitly specified in the request URL as in the following example:
2220

2321
`<service_url>/v<version>/studies`
2422

2523
> [!NOTE]
26-
> Routes without a version are no longer supported.
24+
> Routes without a version are not supported.
2725
2826
## Supported versions
2927

3028
Currently the supported versions are:
3129

3230
* v1.0-prerelease
3331
* v1
32+
* v2
3433

3534
The OpenAPI Doc for the supported versions can be found at the following url:
3635

3736
`<service_url>/v<version>/api.yaml`
3837

38+
## DICOM Conformance Statement
39+
All versions of the DICOM APIs will always conform to the DICOMweb™ Standard specifications, but different versions may expose different APIs. See the specific version of the conformance statement for details:
40+
41+
* [DICOM Conformance Statement v1](dicom-services-conformance-statement.md)
42+
* [DICOM Conformance Statement v2](dicom-services-conformance-statement-v2.md)
43+
44+
3945
## Prerelease versions
4046

4147
An API version with the label "prerelease" indicates that the version isn't ready for production, and it should only be used in testing environments. These endpoints may experience breaking changes without notice.
@@ -46,18 +52,18 @@ We currently only increment the major version whenever there's a breaking change
4652

4753
Below are some examples of breaking changes (Major version is incremented):
4854

49-
1. Renaming or removing endpoints.
50-
2. Removing parameters or adding mandatory parameters.
51-
3. Changing status code.
52-
4. Deleting a property in a response, or altering a response type at all, but it's okay to add properties to the response.
53-
5. Changing the type of a property.
54-
6. Behavior when an API changes such as changes in business logic used to do foo, but it now does bar.
55+
* Renaming or removing endpoints.
56+
* Removing parameters or adding mandatory parameters.
57+
* Changing status code.
58+
* Deleting a property in a response, or altering a response type at all, but it's okay to add properties to the response.
59+
* Changing the type of a property.
60+
* Behavior when an API changes such as changes in business logic used to do foo, but it now does bar.
5561

5662
Non-breaking changes (Version isn't incremented):
5763

58-
1. Addition of properties that are nullable or have a default value.
59-
2. Addition of properties to a response model.
60-
3. Changing the order of properties.
64+
* Addition of properties that are nullable or have a default value.
65+
* Addition of properties to a response model.
66+
* Changing the order of properties.
6167

6268
## Header in response
6369

0 commit comments

Comments
 (0)