Support for # and *

[luisalves00]

Seems that # character cannot be escaped inside an AsyncAPI $ref path.
It's related with JSON Pointer (RFC 6901) and URI fragment (RFC 3986) specs

Still # and * are valid wildcards on ActiveMQ Artemis:

https://activemq.apache.org/components/artemis/documentation/latest/wildcard-syntax.html

Is there some workaround or something that lib can do to support it?

[github-actions]

Welcome to Springwolf. Thanks a lot for reporting your first issue. Please check out our contributors guide and feel free to join us on discord.

[sam0r040]

Hi @luisalves00,
we tried to reproduce the problem bei adding .* and .# to the listeners in our jms example:

    @JmsListener(destination = "example-queue.#/bla")
   // and
    @JmsListener(destination = "another-queue.*")

The resulting spec is valid in AsyncApi Studio. Maybe our approach was too simple. Can you give us more detail on how your configuration looks like and what problems you encounter?
A PR reproducing the issue in one of our examples would be perfect.

[luisalves00]

Thanks for the quick response. Mine:

npx @redocly/cli@latest lint api.json

[3] api.json:275:9 at #/operations/domain-events.#_receive_subscribeAllBusinessEvents/messages/0

Can't resolve $ref

273 |   },
274 |   "messages": [
275 |     {
276 |       "$ref": "#/channels/domain-events.#/messages/java.lang.String"
277 |     }
278 |   ]
279 | }

Error was generated by the no-unresolved-refs rule.

yours indeed passed, but no case ends with the # (not sure if this is the problem)

What I use is the following:

@AsyncListener(
    operation =
         @AsyncOperation(
			channelName = "domain-events.#",
			description = "Listen to the All Domain Events (Sink)",
			payloadType = String.class,
			headers = ...
})))
@JmsAsyncOperationBinding
public void subscribeAllDomainEvents(@Payload String payload, @Headers Map<String, Object> headers) {

Do I have something wrong?

[timonback]

I see, it is a different validator with a stricter ruleset.
Thanks for linking the rfc numbers, I read parts of them and agree that not all characters (like #) are allowed within url fragments: https://datatracker.ietf.org/doc/html/rfc3986#section-3.5

We already thought there might be more restrictions, so we can update it here: https://github.com/springwolf/springwolf-core/blob/master/springwolf-asyncapi/src/main/java/io/github/springwolf/asyncapi/v3/model/ReferenceUtil.java

Feel free to contribute a fix and then we can ship it in the next release. Happy to assist.

[github-actions]

The change is staged for release and will be part of the next release.

If you want to try and verify it in your application today,
use the latest 1.X.0-SNAPSHOT build as described in our README.md > Testing SNAPSHOT version

Thank you for the report/contribution!

[luisalves00]

Thanks.
I guess there's no straightforward solution. Best is to change the wildcard to other character as ActiveMQ allows it.
Since AsyncAPI Studio seems to support it, maybe is a Redocly issue. I'll forward to them.

[timonback]

A fix was implemented and merged, which can be tested using SNAPSHOT version.
True, wildcard is not allowed in the channel reference and is replaced now. Still, the channel name should contain it.
We can update our amqp example to reflect that.
Is the issue not resolved from your point of view?