Skip to content

Commit c91f3b7

Browse files
Coco-BenCoco-Ben
authored
Copyedit doc changes for the 0.4.0 release (#464)
1 parent a281db0 commit c91f3b7

File tree

8 files changed

+112
-94
lines changed

8 files changed

+112
-94
lines changed

‎docs/api/rest/config.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -287,19 +287,20 @@ curl --location --request DELETE 'http://localhost:5000/config/ae/breast-tumor'
287287

288288
## GET /config/ae/plug-ins
289289

290-
Returns a list of data input plug-ins that can be used with SCP Application Entity.
290+
Returns a list of data input plug-ins that can be used with the SCP Application Entity.
291291

292292
### Parameters
293293

294294
N/A
295295

296296
### Responses
297297

298-
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.
298+
Response Content Type: JSON - An object containing zero or more key-value pairs, where the key is the name of the plug-in and
299+
the value is the fully qualified assembly type name of the plug-in.
299300

300301
| Code | Description |
301302
| ---- | --------------------------------------------------------------------------------------------------------------------------------------- |
302-
| 200 | Plug-ins retrieved successfully. |
303+
| 200 | Plug-ins retrieved successfully. |
303304
| 500 | Server error. The response will be a [Problem details](https://datatracker.ietf.org/doc/html/rfc7807) object with server error details. |
304305

305306
### Example Request
@@ -807,19 +808,20 @@ curl --location --request DELETE 'http://localhost:5000/config/destination/USEAS
807808

808809
## GET /config/destination/plug-ins
809810

810-
Returns a list of data output plug-ins that can be used with SCP Application Entity.
811+
Returns a list of data output plug-ins that can be used with the SCP Application Entity.
811812

812813
### Parameters
813814

814815
N/A
815816

816817
### Responses
817818

818-
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.
819+
Response Content Type: JSON - An object containing zero or more key-value pairs, where the key is the name of the plug-in
820+
and the value is the fully qualified assembly type name of the plug-in.
819821

820822
| Code | Description |
821823
| ---- | --------------------------------------------------------------------------------------------------------------------------------------- |
822-
| 200 | Plug-ins retrieved successfully. |
824+
| 200 | Plug-ins retrieved successfully. |
823825
| 500 | Server error. The response will be a [Problem details](https://datatracker.ietf.org/doc/html/rfc7807) object with server error details. |
824826

825827
### Example Request

‎docs/api/rest/dicomweb-stow.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Triggers a new workflow request with the uploaded DICOM dataset.
4141

4242
| Name | Type | Description |
4343
| ------------------ | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
44-
| 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`. |
44+
| 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`. |
4545

4646
#### Request Body
4747

@@ -85,7 +85,7 @@ Triggers the specified workflow with the uploaded DICOM dataset.
8585
| Name | Type | Description |
8686
| ------------------ | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
8787
| workflow-id | string | The unique identifier of the workflow registered with the Workflow Manager. |
88-
| 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`. |
88+
| 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`. |
8989

9090
#### Request Body
9191

@@ -101,12 +101,12 @@ Response Content Type: `JSON`
101101
| Code | Data Type | Description |
102102
| ---- | --------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
103103
| 200 | [DicomDataset](https://github.com/fo-dicom/fo-dicom/blob/development/FO-DICOM.Core/DicomDataset.cs) | All instances are received and stored successfully. |
104-
| 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. |
104+
| 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).|
105105
| 204 | `none` | No data is provided. |
106106
| 400 | [Problem details](https://datatracker.ietf.org/doc/html/rfc7807) | Request contains invalid values. |
107-
| 415 | `none` | Unsupported media type. |
108-
| 500 | [Problem details](https://datatracker.ietf.org/doc/html/rfc7807) | Server error. |
109-
| 507 | [Problem details](https://datatracker.ietf.org/doc/html/rfc7807) | Insufficient storage. |
107+
| 415 | `none` | Unsupported media type |
108+
| 500 | [Problem details](https://datatracker.ietf.org/doc/html/rfc7807) | Server error |
109+
| 507 | [Problem details](https://datatracker.ietf.org/doc/html/rfc7807) | Insufficient storage |
110110

111111
---
112112

@@ -133,9 +133,9 @@ takes precedence when specified.
133133

134134
| Name | Type | Description |
135135
| ------------------ | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
136-
| aet | string | A registered Virtual Application Entity. |
137-
| workflow-id | string | The unique identifier of the workflow registered with the Workflow Manager. |
138-
| 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`. |
136+
| aet | string | A registered Virtual Application Entity |
137+
| workflow-id | string | The unique identifier of the workflow registered with the Workflow Manager |
138+
| 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`.|
139139

140140
#### Request Body
141141

@@ -154,6 +154,6 @@ Response Content Type: `JSON`
154154
| 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. |
155155
| 204 | `none` | No data is provided. |
156156
| 400 | [Problem details](https://datatracker.ietf.org/doc/html/rfc7807) | Request contains invalid values. |
157-
| 415 | `none` | Unsupported media type. |
158-
| 500 | [Problem details](https://datatracker.ietf.org/doc/html/rfc7807) | Server error. |
159-
| 507 | [Problem details](https://datatracker.ietf.org/doc/html/rfc7807) | Insufficient storage. |
157+
| 415 | `none` | Unsupported media type |
158+
| 500 | [Problem details](https://datatracker.ietf.org/doc/html/rfc7807) | Server error |
159+
| 507 | [Problem details](https://datatracker.ietf.org/doc/html/rfc7807) | Insufficient storage |

‎docs/changelog.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
[GitHub Milestone 0.4.0](https://github.com/Project-MONAI/monai-deploy-informatics-gateway/milestone/5)
2323

2424
- gh-435 Fix CLI to read log dir path from NLog config file.
25-
- gh-425 New Virtual Application Entity support for DICOMWeb STOW-RS APIs to enable dynamic endpoints.
25+
- gh-425 New Virtual Application Entity support for DICOMWeb STOW-RS APIs to enable dynamic endpoints
2626
- gh-421 Integrate updated Workflow Request data structure to support multiple sources.
2727
- New data [plug-ins](./plug-ins/overview.md) feature to manipulate incoming outgoing data.
2828

@@ -31,7 +31,7 @@
3131

3232
[GitHub Milestone 0.3.21](https://github.com/Project-MONAI/monai-deploy-informatics-gateway/milestone/26)
3333

34-
- Remove the need to double copy files to storage service.
34+
- Remove the need to double-copy files to storage service.
3535

3636
## 0.3.20
3737

@@ -43,26 +43,26 @@
4343

4444
[GitHub Milestone 0.3.19](https://github.com/Project-MONAI/monai-deploy-informatics-gateway/milestone/24)
4545

46-
- gh-392 Fix GET /config/aetitle URL.
46+
- gh-392 Fix GET `/config/aetitle` URL.
4747

4848
## 0.3.18
4949

5050
[GitHub Milestone 0.3.18](https://github.com/Project-MONAI/monai-deploy-informatics-gateway/milestone/23)
5151

52-
- gh-390 New API to retrieve registered source AETs.
52+
- gh-390 New API to retrieve registered source AETs
5353

5454
## 0.3.11
5555

5656
[GitHub Milestone 0.3.17](https://github.com/Project-MONAI/monai-deploy-informatics-gateway/milestone/22)
5757

58-
- gh-385 Resets ActionBlock if faulted or cancelled in Payload assembler pipeline.
58+
- gh-385 Resets ActionBlock if faulted or cancelled in the Payload assembler pipeline.
5959

6060

6161
## 0.3.16
6262

6363
[GitHub Milestone 0.3.16](https://github.com/Project-MONAI/monai-deploy-informatics-gateway/milestone/21)
6464

65-
- gh-347 Set time limit when calling Storage List/Verify APIs
65+
- gh-347 Set time limit when calling Storage List/Verify APIs.
6666

6767
## 0.3.15
6868

‎docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Licensed under the [Apache-2.0](https://github.com/Project-MONAI/monai-deploy-in
4747

4848
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).
4949

50-
By downloading this software, you agree to the license terms & all licenses listed on the [third-party licenses](./compliance/third-party-licenses.md) page.
50+
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.
5151

5252
## Links
5353

0 commit comments

Comments
 (0)