[BUG] - Report Problem With Stop API

[amrhossamdev]

Summary

report-problem-with-stop api is not working when sending a large userComment. This affects the OBA Android app and we can miss valuable reports.

• For more details about the issue Unable to report a Stop Problem onebusaway-android#1054
• My investigation and solution: Unable to report a Stop Problem onebusaway-android#1054 (comment)

Steps to reproduce:

• Use report-problem-with-stop API and try to send a large userComment

Expected behavior:

allow sending the full user comment.

Observed behavior:

Request fails

[bkirz]

This looks like an inherent limitation of the current GET endpoint. Given that this endpoint creates a record and can contain larger inputs, it should be a POST endpoint. I think the most promising path forward here would be:

• Create a POST endpoint with similar semantics to the existing GET endpoint that can accommodate larger payloads in the POST body.
• Deprecate the existing GET endpoint and migrate clients over to the new POST endpoint.

I'm not sure what the deprecation model looks like for software with this distribution model. If we can't properly delete the endpoint, I think marking it as deprecated in documentation and possibly removing OpenAPI hooks would suffice.