DocumentService

AppStd/DocumentService

Fork 0

Commit Graph

Author	SHA1	Message	Date
TekH	dc0af68d26	docs: Update API specification based on Marvin/Marlon feedback CONTROLLER_ENDPOINTS.md changes: - Binary stream output for all operations (NO outputPath, NO base64) - PDF Operations: merge, stamp, annotate → return application/pdf stream - PDF Conversion: to-pdfa, from-pdfa → return application/pdf stream - Attachment Extraction: extract → return application/zip stream - Add Attachment endpoint (Phase 2): embed files in PDF/PDF/A-3 - Swiss QR Code endpoint documented (already implemented) - PdfRenderController REMOVED (moved to .NET client library) AGENTS.md changes: - Current Status: SwissQrCodeController ✅ DONE (2 tests) - Current Status: PdfValidationController ✅ Partial (4 tests) - Phase reorganization: - Phase 1: validate, validate-pdfa, check, extract (SwissQR), extract (attachments), merge - Phase 2: stamp, annotate, add-attachment - Phase 3: to-pdfa, from-pdfa - Removed PdfRenderController from all phases Design decisions (team consensus): - Server endpoints stay granular (validate, check, extract separate) - Combined operations (validateANDextract) → .NET client library - Binary streams avoid filesystem dependencies - No base64 overhead (~33%), client library handles conversions Result: Clean API spec, memory-based operations, client convenience layer	2026-07-08 15:46:10 +02:00
TekH	a12d529d9e	Add documentation for DocumentOperator service Added `CONTROLLER_ENDPOINTS.md` to define REST API endpoints and `REQUIRED_FEATURES.md` to outline required functions and features for the `DocumentOperator` service. These documents include detailed specifications for controllers, input/output formats, usage scenarios, and technical requirements. Updated `DocumentOperator.sln` to include the new documentation files under a "Solution Items" section for better visibility. Defined a prioritization strategy for feature implementation, technical requirements, and a comprehensive test strategy. Referenced relevant standards (e.g., PDF/A, ZUGFeRD) and documented usage of the DevExpress Office File API.	2026-07-06 10:33:01 +02:00

Author

SHA1

Message

Date

TekH

dc0af68d26

docs: Update API specification based on Marvin/Marlon feedback

CONTROLLER_ENDPOINTS.md changes:

  - Binary stream output for all operations (NO outputPath, NO base64)

  - PDF Operations: merge, stamp, annotate → return application/pdf stream

  - PDF Conversion: to-pdfa, from-pdfa → return application/pdf stream

  - Attachment Extraction: extract → return application/zip stream

  - Add Attachment endpoint (Phase 2): embed files in PDF/PDF/A-3

  - Swiss QR Code endpoint documented (already implemented)

  - PdfRenderController REMOVED (moved to .NET client library)

AGENTS.md changes:

  - Current Status: SwissQrCodeController ✅ DONE (2 tests)

  - Current Status: PdfValidationController ✅ Partial (4 tests)

  - Phase reorganization:

    - Phase 1: validate, validate-pdfa, check, extract (SwissQR), extract (attachments), merge

    - Phase 2: stamp, annotate, add-attachment

    - Phase 3: to-pdfa, from-pdfa

  - Removed PdfRenderController from all phases

Design decisions (team consensus):

  - Server endpoints stay granular (validate, check, extract separate)

  - Combined operations (validateANDextract) → .NET client library

  - Binary streams avoid filesystem dependencies

  - No base64 overhead (~33%), client library handles conversions

Result: Clean API spec, memory-based operations, client convenience layer

2026-07-08 15:46:10 +02:00

TekH

a12d529d9e

Add documentation for DocumentOperator service

Added `CONTROLLER_ENDPOINTS.md` to define REST API endpoints and
`REQUIRED_FEATURES.md` to outline required functions and features
for the `DocumentOperator` service. These documents include
detailed specifications for controllers, input/output formats,
usage scenarios, and technical requirements.

Updated `DocumentOperator.sln` to include the new documentation
files under a "Solution Items" section for better visibility.

Defined a prioritization strategy for feature implementation,
technical requirements, and a comprehensive test strategy.
Referenced relevant standards (e.g., PDF/A, ZUGFeRD) and
documented usage of the DevExpress Office File API.

2026-07-06 10:33:01 +02:00

2 Commits