swaran21 opened a new pull request, #6475:
URL: https://github.com/apache/fineract/pull/6475
## 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.
### 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](https://github.com/apache/fineract/blob/develop/CONTRIBUTING.md#pull-requests)
- [ ] 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](https://fineract.apache.org/docs/current/#_testing) for verifying the
changes made.
- [ ] Follow our [coding
conventions](https://cwiki.apache.org/confluence/display/FINERACT/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"](https://cwiki.apache.org/confluence/display/FINERACT/Pull+Request+Size+Limit).
Large changes can be made in a branch, with assistance. Ask for help on the
[developer mailing list](https://fineract.apache.org/#contribute).
- [ ] 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](https://github.com/apache/fineract/blob/develop/CONTRIBUTING.md#ai-policy).
Your assigned reviewer(s) will follow our [guidelines for code
reviews](https://cwiki.apache.org/confluence/display/FINERACT/Code+Review+Guide).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
