Bugs in swagger

[lil131]

1. should be /namespaces/{ns}/broadcast/message
   https://github.com/hyperledger-labs/firefly/blob/d20e6faa73061d176165c926ce32696025d79d33/docs/swagger/swagger.yaml#L2560

2. should be topics with type string[]
   https://github.com/hyperledger-labs/firefly/blob/d20e6faa73061d176165c926ce32696025d79d33/docs/swagger/swagger.yaml#L2617

[peterbroadhurst]

Hey @lil131

(2) is definitely a bug:

https://github.com/hyperledger-labs/firefly/blob/3a2f785cc77a5ad501ddba4266060f6db18dbbd5/internal/apiserver/route_post_new_message_broadcast.go#L63-L65

Did you fancy submitting a PR to fix that?

However, (1) is actually accurate I believe - it's generated from this code, which is the source of truth:
https://github.com/hyperledger-labs/firefly/blob/3a2f785cc77a5ad501ddba4266060f6db18dbbd5/internal/apiserver/route_post_new_message_broadcast.go#L84

However, there are some old docs that are referring to an API that was renamed (and you should find the old API still exists in the swagger, but is marked deprecated):
https://github.com/hyperledger-labs/firefly/blob/main/docs/gettingstarted/broadcast_data.md#example-2-inline-object-data-to-a-topic-no-datatype-verification

Wonder if you fancied updating that doc as well in your PR?

[awrichar]

Note - in addition to topics being incorrect, it seems tag is completely missing from all messaging APIs as well.

The fact that these have been incorrect for a while also implies they're not tested E2E (so the fix should probably include an E2E test as well).

[awrichar]

btw the Swagger schemas for these particular routes are written out by hand, rather than being generated from the Go code. That explains how they got out of sync (and it's somewhat of a concern to me in general) - but assuming we aren't changing that immediately, the schemas can be found in route_post_new_message_broadcast.go and route_post_new_message_private.go.

[lil131]

Thanks @peterbroadhurst and @awrichar! Just sent a PR for this, also included tag as @awrichar mentioned.