Copyedit doc changes for the 0.4.0 release (#464)

Project-MONAI · Sep 1, 2023 · c91f3b7 · c91f3b7
1 parent a281db0
commit c91f3b7
Show file tree

Hide file tree

Showing 8 changed files with 112 additions and 94 deletions.
diff --git a/docs/api/rest/config.md b/docs/api/rest/config.md
@@ -287,19 +287,20 @@ curl --location --request DELETE 'http://localhost:5000/config/ae/breast-tumor'
 
 ## GET /config/ae/plug-ins
 
-Returns a list of data input plug-ins that can be used with SCP Application Entity.
+Returns a list of data input plug-ins that can be used with the SCP Application Entity.
 
 ### Parameters
 
 N/A
 
 ### Responses
 
-Response Content Type: JSON - An object containing zero or more key-value pairs where the key is the name of the plug-in and the value is the fully qualified assembly type name of the plug-in.
+Response Content Type: JSON - An object containing zero or more key-value pairs, where the key is the name of the plug-in and
+the value is the fully qualified assembly type name of the plug-in.
 
 | Code | Description                                                                                                                             |
 | ---- | --------------------------------------------------------------------------------------------------------------------------------------- |
-| 200  | Plug-ins retrieved successfully.                                                                                                       |
+| 200  | Plug-ins retrieved successfully.                                                                                                        |
 | 500  | Server error. The response will be a [Problem details](https://datatracker.ietf.org/doc/html/rfc7807) object with server error details. |
 
 ### Example Request
@@ -807,19 +808,20 @@ curl --location --request DELETE 'http://localhost:5000/config/destination/USEAS
 
 ## GET /config/destination/plug-ins
 
-Returns a list of data output plug-ins that can be used with SCP Application Entity.
+Returns a list of data output plug-ins that can be used with the SCP Application Entity.
 
 ### Parameters
 
 N/A
 
 ### Responses
 
-Response Content Type: JSON - An object containing zero or more key-value pairs where the key is the name of the plug-in and the value is the fully qualified assembly type name of the plug-in.
+Response Content Type: JSON - An object containing zero or more key-value pairs, where the key is the name of the plug-in
+and the value is the fully qualified assembly type name of the plug-in.
 
 | Code | Description                                                                                                                             |
 | ---- | --------------------------------------------------------------------------------------------------------------------------------------- |
-| 200  | Plug-ins retrieved successfully.                                                                                                       |
+| 200  | Plug-ins retrieved successfully.                                                                                                        |
 | 500  | Server error. The response will be a [Problem details](https://datatracker.ietf.org/doc/html/rfc7807) object with server error details. |
 
 ### Example Request

diff --git a/docs/api/rest/dicomweb-stow.md b/docs/api/rest/dicomweb-stow.md
@@ -41,7 +41,7 @@ Triggers a new workflow request with the uploaded DICOM dataset.
 
 | Name               | Type   | Description                                                                                                                                                                                                                     |
 | ------------------ | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| study-instance-uid | string | (Optional) Associate the DICOM dataset with a StudyInstanceUID. Note that the service records any mismatch between the StudyInstanceUID header and the provided value in the response as `Warning Reason (0008,1196)` = `B007`. |
+| study-instance-uid | string | (Optional) Associate the DICOM dataset with a StudyInstanceUID. Note that the service records any mismatch between the StudyInstanceUID header and the provided value in the response as `Warning Reason (0008,1196) = B007`.   |
 
 #### Request Body
 
@@ -85,7 +85,7 @@ Triggers the specified workflow with the uploaded DICOM dataset.
 | Name               | Type   | Description                                                                                                                                                                                                                     |
 | ------------------ | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | workflow-id        | string | The unique identifier of the workflow registered with the Workflow Manager.                                                                                                                                                     |
-| study-instance-uid | string | (Optional) Associate the DICOM dataset with a StudyInstanceUID. Note that the service records any mismatch between the StudyInstanceUID header and the provided value in the response as `Warning Reason (0008,1196)` = `B007`. |
+| study-instance-uid | string | (Optional) Associate the DICOM dataset with a StudyInstanceUID. Note that the service records any mismatch between the StudyInstanceUID header and the provided value in the response as `Warning Reason (0008,1196) = B007`.   |
 
 #### Request Body
 
@@ -101,12 +101,12 @@ Response Content Type: `JSON`
 | Code | Data Type                                                                                           | Description                                                                                  |
 | ---- | --------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
 | 200  | [DicomDataset](https://github.com/fo-dicom/fo-dicom/blob/development/FO-DICOM.Core/DicomDataset.cs) | All instances are received and stored successfully.                                          |
-| 202  | [DicomDataset](https://github.com/fo-dicom/fo-dicom/blob/development/FO-DICOM.Core/DicomDataset.cs) | All instances are received and stored with warnings (e.g. for a mismatched StudyInstanceUID. |
+| 202  | [DicomDataset](https://github.com/fo-dicom/fo-dicom/blob/development/FO-DICOM.Core/DicomDataset.cs) | All instances are received and stored with warnings (e.g. for a mismatched StudyInstanceUID).|
 | 204  | `none`                                                                                              | No data is provided.                                                                         |
 | 400  | [Problem details](https://datatracker.ietf.org/doc/html/rfc7807)                                    | Request contains invalid values.                                                             |
-| 415  | `none`                                                                                              | Unsupported media type.                                                                      |
-| 500  | [Problem details](https://datatracker.ietf.org/doc/html/rfc7807)                                    | Server error.                                                                                |
-| 507  | [Problem details](https://datatracker.ietf.org/doc/html/rfc7807)                                    | Insufficient storage.                                                                        |
+| 415  | `none`                                                                                              | Unsupported media type                                                                       |
+| 500  | [Problem details](https://datatracker.ietf.org/doc/html/rfc7807)                                    | Server error                                                                                 |
+| 507  | [Problem details](https://datatracker.ietf.org/doc/html/rfc7807)                                    | Insufficient storage                                                                         |
 
 ---
 
@@ -133,9 +133,9 @@ takes precedence when specified.
 
 | Name               | Type   | Description                                                                                                                                                                                                                     |
 | ------------------ | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| aet                | string | A registered Virtual Application Entity.                                                                                                                                                                                        |
-| workflow-id        | string | The unique identifier of the workflow registered with the Workflow Manager.                                                                                                                                                     |
-| study-instance-uid | string | (Optional) Associate the DICOM dataset with a StudyInstanceUID. Note that the service records any mismatch between the StudyInstanceUID header and the provided value in the response as `Warning Reason (0008,1196)` = `B007`. |
+| aet                | string | A registered Virtual Application Entity                                                                                                                                                                                         |
+| workflow-id        | string | The unique identifier of the workflow registered with the Workflow Manager                                                                                                                                                      |
+| study-instance-uid | string | (Optional) A StudyInstanceUID to associate the DICOM dataset with. Note that the service records any mismatch between the StudyInstanceUID header and the provided value in the response as `Warning Reason (0008,1196) = B007`.|
 
 #### Request Body
 
@@ -154,6 +154,6 @@ Response Content Type: `JSON`
 | 202  | [DicomDataset](https://github.com/fo-dicom/fo-dicom/blob/development/FO-DICOM.Core/DicomDataset.cs) | All instances are received and stored with warnings (e.g. for a mismatched StudyInstanceUID. |
 | 204  | `none`                                                                                              | No data is provided.                                                                         |
 | 400  | [Problem details](https://datatracker.ietf.org/doc/html/rfc7807)                                    | Request contains invalid values.                                                             |
-| 415  | `none`                                                                                              | Unsupported media type.                                                                      |
-| 500  | [Problem details](https://datatracker.ietf.org/doc/html/rfc7807)                                    | Server error.                                                                                |
-| 507  | [Problem details](https://datatracker.ietf.org/doc/html/rfc7807)                                    | Insufficient storage.                                                                        |
+| 415  | `none`                                                                                              | Unsupported media type                                                                       |
+| 500  | [Problem details](https://datatracker.ietf.org/doc/html/rfc7807)                                    | Server error                                                                                 |
+| 507  | [Problem details](https://datatracker.ietf.org/doc/html/rfc7807)                                    | Insufficient storage                                                                         |
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -22,7 +22,7 @@
 [GitHub Milestone 0.4.0](https://github.com/Project-MONAI/monai-deploy-informatics-gateway/milestone/5)
 
 - gh-435 Fix CLI to read log dir path from NLog config file.
-- gh-425 New Virtual Application Entity support for DICOMWeb STOW-RS APIs to enable dynamic endpoints.
+- gh-425 New Virtual Application Entity support for DICOMWeb STOW-RS APIs to enable dynamic endpoints
 - gh-421 Integrate updated Workflow Request data structure to support multiple sources.
 - New data [plug-ins](./plug-ins/overview.md) feature to manipulate incoming outgoing data.
 
@@ -31,7 +31,7 @@
 
 [GitHub Milestone 0.3.21](https://github.com/Project-MONAI/monai-deploy-informatics-gateway/milestone/26)
 
-- Remove the need to double copy files to storage service.
+- Remove the need to double-copy files to storage service.
 
 ## 0.3.20
 
@@ -43,26 +43,26 @@
 
 [GitHub Milestone 0.3.19](https://github.com/Project-MONAI/monai-deploy-informatics-gateway/milestone/24)
 
-- gh-392 Fix GET /config/aetitle URL.
+- gh-392 Fix GET `/config/aetitle` URL.
 
 ## 0.3.18
 
 [GitHub Milestone 0.3.18](https://github.com/Project-MONAI/monai-deploy-informatics-gateway/milestone/23)
 
-- gh-390 New API to retrieve registered source AETs.
+- gh-390 New API to retrieve registered source AETs
 
 ## 0.3.11
 
 [GitHub Milestone 0.3.17](https://github.com/Project-MONAI/monai-deploy-informatics-gateway/milestone/22)
 
-- gh-385 Resets ActionBlock if faulted or cancelled in Payload assembler pipeline.
+- gh-385 Resets ActionBlock if faulted or cancelled in the Payload assembler pipeline.
 
 
 ## 0.3.16
 
 [GitHub Milestone 0.3.16](https://github.com/Project-MONAI/monai-deploy-informatics-gateway/milestone/21)
 
-- gh-347 Set time limit when calling Storage List/Verify APIs
+- gh-347 Set time limit when calling Storage List/Verify APIs.
 
 ## 0.3.15
 

diff --git a/docs/index.md b/docs/index.md
@@ -47,7 +47,7 @@ Licensed under the [Apache-2.0](https://github.com/Project-MONAI/monai-deploy-in
 
 This software uses the Microsoft .NET 6.0 library, and the use of this software is subject to the [Microsoft software license terms](https://dotnet.microsoft.com/en-us/dotnet_library_license.htm).
 
-By downloading this software, you agree to the license terms & all licenses listed on the [third-party licenses](./compliance/third-party-licenses.md) page.
+By downloading this software, you agree to the license terms and all licenses listed on the [third-party licenses](./compliance/third-party-licenses.md) page.
 
 ## Links