feat: add export template api #35

tomwwinter · 2024-09-05T12:20:34Z

No description provided.

sleidig

Looks quite good and clean! Just a few remarks regarding naming and comments for easier understanding of the code.
Nice test coverage also!

update README with a short section on the feature + setup instructions
add open-api specs file for our endpoints
naming of the endpoint + module (export reminds me more of csv exports ... but I understand the intention behind this also ...)

...m-backend-service/src/main/kotlin/com/aamdigital/aambackendservice/auth/core/AuthProvider.kt

...d-service/src/main/kotlin/com/aamdigital/aambackendservice/auth/core/KeycloakAuthProvider.kt

...c/main/kotlin/com/aamdigital/aambackendservice/export/controller/TemplateExportController.kt

...ckend-service/src/main/kotlin/com/aamdigital/aambackendservice/export/core/ExportTemplate.kt

.../main/kotlin/com/aamdigital/aambackendservice/export/usecase/DefaultRenderTemplateUseCase.kt

...t/kotlin/com/aamdigital/aambackendservice/export/usecase/DefaultRenderTemplateUseCaseTest.kt

application/aam-backend-service/src/test/resources/cucumber/features/export/export.feature

docs/api-specs/carboneio-api-spec.yaml

sleidig

Looks good to me!

Thanks for adding all this documentation. Really helpful.

sleidig · 2024-09-17T16:41:03Z

.../main/kotlin/com/aamdigital/aambackendservice/export/usecase/DefaultCreateTemplateUseCase.kt

- * The ExportTemplate entity is then created in the frontend.
+ * Default implementation of the [CreateTemplateUseCase] interface.
+ *
+ * This use case is responsible for creating a template by making a POST request to a specified


Suggested change

* This use case is responsible for creating a template by making a POST request to a specified

* This use case is responsible for registering a template file by making a POST request to a specified

sleidig · 2024-09-17T16:45:40Z

docs/api-specs/export-api-v1.yaml

+paths:
+  /template:
+    post:
+      summary: Post a new template


Suggested change

summary: Post a new template

summary: Post a new template

description: Registers a template file. Creating the TemplateExport entity is handled by the client not by this endpoint through the server.

sleidig · 2024-09-17T16:46:11Z

docs/api-specs/export-api-v1.yaml

+          required: true
+          schema:
+            type: string
+            description: The ID of the template to be rendered


Suggested change

description: The ID of the template to be rendered

description: The ID of the TemplateExport entity to be rendered

sleidig · 2024-09-17T16:48:42Z

docs/api-specs/export-api-v1.yaml

+              properties:
+                convertTo:
+                  type: string
+                  description: The format to convert the template to


Suggested change

description: The format to convert the template to

description: The format to convert the template to, e.g. "pdf" in order to receive a PDF file in the reponse

sleidig · 2024-09-17T16:50:00Z

docs/api-specs/export-api-v1.yaml

+      summary: Fetch an existing template
+      parameters:
+        - name: templateId
+          in: path
+          required: true
+          schema:
+            type: string
+            description: The ID of the template to be rendered


Suggested change

summary: Fetch an existing template

parameters:

- name: templateId

in: path

required: true

schema:

type: string

description: The ID of the template to be rendered

summary: Fetch an existing template file

description: Get the uploaded template file with its placeholders (not a generated document filled with data based on the template)

parameters:

- name: templateId

in: path

required: true

schema:

type: string

description: The ID of the TemplateExport entity

sleidig · 2024-09-17T16:51:51Z

docs/modules/export.md

+
+## Overview
+
+The export module is responsible for handling various template-based export operations. This module primarily focuses on generating PDFs for entities within the AAM system.


Suggested change

The export module is responsible for handling various template-based export operations. This module primarily focuses on generating PDFs for entities within the AAM system.

The export module is responsible for handling various template-based export operations.

This module primarily focuses on generating PDFs for entities within the Aam Digital system.

(trying to use "Aam" rather than "AAM" consistently. Otherwise people often mistake this for an acronym)

sleidig · 2024-09-17T16:52:38Z

docs/modules/export.md

+
+### Dependencies
+
+This service is using an external template engine for handle placeholder replacement in files and render PDF files.  


Suggested change

This service is using an external template engine for handle placeholder replacement in files and render PDF files.

This service is using an external template engine to handle placeholder replacement in files and render PDF (or other supported) files.

sleidig · 2024-09-17T16:56:36Z

docs/api-specs/carboneio-api-spec.yaml

+
+info:
+  description: |-
+    Carbone Cloud/On-premise Open API reference.


Suggested change

Carbone Cloud/On-premise Open API reference.

Carbone Cloud/On-premise Open API reference.

This API is used by the aam-services backend internally, exposing its functionality through our own, auth protected endpoints.

tomwwinter added 6 commits September 5, 2024 14:20

feat: add export template api

916752e

fix: add testing config

f004d2f

feat: file export template api

1b34044

test: add e2e test

877b8b3

test: add e2e test

826bb7b

test: add e2e test

6c379de

sleidig reviewed Sep 12, 2024

View reviewed changes

tomwwinter added 8 commits September 12, 2024 14:27

fix: pr feedback

1f4db1b

feat: add FetchTemplateUseCase

f6c5581

feat: add header to response

b758e97

feat: pr feedback

c03d9b1

docs: add export readme

e2a644b

refactor: rename entity

f15a946

docs: add export-api-v1.yaml

97bd2f1

docs: add setup notes

e7b5bdf

tomwwinter requested a review from sleidig September 16, 2024 09:54

tomwwinter added 2 commits September 16, 2024 20:20

fix: set description nullable in TemplateExport(Dto)

9ab1fa2

fix: replace invalid chars in fileName

2513912

sleidig approved these changes Sep 17, 2024

View reviewed changes

sleidig reviewed Sep 17, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add export template api #35

feat: add export template api #35

tomwwinter commented Sep 5, 2024

sleidig left a comment •

edited by tomwwinter

Loading

sleidig left a comment

sleidig Sep 17, 2024

sleidig Sep 17, 2024

sleidig Sep 17, 2024

sleidig Sep 17, 2024

sleidig Sep 17, 2024

sleidig Sep 17, 2024

sleidig Sep 17, 2024

sleidig Sep 17, 2024

	* This use case is responsible for creating a template by making a POST request to a specified
	* This use case is responsible for registering a template file by making a POST request to a specified

	summary: Post a new template
	summary: Post a new template
	description: Registers a template file. Creating the TemplateExport entity is handled by the client not by this endpoint through the server.

	description: The ID of the template to be rendered
	description: The ID of the TemplateExport entity to be rendered

	description: The format to convert the template to
	description: The format to convert the template to, e.g. "pdf" in order to receive a PDF file in the reponse


		## Overview

		The export module is responsible for handling various template-based export operations. This module primarily focuses on generating PDFs for entities within the AAM system.

	The export module is responsible for handling various template-based export operations. This module primarily focuses on generating PDFs for entities within the AAM system.
	The export module is responsible for handling various template-based export operations.
	This module primarily focuses on generating PDFs for entities within the Aam Digital system.


		### Dependencies

		This service is using an external template engine for handle placeholder replacement in files and render PDF files.

	Carbone Cloud/On-premise Open API reference.
	Carbone Cloud/On-premise Open API reference.
	This API is used by the aam-services backend internally, exposing its functionality through our own, auth protected endpoints.

feat: add export template api #35

Are you sure you want to change the base?

feat: add export template api #35

Conversation

tomwwinter commented Sep 5, 2024

sleidig left a comment • edited by tomwwinter Loading

Choose a reason for hiding this comment

sleidig left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sleidig left a comment •

edited by tomwwinter

Loading