Swagger description for the v1/receive/{number} message end point

[Gara-Dorta]

Feature discussion

The receive message endpoint claims to return a string but it's actually a complex object. This has been reported before in #622 and #199.

I have an open PR in the signal-cli repo that generates a json schema for the object (MessageEnvelope). My plan after that gets merged is to create a PR here so that the json schemas from there get plugged into the output of the enpoint. Thus automatically generating a valid config.

Is this something that sounds good to you?

[bbernhard]

Sounds good to me! I guess it could be a bit tricky though, since swag is used for the schema generation and I am not sure if it is (easily) possible to hook a custom schema into the schema generation process. But maybe it's possible to create a custom script, which first calls swag and then adds the schema for the receive endpoint from signal-cli on top of that. 🤔

[Gara-Dorta]

Great, then I'll work on it as soon as that PR is merged. As you said I'll probably end up writing a custom script. For now, the only thing I tried was to manually edit the json file and see that I can automatically generate python classes from the modified json for the end point.

[Gara-Dorta]

The PR in signal-cli was merged.

I've written a first version of the integration using a custom script. It's in https://github.com/Gara-Dorta/signal-cli-rest-api/tree/receive-swagger .

I'm now waiting on signal-cli to release a new version with it and on signal-cli-rest-api to update to that version.

Here is a sneak peek of the result:

To simplify the script, I've opened an issue in swaggo/swag#2165

[Gara-Dorta]

@bbernhard my next step with this (now that #842 is ready) is to write a new ci job that will run on every push to master. It will update the docs files and create a PR if there are any changes. So that we will always have the docs.go and swagger.json updated with the state of the master branch.

To make it fast, I plan to pull the schemas directly from the signal-cli releases (I've just made a PR for it AsamK/signal-cli#2040). So that the ci will only need to install go and run the generate docs scripts, without having to compile signal-cli.