[4 to 5 migration] How do I access Path::path_item in utoipa 5?

[vnermolaev]

Hi there,

I used to build my paths like this:

let paths = PathsBuilder::new()
    .path(
        __path_statement::path(),
        __path_statement::path_item(EndpointTags::Accounts),
    ).build();

But since version 5, the ::path_item() call is no longer accessible.
I can't find any guidance on that in #1124.
Can someone help me figure out the right way to migrate this?
@juhaku I mentioned you because you announced the change in question in #1064. I hope that's all right.

[vnermolaev]

I came up with

let paths = PathsBuilder::new()
    .path_form::<__path_statement>()
    .build();

the tag needs to be inserted in #[utoipa::path(tag = ...)].

[juhaku]

That is a valid way to do it as well. If we look at the docs how the PathItem can be constructed https://docs.rs/utoipa/latest/utoipa/openapi/path/struct.PathItem.html#method.new we see that it takes an Operation and a HttpMethod.

Previously the Path trait returned the PathItem directly but this has been unwound to support PathItems of multiple HttpMethods. By returning only the Operation and a list of HttpMethods, utoipa supports constructing a PathItem per HttpMethod.

Applying the above to the original example of yours the code could look like this in utoipa 5.

let paths = PathsBuilder::new()
    .path(
        __path_statement::path(),
        PathItem::new(
            __path_statement::methods().first().expect("Must have one HTTP method"),
            __path_statement::operation()
        ),
    ).build();

This is effectively same as using the PathsBuilder the way you have done above.