[FINERACT-837] Make swagger-ui/response.json (?) a pure built time artifact, and remove it from Git

• Type: Sub-task
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 1.4.0
• Fix Version/s: 1.4.0
• Assignee: Petri Tuomola
• Reporter: Michael Vorburger
• Created: 19/Jan/20 14:28
• Updated: 21/Aug/20 08:44
• Resolved: 14/Jul/20 00:44

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

Issue Links

• is duplicated by: FINERACT-740 Automation of Swagger Documentation
• is required by: FINERACT-1045 Replace links to demo.openmf.org on Swagger with (local) / links
• requires: FINERACT-835 Generate swagger-ui/response.json at build time