Skip to content

[Bug] ParameterBuilder::required performs a check on self.parameter_in to set the value of required #1438

@dsgallups

Description

@dsgallups

In src/openapi/path.rs:769-777:

impl ParameterBuilder {
    pub fn required(mut self, required: Required) -> Self {
        self.required = required;
        // required must be true, if parameter_in is Path
        if self.parameter_in == ParameterIn::Path {
            self.required = Required::True;
        }

        self
    }

Example

This function calls logic, implying that the value of required is set in an order-dependent way. i.e. if I do

ParameterBuilder::new()
    .required(Required::False)
    .parameter_in(ParameterIn::Query)

The value of required here returns true. I expected this to be false.

ParameterBuilder::new()
    .parameter_in(ParameterIn::Query)
    .required(Required::False)

However, this works as expected.

Solution

Check the type of ParameterIn when calling ParameterBuilder::build or set a different default value for ParameterIn.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions