[
https://issues.apache.org/jira/browse/FINERACT-837?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Michael Vorburger updated FINERACT-837:
---------------------------------------
Description:
Once FINERACT-835 is fully implemented (do not start working on this until
FINERACT-835 is merged), and just in order to reduce confusion about what is
manually maintained and what is provided by the build, IMHO we really should
make swagger-ui/response.json (or whatever will replace it?) a pure built time
artifact.
What I mean is that {{./gradlew build}} should produce this file at the
appropriate place under {{build/}}, from where it should be picked up and
included in the right place in the WAR. That file should then be removed from
Git in {{src/main/resources/swagger-ui/response.json}} where it currently lives.
I guess it would be cool to make this change after having the test proposed in
FINERACT-836 just to "prove" that "it (?) still works as before and nothing
broke".
The assumption I've made here is that it's best to have this JSON file built at
run-time. I know little about Swagger, and if the conclusion is that it's
better and fine to just have something (Swagger runtime) build the Swagger JSON
(YAML?) through scanning the annotations at runtime, and that's how this is
typically done, then we can of course forget about, and just remove the
{{src/main/resources/swagger-ui/response.json}} completely.
[~kangbreder] would you like to do this? Please raise PR with ONLY this
change, nothing else.
[~awasum] [~sanyam] ([~sanyam96] ?) FYI
was:
Once FINERACT-835 is fully implemented (do not start working on this until
FINERACT-835 is merged), and just in order to reduce confusion about what is
manually maintained and what is provided by the build, IMHO we really should
make swagger-ui/response.json (or whatever will replace it?) a pure built time
artifact.
What I mean is that {{./gradlew build}} should produce this file at the
appropriate place under {{build/}}, from where it should be picked up and
included in the right place in the WAR. That file should then be removed from
Git in {{src/main/resources/swagger-ui/response.json}} where it currently lives.
I guess it would be cool to make this change after having the test proposed in
FINERACT-836 just to "prove" that "it (?) still works as before and nothing
broke".
The assumption I've made here is that it's best to have this JSON file built at
run-time. I know little about Swagger, and if the conclusion is that it's
better and fine to just have something (Swagger runtime) build the Swagger JSON
(YAML?) through scanning the annotations at runtime, and that's how this is
typically done, then we can of course forget about, and just remove the
{{src/main/resources/swagger-ui/response.json}} completely.
Kang Breder Mbulle would you like to do this? Please raise PR with ONLY this
change, nothing else.
Awasum Yannick Sanyam Goel (Sanyam Goel ?) FYI
> Make swagger-ui/response.json (?) a pure built time artifact, and remove it
> from Git
> ------------------------------------------------------------------------------------
>
> Key: FINERACT-837
> URL: https://issues.apache.org/jira/browse/FINERACT-837
> Project: Apache Fineract
> Issue Type: Sub-task
> Reporter: Michael Vorburger
> Priority: Major
>
> Once FINERACT-835 is fully implemented (do not start working on this until
> FINERACT-835 is merged), and just in order to reduce confusion about what is
> manually maintained and what is provided by the build, IMHO we really should
> make swagger-ui/response.json (or whatever will replace it?) a pure built
> time artifact.
> What I mean is that {{./gradlew build}} should produce this file at the
> appropriate place under {{build/}}, from where it should be picked up and
> included in the right place in the WAR. That file should then be removed from
> Git in {{src/main/resources/swagger-ui/response.json}} where it currently
> lives.
> I guess it would be cool to make this change after having the test proposed
> in FINERACT-836 just to "prove" that "it (?) still works as before and
> nothing broke".
> The assumption I've made here is that it's best to have this JSON file built
> at run-time. I know little about Swagger, and if the conclusion is that it's
> better and fine to just have something (Swagger runtime) build the Swagger
> JSON (YAML?) through scanning the annotations at runtime, and that's how this
> is typically done, then we can of course forget about, and just remove the
> {{src/main/resources/swagger-ui/response.json}} completely.
> [~kangbreder] would you like to do this? Please raise PR with ONLY this
> change, nothing else.
> [~awasum] [~sanyam] ([~sanyam96] ?) FYI
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
