Descriptions for endpoints in Swagger for Plumber API

General
1

The documentation for Plumber endpoint block annotations states the following about comments without an annotation:

First line without annotation will be mapped to Summary field subsequent lines will be mapped to Description field.

I would like to add a more elaborate description for my endpoint, but the result is not as I expected. There does not seem to be a distinction between summary and description.

library(plumber)

#* @apiTitle Plumber Example API
#* @apiDescription Plumber example description.

#* This is the summary.
#* 
#* This should be a description (if I understand correctly). 
#* @param msg The message to echo
#* @get /echo
function(msg = "") {
    list(msg = paste0("The message is: '", msg, "'"))
}

Running this API results in the following in the Swagger UI:

image
image859×156 7.53 KB

I would expect the description (highlighted in yellow) to end up on the location marked in red. Am I misunderstanding the documentation or not applying it correctly? Or is this a bug in Plumber?

2

This topic was automatically closed 42 days after the last reply. New replies are no longer allowed.

If you have a query related to it or one of the replies, start a new topic and refer back with a link.