docs: add openapi comments for isRecycle

Chinlinlee · Jan 6, 2024 · 1c8350e · 1c8350e
1 parent 1c7bf4a
commit 1c8350e
Show file tree

Hide file tree

Showing 3 changed files with 39 additions and 1 deletion.
diff --git a/api/dicom-web/qido-rs.route.js b/api/dicom-web/qido-rs.route.js
@@ -65,6 +65,7 @@ function convertKeywordToHex(attribute) {
  *        - $ref: "#/components/parameters/PatientName"
  *        - $ref: "#/components/parameters/PatientID"
  *        - $ref: "#/components/parameters/StudyID"
+ *        - $ref: "#/components/parameters/isRecycle"
  *      responses:
  *        200:
  *          description: Query successfully
@@ -99,6 +100,7 @@ router.get("/studies", validateParams(queryValidation, "query", {
  *        - $ref: "#/components/parameters/StudyID"
  *        - $ref: "#/components/parameters/Modality"
  *        - $ref: "#/components/parameters/SeriesNumber"
+ *        - $ref: "#/components/parameters/isRecycle"
  *      responses:
  *        200:
  *          description: Query successfully
@@ -139,6 +141,7 @@ router.get(
  *        - $ref: "#/components/parameters/SeriesNumber"
  *        - $ref: "#/components/parameters/SOPClassUID"
  *        - $ref: "#/components/parameters/InstanceNumber"
+ *        - $ref: "#/components/parameters/isRecycle"
  *      responses:
  *        200:
  *          description: Query successfully
@@ -181,6 +184,7 @@ router.get(
  *        - $ref: "#/components/parameters/SeriesNumber"
  *        - $ref: "#/components/parameters/SOPClassUID"
  *        - $ref: "#/components/parameters/InstanceNumber"
+ *        - $ref: "#/components/parameters/isRecycle"
  *      responses:
  *        200:
  *          description: Query successfully
@@ -219,6 +223,7 @@ router.get(
  *        - $ref: "#/components/parameters/StudyID"
  *        - $ref: "#/components/parameters/Modality"
  *        - $ref: "#/components/parameters/SeriesNumber"
+ *        - $ref: "#/components/parameters/isRecycle"
  *      responses:
  *        200:
  *          description: Query successfully
@@ -259,6 +264,7 @@ router.get(
  *        - $ref: "#/components/parameters/SeriesNumber"
  *        - $ref: "#/components/parameters/SOPClassUID"
  *        - $ref: "#/components/parameters/InstanceNumber"
+ *        - $ref: "#/components/parameters/isRecycle"
  *      responses:
  *        200:
  *          description: Query successfully

diff --git a/docs/swagger/openapi.json b/docs/swagger/openapi.json
@@ -274,6 +274,9 @@
                     },
                     {
                         "$ref": "#/components/parameters/StudyID"
+                    },
+                    {
+                        "$ref": "#/components/parameters/isRecycle"
                     }
                 ],
                 "responses": {
@@ -367,6 +370,9 @@
                     },
                     {
                         "$ref": "#/components/parameters/SeriesNumber"
+                    },
+                    {
+                        "$ref": "#/components/parameters/isRecycle"
                     }
                 ],
                 "responses": {
@@ -438,6 +444,9 @@
                     },
                     {
                         "$ref": "#/components/parameters/InstanceNumber"
+                    },
+                    {
+                        "$ref": "#/components/parameters/isRecycle"
                     }
                 ],
                 "responses": {
@@ -515,6 +524,9 @@
                     },
                     {
                         "$ref": "#/components/parameters/InstanceNumber"
+                    },
+                    {
+                        "$ref": "#/components/parameters/isRecycle"
                     }
                 ],
                 "responses": {
@@ -580,6 +592,9 @@
                     },
                     {
                         "$ref": "#/components/parameters/SeriesNumber"
+                    },
+                    {
+                        "$ref": "#/components/parameters/isRecycle"
                     }
                 ],
                 "responses": {
@@ -648,6 +663,9 @@
                     },
                     {
                         "$ref": "#/components/parameters/InstanceNumber"
+                    },
+                    {
+                        "$ref": "#/components/parameters/isRecycle"
                     }
                 ],
                 "responses": {
@@ -1490,6 +1508,14 @@
                     }
                 }
             },
+            "isRecycle": {
+                "name": "isRecycle",
+                "description": "Query if the instance is in recycle bin, default is false, and notice that this one is not standard by DICOM standard (i.e. raccoon custom parameter)",
+                "in": "query",
+                "schema": {
+                    "type": "boolean"
+                }
+            },
             "spsID": {
                 "in": "path",
                 "name": "spsID",

diff --git a/docs/swagger/parameters/dicomweb-common.yaml b/docs/swagger/parameters/dicomweb-common.yaml
@@ -37,4 +37,10 @@ components:
       schema:
         type: array
         items:
-          type: string
+          type: string
+    "isRecycle":
+      name: isRecycle
+      description: "Query if the instance is in recycle bin, default is false, and notice that this one is not standard by DICOM standard (i.e. raccoon custom parameter)"
+      in: query
+      schema:
+        type: boolean