You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/healthcare-apis/dicom/api-versioning-dicom-service.md
+18-12Lines changed: 18 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,28 +14,34 @@ ms.author: mmitrik
14
14
15
15
This reference guide provides you with an overview of the API version policies for the DICOM service.
16
16
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
-
19
17
## Specifying version of REST API in requests
20
18
21
19
The version of the REST API must be explicitly specified in the request URL as in the following example:
22
20
23
21
`<service_url>/v<version>/studies`
24
22
25
23
> [!NOTE]
26
-
> Routes without a version are no longer supported.
24
+
> Routes without a version are not supported.
27
25
28
26
## Supported versions
29
27
30
28
Currently the supported versions are:
31
29
32
30
* v1.0-prerelease
33
31
* v1
32
+
* v2
34
33
35
34
The OpenAPI Doc for the supported versions can be found at the following url:
36
35
37
36
`<service_url>/v<version>/api.yaml`
38
37
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:
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
46
52
47
53
Below are some examples of breaking changes (Major version is incremented):
48
54
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.
55
61
56
62
Non-breaking changes (Version isn't incremented):
57
63
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.
0 commit comments