Support for named path parameters

[jarekkar]

Describe the bug

I have a technical question regarding my usage of the Spring Cloud Contract and Spring Rest Docs projects. So far, everything has been functioning as anticipated. However, I'm now looking to generate snippets for path parameters, specifically for a path like /movies/123. When I attempt this, Spring Rest Docs raises an error: "Snippet Path parameters with the following names were not found in the request: [movieId]." This error makes sense because I haven't named the path parameter in the URL definition.

My question is whether it's possible to provide such information within Spring Cloud Contract, which is written in Groovy?

Sample

Contract

package contracts.web

import org.springframework.cloud.contract.spec.Contract

Contract.make {
    name("fetch_a_movie")
    description("Should fetch a movie")
    request {
        method GET()
        url "/movies/${anyUuid()}" // /movie/{movieId}
    }
    response {
        status OK()
        headers {
            contentType(applicationJson())
        }
        body("""
        {
            "title": "${anyNonBlankString()}"
        }
        """)
    }
}

Rest Docs

RequestDocumentation.parameterWithName("movieId").description("Movie id");

[jarekkar]

Hi Team

Just a gentle reminder about this issue. I understand you're all busy, but I'm eagerly awaiting any updates. If there's any way I can assist or provide more information, please let me know.

Looking forward to your response.

[marcingrzejszczak]

We have the metadata section that could be reused to allow you add additional information (https://docs.spring.io/spring-cloud-contract/reference/project-features-contract/common-top-elements.html#contract-dsl-metadata). We could have the restdocs entry there that would allow making additional mappings. WDYT?