Skip to content

Commit 390160d

Browse files
mocsharpmocsharp
committed
Update CI workflow for Docker image tagging and improve documentation references
- Changed Docker image tag from SEMVER to MAJORMINORPATCH in CI workflow. - Updated DocFX installation method to use dotnet tool update. - Adjusted documentation references to point to the correct Models namespace for MonaiApplicationEntity and DestinationApplicationEntity. Signed-off-by: Victor Chang <vicchang@nvidia.com>
1 parent cdb856f commit 390160d

File tree

3 files changed

+18
-21
lines changed

3 files changed

+18
-21
lines changed

‎.github/workflows/ci.yml‎

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -429,7 +429,7 @@ jobs:
429429
with:
430430
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
431431
tags: |
432-
type=raw,value=${{ env.SEMVER }}
432+
type=raw,value=${{ env.MAJORMINORPATCH }}
433433
type=raw,value=latest,enable=${{ endsWith(github.ref, github.event.repository.default_branch) }}
434434
435435
- name: Build and push Docker image
@@ -506,9 +506,7 @@ jobs:
506506
${{ runner.os }}-nuget
507507
508508
- name: Setup DocFX
509-
uses: crazy-max/ghaction-chocolatey@v3
510-
with:
511-
args: install docfx
509+
run: dotnet tool update -g docfx
512510

513511
- name: Restore dependencies
514512
run: dotnet restore
@@ -524,8 +522,7 @@ jobs:
524522
sed -i -e "s,v0.0.0,v${{ env.SEMVER }},g" ./docs/index.md
525523
526524
- name: Build Docs
527-
working-directory: docs
528-
run: docfx docfx.json
525+
run: ~/.dotnet/tools/docfx docs/docfx.json
529526
continue-on-error: false
530527

531528
- name: Package docs

‎docs/api/rest/config.md‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ N/A
2828

2929
### Responses
3030

31-
Response Content Type: JSON - Array of [MonaiApplicationEntity](xref:Monai.Deploy.InformaticsGateway.Api.MonaiApplicationEntity).
31+
Response Content Type: JSON - Array of [MonaiApplicationEntity](xref:Monai.Deploy.InformaticsGateway.Api.Models.MonaiApplicationEntity).
3232

3333
| Code | Description |
3434
| ---- | --------------------------------------------------------------------------------------------------------------------------------------- |
@@ -84,7 +84,7 @@ Returns the configuration of the specified MONAI SCP AE Title.
8484

8585
### Responses
8686

87-
Response Content Type: JSON - [MonaiApplicationEntity](xref:Monai.Deploy.InformaticsGateway.Api.MonaiApplicationEntity).
87+
Response Content Type: JSON - [MonaiApplicationEntity](xref:Monai.Deploy.InformaticsGateway.Api.Models.MonaiApplicationEntity).
8888

8989
| Code | Description |
9090
| ---- | --------------------------------------------------------------------------------------------------------------------------------------- |
@@ -130,12 +130,12 @@ Creates a new MONAI SCP Application Entity to accept DICOM instances.
130130
131131
### Parameters
132132

133-
See the [MonaiApplicationEntity](xref:Monai.Deploy.InformaticsGateway.Api.MonaiApplicationEntity)
133+
See the [MonaiApplicationEntity](xref:Monai.Deploy.InformaticsGateway.Api.Models.MonaiApplicationEntity)
134134
class definition for details.
135135

136136
### Responses
137137

138-
Response Content Type: JSON - [MonaiApplicationEntity](xref:Monai.Deploy.InformaticsGateway.Api.MonaiApplicationEntity).
138+
Response Content Type: JSON - [MonaiApplicationEntity](xref:Monai.Deploy.InformaticsGateway.Api.Models.MonaiApplicationEntity).
139139

140140
| Code | Description |
141141
| ---- | ------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -198,12 +198,12 @@ Updates an existing MONAI SCP Application Entity.
198198
199199
### Parameters
200200

201-
See the [MonaiApplicationEntity](xref:Monai.Deploy.InformaticsGateway.Api.MonaiApplicationEntity)
201+
See the [MonaiApplicationEntity](xref:Monai.Deploy.InformaticsGateway.Api.Models.MonaiApplicationEntity)
202202
class definition for details.
203203

204204
### Responses
205205

206-
Response Content Type: JSON - [MonaiApplicationEntity](xref:Monai.Deploy.InformaticsGateway.Api.MonaiApplicationEntity).
206+
Response Content Type: JSON - [MonaiApplicationEntity](xref:Monai.Deploy.InformaticsGateway.Api.Models.MonaiApplicationEntity).
207207

208208
| Code | Description |
209209
| ---- | ------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -259,7 +259,7 @@ Deletes the specified MONAI SCP Application Entity.
259259

260260
### Responses
261261

262-
Response Content Type: JSON - [MonaiApplicationEntity](xref:Monai.Deploy.InformaticsGateway.Api.MonaiApplicationEntity).
262+
Response Content Type: JSON - [MonaiApplicationEntity](xref:Monai.Deploy.InformaticsGateway.Api.Models.MonaiApplicationEntity).
263263

264264
| Code | Description |
265265
| ---- | ---------------------------------------------------------------------------------------------------------------------------------------- |
@@ -576,7 +576,7 @@ N/A
576576

577577
### Responses
578578

579-
Response Content Type: JSON - Array of [DestinationApplicationEntity](xref:Monai.Deploy.InformaticsGateway.Api.DestinationApplicationEntity).
579+
Response Content Type: JSON - Array of [DestinationApplicationEntity](xref:Monai.Deploy.InformaticsGateway.Api.Models.DestinationApplicationEntity).
580580

581581
| Code | Description |
582582
| ---- | --------------------------------------------------------------------------------------------------------------------------------------- |
@@ -622,7 +622,7 @@ Retrieves the destination AE Title with the specified name.
622622

623623
### Responses
624624

625-
Response Content Type: JSON - [DestinationApplicationEntity](xref:Monai.Deploy.InformaticsGateway.Api.DestinationApplicationEntity).
625+
Response Content Type: JSON - [DestinationApplicationEntity](xref:Monai.Deploy.InformaticsGateway.Api.Models.DestinationApplicationEntity).
626626

627627
| Code | Description |
628628
| ---- | --------------------------------------------------------------------------------------------------------------------------------------- |
@@ -683,12 +683,12 @@ Updates an existing DICOM destination.
683683

684684
### Parameters
685685

686-
See the [DestinationApplicationEntity](xref:Monai.Deploy.InformaticsGateway.Api.DestinationApplicationEntity)
686+
See the [DestinationApplicationEntity](xref:Monai.Deploy.InformaticsGateway.Api.Models.DestinationApplicationEntity)
687687
class definition for details.
688688

689689
### Responses
690690

691-
Response Content Type: JSON - [DestinationApplicationEntity](xref:Monai.Deploy.InformaticsGateway.Api.DestinationApplicationEntity).
691+
Response Content Type: JSON - [DestinationApplicationEntity](xref:Monai.Deploy.InformaticsGateway.Api.Models.DestinationApplicationEntity).
692692

693693
| Code | Description |
694694
| ---- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -729,12 +729,12 @@ Adds a new DICOM destination AET for exporting results to.
729729

730730
### Parameters
731731

732-
See the [DestinationApplicationEntity](xref:Monai.Deploy.InformaticsGateway.Api.DestinationApplicationEntity)
732+
See the [DestinationApplicationEntity](xref:Monai.Deploy.InformaticsGateway.Api.Models.DestinationApplicationEntity)
733733
class definition for details.
734734

735735
### Responses
736736

737-
Response Content Type: JSON - [DestinationApplicationEntity](xref:Monai.Deploy.InformaticsGateway.Api.DestinationApplicationEntity).
737+
Response Content Type: JSON - [DestinationApplicationEntity](xref:Monai.Deploy.InformaticsGateway.Api.Models.DestinationApplicationEntity).
738738

739739
| Code | Description |
740740
| ---- | --------------------------------------------------------------------------------------------------------------------------------------- |
@@ -780,7 +780,7 @@ Deletes a Destination AE Title.
780780

781781
### Responses
782782

783-
Response Content Type: JSON - [DestinationApplicationEntity](xref:Monai.Deploy.InformaticsGateway.Api.DestinationApplicationEntity).
783+
Response Content Type: JSON - [DestinationApplicationEntity](xref:Monai.Deploy.InformaticsGateway.Api.Models.DestinationApplicationEntity).
784784

785785
| Code | Description |
786786
| ---- | --------------------------------------------------------------------------------------------------------------------------------------- |

‎src/Api/Hl7ApplicationConfigEntity.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ public sealed class Hl7ApplicationConfigEntity : MongoDBEntityBase
5656
public List<StringKeyValuePair> DataMapping { get; set; } = new();
5757

5858
/// <summary>
59-
/// Optional list of data input plug-in type names to be executed by the <see cref="IInputHL7DataPlugInEngine"/>.
59+
/// Optional list of data input plug-in type names to be executed by the <see cref="Monai.Deploy.InformaticsGateway.Api.PlugIns.IInputHL7DataPlugInEngine"/>.
6060
/// </summary>
6161
public List<string> PlugInAssemblies { get; set; } = default!;
6262

0 commit comments

Comments
 (0)