Unlike Asciidoctor’s built-in macros, operation macro does not support substitution in its target

[jamesfoster]

To allow referring to operations using attribute substitution, such as:

operation::{prefix}-name[]

Requires a change to the following file to call sub-attributes:

spring-restdocs-asciidoctor/src/main/resources/extensions/operation_block_macro.rb

def process(parent, operation, attributes)
  operation = parent.sub_attributes operation  # << --
...

[wilkinsona]

Thanks for the suggestion. I think I can see how that might be useful, but can you please describe your particular use-case for using {prefix}.

@mojavelinux I'd appreciate your input here if you have a moment. What do you think of a macro allowing substitutions in its target as proposed above?

[jamesfoster]

I want to wrap the call to the operation:: in a common include as we'd like to put some markup around the snippets.

:operation-name: my-operation
inlucde::operation.adoc[]

operation.adoc

// My custom preamble for {operation-name}
operation::{operation-name}[]
// Wrapping up

Not sure there's a nicer way of doing that but hoped that it would work.

[mojavelinux]

It's generally recommended to support attribute substitution in the target of a macro. All the built-in macros in Asciidoctor support this, so I think it's the right move.

[wilkinsona]

Thanks very much, @mojavelinux.

@jamesfoster, thanks for the additional explanation. Given that all of Asciidoctor’s built-in macros support this, REST Docs’ should too. I’ll correct that in the next maintenance release.

[jamesfoster]

Thanks :)

[jamesfoster]

When is 1.2.4 due to be released?

[jamesfoster]

@wilkinsona Did this make it into 1.2.4-RELEASE? We updated but we're still getting

Snippet http-response not found at /build/generated-snippets/{operation-name}/http-response.adoc for operation {operation-name}

[wilkinsona]

Yes, it should be in 1.2.4 as shown in the commit that closed the issue.

[jamesfoster]

Apologies, it is working. :) We updated spring-restdocs-core and spring-restdocs-mockmvc but not spring-restdocs-asciidoctor

Thanks