Skip to content

Commit fc9efad

Browse files
committed
gh-434 Update documentation
Signed-off-by: Victor Chang <[email protected]>
1 parent 4cc4b0d commit fc9efad

File tree

2 files changed

+88
-0
lines changed

2 files changed

+88
-0
lines changed

docs/api/rest/config.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -285,6 +285,41 @@ curl --location --request DELETE 'http://localhost:5000/config/ae/breast-tumor'
285285

286286
---
287287

288+
## GET /config/ae/plug-ins
289+
290+
Returns a list of data input plug-ins that can be used with SCP Application Entity.
291+
292+
### Parameters
293+
294+
N/A
295+
296+
### Responses
297+
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.
299+
300+
| Code | Description |
301+
| ---- | --------------------------------------------------------------------------------------------------------------------------------------- |
302+
| 200 | Plug-ins retrieved successfully. |
303+
| 500 | Server error. The response will be a [Problem details](https://datatracker.ietf.org/doc/html/rfc7807) object with server error details. |
304+
305+
### Example Request
306+
307+
```bash
308+
curl --location --request GET 'http://localhost:5000/config/ae/plug-ins'
309+
```
310+
311+
### Example Response
312+
313+
```json
314+
{
315+
"testInputDataPluginAddWorkflow": "Monai.Deploy.InformaticsGateway.Test.Plugins.TestInputDataPluginAddWorkflow, Monai.Deploy.InformaticsGateway.Test.Plugins, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null",
316+
"testInputDataPluginResumeWorkflow": "Monai.Deploy.InformaticsGateway.Test.Plugins.TestInputDataPluginResumeWorkflow, Monai.Deploy.InformaticsGateway.Test.Plugins, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null",
317+
"testInputDataPluginModifyDicomFile": "Monai.Deploy.InformaticsGateway.Test.Plugins.TestInputDataPluginModifyDicomFile, Monai.Deploy.InformaticsGateway.Test.Plugins, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
318+
}
319+
```
320+
321+
---
322+
288323
## GET /config/source
289324

290325
Returns a list of calling (source) AE Titles configured on the Informatics Gateway.
@@ -768,3 +803,38 @@ curl --location --request DELETE 'http://localhost:5000/config/destination/USEAS
768803
"hostIp": "10.20.3.4"
769804
}
770805
```
806+
---
807+
808+
## GET /config/destination/plug-ins
809+
810+
Returns a list of data output plug-ins that can be used with SCP Application Entity.
811+
812+
### Parameters
813+
814+
N/A
815+
816+
### Responses
817+
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+
820+
| Code | Description |
821+
| ---- | --------------------------------------------------------------------------------------------------------------------------------------- |
822+
| 200 | Plug-ins retrieved successfully. |
823+
| 500 | Server error. The response will be a [Problem details](https://datatracker.ietf.org/doc/html/rfc7807) object with server error details. |
824+
825+
### Example Request
826+
827+
```bash
828+
curl --location --request GET 'http://localhost:5000/config/destination/plug-ins'
829+
```
830+
831+
### Example Response
832+
833+
```json
834+
{
835+
"testOutputDataPluginAddMessage": "Monai.Deploy.InformaticsGateway.Test.Plugins.TestOutputDataPluginAddMessage, Monai.Deploy.InformaticsGateway.Test.Plugins, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null",
836+
"testOutputDataPluginModifyDicomFile": "Monai.Deploy.InformaticsGateway.Test.Plugins.TestOutputDataPluginModifyDicomFile, Monai.Deploy.InformaticsGateway.Test.Plugins, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
837+
}
838+
```
839+
840+
---

docs/setup/setup.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,18 @@ This section outlines the steps to download and install the Informatics Gateway
2020
## Runtime Requirements
2121

2222
* Docker 20.10.12 or higher
23+
* [Database service](#database-configuration)
24+
* [Message Broker service](#message-broker)
25+
* [Storage service](#storage-service)
2326

2427
For development requirements, refer to the [Informatics Gateway README.md](https://github.com/Project-MONAI/monai-deploy-informatics-gateway).
2528

29+
> [!Note]
30+
> Use [MONAI Deploy Express](https://github.com/Project-MONAI/monai-deploy/tree/main/deploy/monai-deploy-express) to quickly
31+
> bring up all required services, including the Informatics Gateway.
32+
33+
34+
2635
## Installation
2736

2837
### Informatics Gateway CLI
@@ -358,3 +367,12 @@ The command adds a DICOM export destination with AE Title `WORKSTATION1` at IP `
358367
## Logging
359368

360369
See [schema](./schema.md#logging) page for additional information on logging.
370+
371+
## Data Plug-ins
372+
373+
You may write your own data plug-ins to manipulate incoming data before they are saved to the storage service or outgoing data right before they are exported.
374+
375+
To write an input data plug-in, implement the [IInputDataPlugin](xref:Monai.Deploy.InformaticsGateway.Api.IInputDataPlugin) interface and put the assmblye dll in the
376+
plug-ins directories. Similarly for output data plug-ins, implement the [IOutputDataPlugin](xref:Monai.Deploy.InformaticsGateway.Api.IOutputDataPlugin) interface.
377+
378+
Refer to (Configuration API)[(../api/rest/config.md] page to retrieve available [input](../api/rest/config.md#get-config-ae-plug-ins) and [output](get-config-destination-plug-ins) data plug-ins.

0 commit comments

Comments
 (0)