AWS documentation

[LagerstedtMarcus]

Hi,

I have problems getting SNS documentation running, I can't create channel bindings or even describe my topic and how to connect to it. The server object doesn't let me add the parameters I need.

"components": { "channelsBindings": { "MyTopicDef": { "name": "my topic" } } }
And if I define a channel to be my "Topic" it doesn't add up in the HTML

"channels": { "my_topic_dev": { "address": "topic-url", "summary":"my topic", "servers":[ { "$ref": "#/servers/dev" } ], "messages": { "message1": { "$ref": "#/components/messages/message1" } }, "bindings":{ "$ref": "#/components/channelBindings/MyTopicDef" } } }
"operations": { "my_event": { "action": "send", "channel": { "$ref": "#/channels/my_topic_dev" }, "description": "test", "messages": [ { "$ref": "#/channels/my_topic_dev/messages/message1" } ] } }

Is there going to be a way to document this?

[derberg]

Lemme ping @dpwdec @iancooper who maintain at AsyncAPI bindings for SNS/SQS - maybe they can help

Also pinging @boyney123 as he knows AsyncAPI very well and works at AWS and also maintains Event Catalog project

[iancooper]

Lemme ping @dpwdec @iancooper who maintain at AsyncAPI bindings for SNS/SQS - maybe they can help
Hmmm, we can take a look, we might not get back to you before the holidays are over though.

[dpwdec]

@LagerstedtMarcus

I can't create channel bindings or even describe my topic and how to connect to it.

Could you clarify the context of this. Is you example intended to be an AsyncAPI document? If so, the example does not look valid as there doesn't seem to be any reference to sns binding key.

I think something closer to a valid specification, if this is AsyncAPI would be:

channels:
  my_topic_dev:
    bindings:
      sns:
        name: topic-url

If this isn't AsyncAPI could you clarify what sort of configuration this is and what particular tool that is telling you it is invalid?

The server object doesn't let me add the parameters I need.

As far as I am aware we have no agreed on a server binding specification yet for sns. You are welcome to open a bindings PR if you want to start a discussion on this.