how to document Path<> and Query with poem_openapi?

[rxdiscovery]

Hello,

How to add a description to the :id parameter with #[aoi] poem_openapi,

 #[oai(path = "/user/:id", method = "get")]
    async fn hello(&self, Path(id): Path<String>) -> PlainText<String> {
        PlainText(format!("userid = {}", id))
    }

like this:

and also for Url parameters (Query), http://xxxxxxxxxx/yyyy?param1=3 & param2=8784

[rxdiscovery]

it's okay, I found out how :

here's an example of what to do if someone wants to do the same thing :

const ID_EXAMPLE: fn() -> String = || "id code".to_owned();

    #[oai(path = "/user/:id", method = "get")]
    async fn hello(&self, 
                          #[oai(name = "id", example = "ID_EXAMPLE")]
                          /// description here 
                           Path(id): Path<String>
                  ) -> PlainText<String> {
        PlainText(format!("userid = {}", id))
    }

example = "ID_EXAMPLE"
Why do we have to use double quotes when we're calling a function? "example =" won't accept an example in String format.

Poem is very feature-rich, and I'd like to congratulate you on a great piece of work, but unfortunately it lacks documentation and examples for this kind of scenario.

[sunli829]

Why do we have to use double quotes when we're calling a function? "example =" won't accept an example in String format.

Because there could be many different types, not just strings.

like this:
https://serde.rs/field-attrs.html#default--path