Support for matrix parameters?

[cristalp]

Some people in my company use matrix parameters, for instance

      @Parameter(required = false, allowEmptyValue = false, description = "...")
      @Nullable @MatrixParam("fristId") final Integer fristId) {

If I create OpenAPI with my old Swagger toolchain, I get

    "/api/testing/fristen/{geschaeftstyp}/{geschaeftId}" : {
      "get" : {
        "tags" : [ "testing-misc" ],
        "summary" : "...",
        "description" : "...",
        "operationId" : "getFristen",
        "parameters" : [ {
          "name" : "geschaeftstyp",
          "in" : "path",
          "description" : "...",
          "required" : true,
          "schema" : {
            "type" : "string",
            "enum" : [ "foo", "bar" ]
          }
        }, {
          "name" : "geschaeftId",
          "in" : "path",
          "description" : "...",
          "required" : true,
          "schema" : {
            "type" : "integer",
            "format" : "int32"
          }
        }, {
          "name" : "fristId",
          "in" : "path",
          "description" : "...",
          "required" : true,
          "style" : "matrix",
          "schema" : {
            "type" : "integer",
            "format" : "int32"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "..."
          },
          "400" : {
            "description" : "..."
          },
          "404" : {
            "description" : "..."
          }
        }
      }
    }

The matrix parameter fristId is shown as integer($int32) and (path). It doesn't appear in the path of the endpoint. The matrix parameter is shown as required, which is a bug with the Swagger toolchain.

Generating the same with SmallRye, I get a different representation in SwaggerUI. First of all, the path contains a generated parameter geschaeftIdMatrix. And that parameter is shown as text box containing the following JSON:

{
  "fristId": 0
}

This is the generated OpenAPI part:

    "/api/testing/fristen/{geschaeftstyp}/{geschaeftId}{geschaeftIdMatrix}" : {
      "get" : {
        "tags" : [ "testing-misc" ],
        "summary" : "...",
        "description" : "...",
        "parameters" : [ {
          "name" : "geschaeftId",
          "in" : "path",
          "description" : "...",
          "required" : true,
          "schema" : {
            "format" : "int32",
            "type" : "integer"
          },
          "allowEmptyValue" : false
        }, {
          "name" : "geschaeftIdMatrix",
          "in" : "path",
          "required" : true,
          "schema" : {
            "type" : "object",
            "properties" : {
              "fristId" : {
                "format" : "int32",
                "type" : "integer"
              }
            }
          },
          "style" : "matrix",
          "explode" : true
        }, {
          "name" : "geschaeftstyp",
          "in" : "path",
          "description" : "...",
          "required" : true,
          "schema" : {
            "$ref" : "#/components/schemas/Geschaeftstyp"
          },
          "allowEmptyValue" : false
        } ],
        "responses" : {
          "200" : {
            "description" : "..."
          },
          "400" : {
            "description" : "..."
          },
          "404" : {
            "description" : "..."
          }
        }
      }
    }

I can't tell what's better or worse or "more correct".

However, if I test the Swagger generated endpoint, I get a response.

Using the SmallRye endpoint and entering the same data, I get:

Facade caught unexpected exception: RESTEASY003870: Unable to extract parameter from http request: javax.ws.rs.PathParam(\"geschaeftstyp\") value is '%7Bgeschaeftstyp%7D'

...

Caused by: java.lang.IllegalArgumentException: No enum of type foo.bar.Geschaeftstyp with value {geschaeftstyp} found.

Which brings me to the question: To what extent are matrix parameters supported?

[cristalp]

I checked the attributes of @Parameter and added style = ParameterStyle.MATRIX. However, that doesn't change any of the generated openapi.json.

[cristalp]

See #1967

[cristalp]

Closing this, since the solution will hopefully be done with the issue.