WARN in asciidoc logs while generating asciidoctor

[fkalinowski]

Hi,

Here is a problem I've got with the version 1.0.15 and it's has been verified with the spring-restdocs@1.2.6.RELEASE

Description

I've got some WARN log entries while generating the asciidoc version of the documentation.

[INFO] --- asciidoctor-maven-plugin:1.6.0:process-asciidoc (asciidoc-generate) @ my-project
...
[INFO] ... skipping reference to missing attribute: reference
[INFO] ... skipping reference to missing attribute: reference
[INFO] ... skipping reference to missing attribute: id
...

Potential solution

The problem seems to be the same than an issue reported in the Spring Rest Doc project see spring-projects/spring-restdocs#527 which has been solved by the commit spring-projects/spring-restdocs@e14bda0.

Based on the issue above and the implemented solution, the template default-auto-method-path.snippet should be modified to make sure the path of the REST API is surrounded by + ... + which in turn will guarantee a pass-through of the whole string (see AsciiDoctor > Syntax quick reference.

IMHO, this problem impacts both maintained versions 1.0.15 and 2.0.5.

My proposed solution only fixes my problem, the escaping of {} can be required in other parts of this project - I ddn't check the whole codebase.

Workaround

As stated in the Spring Rest Doc documentation it is possible to override the default templates by providing a file named auto-method-path.snippet in the folder src\test\resources\org\springframework\restdocs\templates\asciidoctor for which the content is:

`+{{method}} {{path}}+`