Skip to content

FINERACT-2830: Correct template OpenAPI response schemas - #6475

Draft
swaran21 wants to merge 1 commit into
apache:developfrom
swaran21:FINERACT-2830-openapi-admin-templates
Draft

swaran21 wants to merge 1 commit into
apache:developfrom
swaran21:FINERACT-2830-openapi-admin-templates

Conversation

@swaran21

@swaran21 swaran21 commented Sep 17, 2026

Copy link
Copy Markdown

Description

FINERACT-2830 corrects the OpenAPI response schemas for:

  • GET /v1/templates/template
  • GET /v1/templates/{templateId}/template

Both resource methods return TemplateDetailsData, but their OpenAPI annotations previously declared TemplateData.
This change updates the two response annotations to TemplateDetailsData.
The generated OpenAPI specification now correctly exposes:

  • entities as an array
  • types as an array
  • template as nested TemplateData

No 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

  • Ran :fineract-provider:test --tests org.apache.fineract.template.api.TemplatesApiResourceTest
  • Ran :fineract-provider:resolve
  • Verified both operations in the generated OpenAPI specification reference #/components/schemas/TemplateDetailsData

The client OpenAPI validation currently reports missing default response 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!

  • Write the commit message as per our guidelines
  • Acknowledge that we will not review PRs that are not passing the build ("green") - it is your responsibility to get a proposed PR to pass the build, not primarily the project's maintainers.
  • Create/update unit or integration tests for verifying the changes made.
  • Follow our coding conventions.
  • Add required Swagger annotation and update API documentation at fineract-provider/src/main/resources/static/legacy-docs/apiLive.htm with details of any API changes
  • This PR must not be a "code dump". Large changes can be made in a branch, with assistance. Ask for help on the developer mailing list.
  • If merging this PR resolves a JIRA issue, I will mark that issue as resolved and set "Fix Version/s" appropriately.
  • I followed the AI Policy.

Your assigned reviewer(s) will follow our guidelines for code reviews.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant