-
Notifications
You must be signed in to change notification settings - Fork 6
feat: update project logic for nuget integration #39
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
… all related namespaces
WalkthroughThis change migrates the project from "DocumentService" to "OsmoDoc," updating namespaces, file paths, project and solution files, Docker and compose configurations, documentation, and code references. All model, helper, and generator classes for PDF and Word document processing are renamed and relocated under the new OsmoDoc structure, with equivalent functionality preserved. Changes
Sequence Diagram(s)sequenceDiagram
participant API as OsmoDoc.API
participant PdfGen as OsmoDoc.Pdf.PdfDocumentGenerator
participant WordGen as OsmoDoc.Word.WordDocumentGenerator
participant Config as OsmoDoc.Pdf.OsmoDocPdfConfig
API->>Config: Set WkhtmltopdfPath (PDF only)
API->>PdfGen: GeneratePdf(templatePath, metaDataList, outputFilePath, isEjs, ejsDataJson)
PdfGen->>PdfGen: Validate template & config
alt isEjsTemplate
PdfGen->>PdfGen: ConvertEjsToHTML()
end
PdfGen->>PdfGen: Replace placeholders in HTML
PdfGen->>PdfGen: ConvertHtmlToPdf()
PdfGen-->>API: PDF file generated
API->>WordGen: GenerateDocumentByTemplate(templatePath, documentData, outputFilePath)
WordGen->>WordGen: Load template
WordGen->>WordGen: Replace text/table/image placeholders
WordGen-->>API: Word file generated
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (1)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 11
🧹 Nitpick comments (18)
OsmoDoc/Pdf/Models/OsmoDocPdfConfig.cs (1)
3-7
: Consider using a DI-friendly configuration pattern
A static class with a mutable static property can be hard to test and configure. Consider switching to the ASP.NET Core Options pattern (IOptions<OsmoDocPdfConfig>
) for better maintainability and testability.CONTRIBUTING.md (1)
68-71
: Fix broken emoji encoding in contribution section
The replacement character�
appears instead of the intended emoji. Use proper Unicode emoji or remove the HTML entity to fix display.OsmoDoc.API/Models/PdfGenerationRequestDTO.cs (1)
8-12
: Consider enforcing required properties at compile time
Since[Required]
enforces presence at runtime, consider using non-nullable property types or the C# 11required
modifier to catch missing assignments at compile time:public required string Base64 { get; set; } public required DocumentData DocumentData { get; set; }OsmoDoc/Pdf/Models/DocumentData.cs (2)
3-3
: Remove unused using directive
using System.Text;
is not used in this file. Removing it will clean up imports.
7-10
: Consider a readonly interface-based property
To enforce immutability and hide the setter, you could exposePlaceholders
asIList<ContentMetaData>
or make it aget
-only auto-property:public IList<ContentMetaData> Placeholders { get; } = new List<ContentMetaData>();README.md (4)
27-27
: Clarify thegit clone
command
Instead of “Clone the projectosmodoc
”, consider providing the full command for clarity:git clone https://github.com/OsmosysSoftware/osmodoc.git
103-103
: Fix grammar in instructions
Update phrasing to:Go to the bin folder in your project where the
OsmoDoc.dll
is located.
126-127
: Replace hardcoded example paths
The Windows-specific absolute paths in the sample could confuse users. Use a generic placeholder or relative paths instead.
190-190
: Optimize license phrasing
Consider simplifying to:OsmoDoc is licensed under the MIT license.
OsmoDoc/Word/Models/DocumentData.cs (1)
3-3
: Remove unused using directive
System.Text
is not referenced in this file. Consider removing the unused using to keep the file clean.-using System.Text;
OsmoDoc.API/Program.cs (2)
24-26
:DotEnv.Load
may throw/file-not-found
dotenv
is computed but the code does not check if the.env
file actually exists before loading. A missing file will currently throw.
Add anif (File.Exists(dotenv))
guard or handle the exception to avoid boot-time crashes in new environments.
100-106
: Duplicate MVC registration
builder.Services.AddMvc()
is redundant afterAddControllers()
and re-adds MVC with possibly conflicting options.
If you only needConfigureApiBehaviorOptions
, chain it off the earlierAddControllers()
call instead.-builder.Services.AddMvc().ConfigureApiBehaviorOptions(options => +builder.Services.Configure<ApiBehaviorOptions>(options => … );OsmoDoc/OsmoDoc.csproj (2)
4-6
:TargetFrameworks
plural but single valueUse
<TargetFramework>
when you target a single TFM; otherwise tooling may assume multi-targeting.-<TargetFrameworks>net8.0</TargetFrameworks> +<TargetFramework>net8.0</TargetFramework>
16-16
: Placeholder URL should be replaced
PackageProjectUrl
currently contains a placeholder. NuGet warns on upload; populate with the repo/docs URL or remove the property.OsmoDoc.API/Controllers/PdfController.cs (2)
48-52
: Static global is reset per-request.Every call overwrites
OsmoDocPdfConfig.WkhtmltopdfPath
. If two requests race while the app restarts with a different root (e.g., tenant-specific path), they will fight. Prefer setting this once during startup (Program.cs
) and make the property immutable.
24-70
: Heavy duplication – extract a helper.
GeneratePdf
andGeneratePdfUsingEjs
share >80 % identical code (path building, temp-file handling, error mapping). Factor this into a private method to cut maintenance cost and chance of drift.Also applies to: 115-161
OsmoDoc/Word/WordDocumentGenerator.cs (1)
293-297
:WebClient
is obsolete – switch toHttpClient
.
WebClient
was deprecated; replace with a sharedHttpClient
(async) or accept a byte[]/stream in the model to avoid network I/O inside a document writer.OsmoDoc/Pdf/PdfDocumentGenerator.cs (1)
62-65
: Redundant catch block.Catching
Exception e
only tothrow;
and ignoree
adds no value and suppresses analyzers. Delete the try/catch or handle/log the error.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
OsmoDoc.API/wwwroot/Tools/wkhtmltopdf.exe
is excluded by!**/*.exe
📒 Files selected for processing (49)
.github/PULL_REQUEST_TEMPLATE/pull_request_template_api.md
(1 hunks)CONTRIBUTING.md
(7 hunks)Dockerfile
(2 hunks)DocumentService/DocumentService.csproj
(0 hunks)DocumentService/Pdf/Models/ContentMetaData.cs
(0 hunks)DocumentService/Pdf/Models/DocumentData.cs
(0 hunks)DocumentService/Pdf/PdfDocumentGenerator.cs
(0 hunks)DocumentService/Word/Models/ContentData.cs
(0 hunks)DocumentService/Word/Models/DocumentData.cs
(0 hunks)DocumentService/Word/Models/Enums.cs
(0 hunks)DocumentService/Word/Models/TableData.cs
(0 hunks)DocumentService/Word/WordDocumentGenerator.cs
(0 hunks)OsmoDoc.API/Controllers/PdfController.cs
(1 hunks)OsmoDoc.API/Controllers/WordController.cs
(1 hunks)OsmoDoc.API/DotEnv.cs
(1 hunks)OsmoDoc.API/Helpers/AuthenticationHelper.cs
(1 hunks)OsmoDoc.API/Helpers/AutoMappingProfile.cs
(1 hunks)OsmoDoc.API/Helpers/Base64StringHelper.cs
(1 hunks)OsmoDoc.API/Helpers/CommonMethodsHelper.cs
(1 hunks)OsmoDoc.API/Models/BaseResponse.cs
(1 hunks)OsmoDoc.API/Models/PdfGenerationRequestDTO.cs
(1 hunks)OsmoDoc.API/Models/WordGenerationRequestDTO.cs
(1 hunks)OsmoDoc.API/OsmoDoc.API.csproj
(1 hunks)OsmoDoc.API/OsmoDoc.API.sln
(1 hunks)OsmoDoc.API/Program.cs
(1 hunks)OsmoDoc.sln
(1 hunks)OsmoDoc/OsmoDoc.csproj
(1 hunks)OsmoDoc/Pdf/Models/ContentMetaData.cs
(1 hunks)OsmoDoc/Pdf/Models/DocumentData.cs
(1 hunks)OsmoDoc/Pdf/Models/OsmoDocPdfConfig.cs
(1 hunks)OsmoDoc/Pdf/PdfDocumentGenerator.cs
(1 hunks)OsmoDoc/Word/Models/ContentData.cs
(1 hunks)OsmoDoc/Word/Models/DocumentData.cs
(1 hunks)OsmoDoc/Word/Models/Enums.cs
(1 hunks)OsmoDoc/Word/Models/TableData.cs
(1 hunks)OsmoDoc/Word/WordDocumentGenerator.cs
(1 hunks)README.md
(6 hunks)docker-compose.yaml
(1 hunks)docs/site/10.0.2/api/OsmoDoc.Word.Models.ContentData.html
(5 hunks)docs/site/10.0.2/api/OsmoDoc.Word.Models.ContentType.html
(2 hunks)docs/site/10.0.2/api/OsmoDoc.Word.Models.DocumentData.html
(4 hunks)docs/site/10.0.2/api/OsmoDoc.Word.Models.ParentBody.html
(2 hunks)docs/site/10.0.2/api/OsmoDoc.Word.Models.TableData.html
(3 hunks)docs/site/10.0.2/api/OsmoDoc.Word.Models.html
(2 hunks)docs/site/10.0.2/api/OsmoDoc.Word.WordDocumentGenerator.html
(3 hunks)docs/site/10.0.2/api/OsmoDocWord.html
(2 hunks)docs/site/10.0.2/api/toc.html
(1 hunks)docs/site/manifest.json
(1 hunks)docs/site/xrefmap.yml
(1 hunks)
💤 Files with no reviewable changes (9)
- DocumentService/Pdf/Models/ContentMetaData.cs
- DocumentService/Word/Models/ContentData.cs
- DocumentService/Pdf/Models/DocumentData.cs
- DocumentService/Word/Models/TableData.cs
- DocumentService/Word/Models/DocumentData.cs
- DocumentService/DocumentService.csproj
- DocumentService/Word/Models/Enums.cs
- DocumentService/Word/WordDocumentGenerator.cs
- DocumentService/Pdf/PdfDocumentGenerator.cs
🧰 Additional context used
🧬 Code Graph Analysis (5)
OsmoDoc.API/Models/PdfGenerationRequestDTO.cs (1)
OsmoDoc/Pdf/Models/DocumentData.cs (1)
DocumentData
(7-10)
OsmoDoc.API/Helpers/AutoMappingProfile.cs (2)
OsmoDoc.API/Models/WordGenerationRequestDTO.cs (1)
WordContentDataRequestDTO
(15-18)OsmoDoc/Word/Models/ContentData.cs (1)
ContentData
(7-29)
OsmoDoc/Pdf/Models/DocumentData.cs (1)
OsmoDoc/Pdf/Models/ContentMetaData.cs (1)
ContentMetaData
(3-7)
OsmoDoc.API/Models/WordGenerationRequestDTO.cs (3)
OsmoDoc/Word/Models/DocumentData.cs (1)
DocumentData
(11-23)OsmoDoc/Word/Models/ContentData.cs (1)
ContentData
(7-29)OsmoDoc/Word/Models/TableData.cs (1)
TableData
(9-22)
OsmoDoc/Pdf/PdfDocumentGenerator.cs (2)
OsmoDoc/Pdf/Models/ContentMetaData.cs (1)
ContentMetaData
(3-7)OsmoDoc/Pdf/Models/OsmoDocPdfConfig.cs (1)
OsmoDocPdfConfig
(3-7)
🪛 LanguageTool
README.md
[duplication] ~1-~1: Possible typo: you repeated a word.
Context: # OsmoDoc OsmoDoc is a library with the following functio...
(ENGLISH_WORD_REPEAT_RULE)
🪛 GitHub Check: build
OsmoDoc/Pdf/Models/ContentMetaData.cs
[warning] 6-6:
Non-nullable property 'Content' must contain a non-null value when exiting constructor. Consider adding the 'required' modifier or declaring the property as nullable.
[warning] 5-5:
Non-nullable property 'Placeholder' must contain a non-null value when exiting constructor. Consider adding the 'required' modifier or declaring the property as nullable.
OsmoDoc/Word/Models/TableData.cs
[warning] 21-21:
Non-nullable property 'Data' must contain a non-null value when exiting constructor. Consider adding the 'required' modifier or declaring the property as nullable.
OsmoDoc/Word/Models/ContentData.cs
[warning] 17-17:
Non-nullable property 'Content' must contain a non-null value when exiting constructor. Consider adding the 'required' modifier or declaring the property as nullable.
[warning] 12-12:
Non-nullable property 'Placeholder' must contain a non-null value when exiting constructor. Consider adding the 'required' modifier or declaring the property as nullable.
OsmoDoc/Word/Models/DocumentData.cs
[warning] 22-22:
Non-nullable property 'TablesData' must contain a non-null value when exiting constructor. Consider adding the 'required' modifier or declaring the property as nullable.
[warning] 16-16:
Non-nullable property 'Placeholders' must contain a non-null value when exiting constructor. Consider adding the 'required' modifier or declaring the property as nullable.
OsmoDoc/Word/WordDocumentGenerator.cs
[warning] 110-110:
The variable 'ex' is declared but never used
OsmoDoc/Pdf/PdfDocumentGenerator.cs
[warning] 77-77:
Converting null literal or possible null value to non-nullable type.
[warning] 62-62:
The variable 'e' is declared but never used
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Analyze (csharp)
🔇 Additional comments (70)
OsmoDoc.API/Helpers/Base64StringHelper.cs (1)
1-1
: Namespace updated to reflect project renaming.The namespace was correctly changed from
DocumentService.API.Helpers
toOsmoDoc.API.Helpers
. No functional changes detected.OsmoDoc.API/Helpers/CommonMethodsHelper.cs (1)
1-1
: Namespace updated consistently.Updated namespace from
DocumentService.API.Helpers
toOsmoDoc.API.Helpers
. Implementation remains unchanged.OsmoDoc.API/DotEnv.cs (1)
1-1
: Namespace aligned with new project name.Namespace updated from
DocumentService.API
toOsmoDoc.API
. No behavior changes introduced..github/PULL_REQUEST_TEMPLATE/pull_request_template_api.md (1)
5-5
: PR template link updated for new repository.The PR checklist link now points to
osmodoc
instead ofdocument-service
. Ensure the URL is correct and accessible.OsmoDoc.API/Helpers/AuthenticationHelper.cs (1)
6-6
: Namespace change applied as part of rebranding.Updated namespace from
DocumentService.API.Helpers
toOsmoDoc.API.Helpers
. No logic alterations.docs/site/10.0.2/api/OsmoDoc.Word.Models.html (5)
8-9
: Update HTML page title namespace
The<title>
tag has been correctly updated to referenceOsmoDoc.Word.Models
.
11-12
: Update meta title namespace
Themeta name="title"
entry now consistently usesOsmoDoc.Word.Models
.
70-73
: Update article and heading namespace identifiers
The<article>
data-uid and<h1>
id/data-uid attributes have been aligned with the newOsmoDoc.Word.Models
namespace.
80-86
: Update class link hrefs to OsmoDoc namespace
All class entries (ContentData
,DocumentData
,TableData
) now point toOsmoDoc.Word.Models.*
in theirhref
.
89-92
: Update enum link hrefs to OsmoDoc namespace
Enum references (ContentType
,ParentBody
) have been updated to theOsmoDoc.Word.Models.*
paths.OsmoDoc.API/Helpers/AutoMappingProfile.cs (2)
1-3
: Update using directives to OsmoDoc namespaces
The imports have been correctly adjusted from the oldDocumentService
to theOsmoDoc
namespaces.
11-11
: Mapping configuration aligns with new DTO and model namespaces
CreateMap<WordContentDataRequestDTO, ContentData>()
remains valid under the updated namespaces.Dockerfile (4)
13-15
: Correct project file copy paths
TheCOPY
instructions have been updated to targetOsmoDoc.API.csproj
andOsmoDoc.csproj
, matching the renamed projects.
17-19
: Update dotnet restore commands paths
Bothdotnet restore
invocations now correctly reference theOsmoDoc
project files.
22-22
: Set working directory to OsmoDoc.API
TheWORKDIR "/app/OsmoDoc.API"
is now aligned with the renamed API project folder.
48-48
: Update container entrypoint to OsmoDoc API DLL
TheENTRYPOINT
has been updated to launchOsmoDoc.API.dll
as expected.CONTRIBUTING.md (8)
1-2
: Update project name in title and introduction
The document title and introductory paragraph now correctly referenceosmodoc
.
16-18
: Direct support to Stack Overflow with osmodoc tag
The guidance now points general support questions to Stack Overflow using theosmodoc
tag.
26-28
: Update issue and pull request URLs to OsmoDoc repository
Links for bug reports and pull requests now target theOsmosysSoftware/osmodoc
repository.
37-43
: Clarify minimal reproduction details for osmodoc bugs
The bullet points in the issue submission guidelines have been updated to mentionosmodoc
specifically.
49-51
: Update link to existing pull requests for osmodoc
The PR search link now points to theosmodoc
repository's pull requests.
66-67
: Update default branch for pull requests
Changed the target branch toosmodoc:main
to match the renamed repository.
93-94
: Update commit message guidelines to mention osmodoc change log
The footer now correctly references the generation of theosmodoc
change log.
113-113
: Update sample commit links to osmodoc repository
The sample commits section now links to theosmodoc
project history.OsmoDoc.API/OsmoDoc.API.csproj (1)
15-15
: Project reference updated to OsmoDoc project
The<ProjectReference>
correctly points to the newOsmoDoc
project, aligning with the renaming and restructuring.docs/site/10.0.2/api/OsmoDoc.Word.Models.ParentBody.html (3)
70-75
: Namespace reference updated correctly
Thedata-uid
and<h1>
ID attributes have been updated fromDocumentService
toOsmoDoc.Word.Models.ParentBody
, aligning with the project rename.
79-80
: Assembly header updated
The<h6>
tags for Namespace and Assembly now correctly referenceOsmoDoc
instead ofDocumentService
.
96-102
: Enum field IDs renamed
Theid
attributes forNone
andTable
fields have been updated to theOsmoDoc.Word.Models.ParentBody
namespace. All references are consistent.OsmoDoc.API/Models/PdfGenerationRequestDTO.cs (2)
1-1
: Update using directive
Theusing
statement correctly references the newOsmoDoc.Pdf.Models
namespace in place ofDocumentService
.
4-4
: Update namespace declaration
The namespace has been updated toOsmoDoc.API.Models
, aligning with the project rename.docs/site/10.0.2/api/OsmoDoc.Word.Models.ContentType.html (3)
70-75
: Namespace reference updated
The<article>
tag'sdata-uid
and<h1>
ID have been updated to useOsmoDoc.Word.Models.ContentType
.
79-80
: Assembly header updated
TheNamespace
andAssembly
<h6>
elements now correctly referenceOsmoDoc
instead ofDocumentService
.
96-101
: Enum field IDs updated
Theid
attributes forImage
andText
fields have been updated to theOsmoDoc.Word.Models.ContentType
namespace.docs/site/10.0.2/api/OsmoDocWord.html (4)
8-9
: Title updated to new namespace
The<title>
tag correctly referencesOsmoDoc.Word
.
11-12
: Meta title updated to new namespace
The<meta name="title">
entry now matchesOsmoDoc.Word
.
70-73
: Content UID and heading updated for OsmoDoc.Word
Thearticle
data-uid
and<h1>
have been updated to reflect the new namespace.
80-80
: Link updated to WordDocumentGenerator in new namespace
The hyperlink now correctly points toOsmoDoc.Word.WordDocumentGenerator.html
.OsmoDoc.API/OsmoDoc.API.sln (1)
6-6
: Project entry updated to new name
The solution now references"OsmoDoc.API"
instead of the old project name.docs/site/manifest.json (1)
8-12
: Skip: namespace path updates
TheseManagedReference
entries were updated to reflect the newOsmoDoc
paths—no issues.Also applies to: 18-22, 28-32, 38-42, 48-52, 58-62, 68-72, 78-82
OsmoDoc.API/Models/BaseResponse.cs (1)
1-3
: Consistent namespace and dependency update
The using directive forMicrosoft.AspNetCore.Mvc
and the namespace refactoring toOsmoDoc.API.Models
are correct and required for theBadRequestObjectResult
return type and overall project rename.docs/site/10.0.2/api/OsmoDoc.Word.Models.DocumentData.html (6)
70-74
: Updated document header identifiers
data-uid
and<h1>
ID forDocumentData
now correctly reflect theOsmoDoc.Word.Models
namespace.
107-108
: Correct namespace and assembly display
The<h6>
elements showingNamespace: OsmoDoc.Word.Models
andAssembly: OsmoDoc.dll
are accurate.
115-116
: Placeholders section identifiers updated
The anchor and heading IDs for thePlaceholders
property now match the new namespace.
133-133
: Placeholders type hyperlink corrected
The type cell now links toOsmoDoc.Word.Models.ContentData
, aligning with the new project structure.
138-139
: TablesData section identifiers updated
The anchor and heading IDs for theTablesData
property correctly use theOsmoDoc.Word.Models
prefix.
156-156
: TablesData type hyperlink corrected
The table data type link now points toOsmoDoc.Word.Models.TableData
.docs/site/10.0.2/api/toc.html (2)
17-21
: Toc links forOsmoDoc.Word
section updated
The entries forOsmoDoc.Word
and itsWordDocumentGenerator
child now correctly replace the oldDocumentService
prefix.
27-43
: Toc links forOsmoDoc.Word.Models
subtree updated
All links underOsmoDoc.Word.Models
(ContentData
,ContentType
,DocumentData
,ParentBody
,TableData
) correctly reflect the new namespace and filenames.OsmoDoc.sln (1)
6-9
: Solution file project entries renamed
The projects in the solution have been correctly renamed fromDocumentService
toOsmoDoc
andDocumentService.API
toOsmoDoc.API
, with updated paths.docs/site/10.0.2/api/OsmoDoc.Word.Models.ContentData.html (6)
70-74
: Updated document header identifiers
data-uid
and<h1>
ID forContentData
now correctly reflect theOsmoDoc.Word.Models
namespace.
107-108
: Correct namespace and assembly display
The<h6>
elements showingNamespace: OsmoDoc.Word.Models
andAssembly: OsmoDoc.dll
are accurate.
115-116
: Content section identifiers updated
The anchor and heading IDs for theContent
property now match the new namespace.
138-139
: ContentType section identifiers updated
The anchor and heading IDs for theContentType
property have been updated to useOsmoDoc.Word.Models
.
156-156
: ContentType type hyperlink corrected
The type cell now points toOsmoDoc.Word.Models.ContentType
.
162-163
: ParentBody section identifiers updated
The anchor and heading IDs for theParentBody
property now correctly reflect theOsmoDoc.Word.Models
prefix.docs/site/10.0.2/api/OsmoDoc.Word.Models.TableData.html (6)
70-70
: Namespace UID updated correctly.
Thedata-uid
on the<article>
tag reflects the newOsmoDoc
namespace without any leftoverDocumentService
references.
74-74
: Header ID and UID are consistent with new namespace.
The<h1>
tag uses the updatedOsmoDoc.Word.Models.TableData
identifier.
107-107
: Namespace link updated.
The<h6>
element correctly points toOsmoDoc.Word.Models
and not the old namespace.
108-108
: Assembly label updated.
The assembly name is correctly shown asOsmoDoc.dll
.
115-115
: Property UID updated forData
.
Thedata-uid
for theData
property now aligns withOsmoDoc.Word.Models.TableData.Data
.
139-139
: Property UID updated forTablePos
.
Thedata-uid
for theTablePos
property reflects the new namespace.OsmoDoc.API/Controllers/WordController.cs (1)
1-7
: Using directives updated to new namespace.
Allusing
statements now correctly referenceOsmoDoc
assemblies; no residualDocumentService
imports were found.docker-compose.yaml (1)
2-2
: Service and image names updated.
The service name, Docker image, and container name have been renamed toosmodoc*
, consistent with the project rebranding.Also applies to: 6-7
OsmoDoc/Word/Models/Enums.cs (1)
1-35
: Enum definitions look good.
BothContentType
andParentBody
enums are defined with clear documentation and correct values. No issues detected.OsmoDoc.API/Program.cs (1)
70-76
: Environment variable read is fineRetrieving
JWT_KEY
and failing fast when missing is a good practice; no action required.OsmoDoc.API/Models/WordGenerationRequestDTO.cs (1)
22-23
: Good defensive initialisationInitialising
Placeholders
andTablesData
avoids null checks downstream. Nicely done.docs/site/10.0.2/api/OsmoDoc.Word.WordDocumentGenerator.html (1)
1-184
: Documentation file – no code impactHTML documentation changes look consistent with the namespace rename. No code issues.
OsmoDoc/Word/WordDocumentGenerator.cs (1)
31-56
: I’ll inspect theDocumentData
DTO to see howPlaceholders
andTablesData
are declared (nullability, initializers, etc.).#!/bin/bash # Find DocumentData class and its properties rg -n "class DocumentData" -A10 rg -n "Placeholders" -A3 rg -n "TablesData" -A3OsmoDoc/Pdf/PdfDocumentGenerator.cs (1)
74-75
: I’ll locate and inspect theContentMetaData
model to confirm the nullability of itsContent
property.#!/bin/bash # 1. Find the file defining ContentMetaData metaFile=$(rg -l "class ContentMetaData" -t cs | head -n1) echo "=== ContentMetaData model: $metaFile ===" # 2. Show its top 200 lines for property declarations sed -n '1,200p' "$metaFile"docs/site/xrefmap.yml (1)
1-196
: Documentation update looks consistent.
No issues spotted.
Task Link
REST-1556
Description
Summary by CodeRabbit