Conversation
Assisted-By: OpenAI Codex (GPT-5)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
FINERACT-2830 corrects the OpenAPI response schemas for:
GET /v1/templates/templateGET /v1/templates/{templateId}/templateBoth resource methods return
TemplateDetailsData, but their OpenAPI annotations previously declaredTemplateData.This change updates the two response annotations to
TemplateDetailsData.The generated OpenAPI specification now correctly exposes:
entitiesas an arraytypesas an arraytemplateas nestedTemplateDataNo runtime behavior, business logic, database behavior, or API response payload has changed.
CQRS consideration
I considered the CQRS migration scope for this issue.
The affected operations are read-only GET endpoints, and this ticket currently concerns correcting their OpenAPI response schemas. Therefore, this PR does not introduce command-processing changes without confirming a specific migration target with the maintainer.
I am happy to discuss whether a template write operation should be migrated to the CQRS infrastructure as a separate or follow-up contribution.
Verification
:fineract-provider:test --tests org.apache.fineract.template.api.TemplatesApiResourceTest:fineract-provider:resolve#/components/schemas/TemplateDetailsDataThe client OpenAPI validation currently reports missing
defaultresponse descriptions for these two operations. Those descriptions were absent before this schema correction. I will follow maintainer guidance on whether they belong in this ticket.Checklist
Please make sure these boxes are checked before submitting your pull request - thanks!
Your assigned reviewer(s) will follow our guidelines for code reviews.