Development: Add V2 Messages Endpoint

[MichaelOwenDyer]

This PR introduces a version 2 of the messages endpoint, which returns all content generated in a guidance program as opposed to just the one variable titled 'response', and additionally accepts just a string as the template parameter instead of an object containing a string and an unused id.

[MichaelOwenDyer]

Tried running the formatter but can't seem to get the formatting checks to pass

[dakennguyen]

Tried running the formatter but can't seem to get the formatting checks to pass

you can try to run this poetry run black .

[dakennguyen]

@MichaelOwenDyer I think the endpoint POST /api/v1/messages is currently being used. Will this PR break production? Otherwise, we need to introduce POST /api/v2/messages or make sure it backward backward-compatible.

Other than this, this PR LGTM

[MichaelOwenDyer]

You're right, it will break production. There is another PR open on Artemis to change that side as well. But it might actually be smarter to just create a /v2/ endpoint, that way this can be merged without Artemis breaking.

[Hialus]

@MichaelOwenDyer I think the endpoint POST /api/v1/messages is currently being used. Will this PR break production? Otherwise, we need to introduce POST /api/v2/messages or make sure it backward backward-compatible.

You're right, it will break production. There is ls1intum/Artemis#7352 open on Artemis to change that side as well. But it might actually be smarter to just create a /v2/ endpoint, that way this can be merged without Artemis breaking.

That is a great idea. I think this would make sense here for the transition phase, until Artemis Prod is updated. Then we could simply remove the v1 endpoint afterwards.

[MichaelOwenDyer]

Thanks for the reviews guys. I addressed the issues you pointed out, V1 API should be behaving equivalent to before (although the logic for getting the response variable is now local to the endpoint and not directly in the guidance wrapper). I also extended the message test to test both v1 and v2.

[Hialus]

Very nice that you could change this to a v1/v2 split!
Code changes look good, but the linter job is currently failing. Please fix that.

[MichaelOwenDyer]

You got it sir. Those dangerously long comments have been shortened.

[dakennguyen]

code LGTM!

Addressed

[Hialus]

Change look good to me and since it has been deployed to the test server for some time without issues it also is sufficiently tested now.
Great job 🚀