Skip to content

[python-fastapi] Check regex pattern on array items#23748

Open
rgroothuijsen wants to merge 1 commit intoOpenAPITools:masterfrom
rgroothuijsen:issue-23102
Open

[python-fastapi] Check regex pattern on array items#23748
rgroothuijsen wants to merge 1 commit intoOpenAPITools:masterfrom
rgroothuijsen:issue-23102

Conversation

@rgroothuijsen
Copy link
Copy Markdown
Contributor

@rgroothuijsen rgroothuijsen commented May 9, 2026

When a model field is an array rather than a single value, no regex check is performed on the array's items even if the OpenAPI spec defines one. This adds a per-item check to a field if it is an array, based on the existing code used to validate single values. Given the provided test case, the result would look like this:

@field_validator('tags')
def tags_items_validate_regular_expression(cls, value):
    """Validates the regular expression"""
    if value is None:
        return value

    for item in value:
        if item is None:
            continue

        if not re.match(r"^[A-Z0-9_\- ]+$", item):
            raise ValueError(r"must validate the regular expression /^[A-Z0-9_\- ]+$/")
    return value

Fixes #23102

@cbornet @tomplus @krjakbrjak @fa0311 @multani

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in WSL)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Summary by cubic

Add per-item regex validation for array fields in python-fastapi models so item patterns from the OpenAPI spec are enforced at runtime. Fixes #23102.

  • Bug Fixes
    • Generate an item-wise @field_validator for array fields that applies the item regex (incl. nullable handling and regex modifiers).
    • Process item patterns in codegen by calling postProcessPattern on property.items.
    • Add test testRegexPatternCheckedForArrayItems using 3_1/issue_23102.yaml.

Written for commit f75cf04. Summary will update on new commits.

Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 4 files

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUG] [Python] OpenAPI code generator ignores pattern constraint on array items

1 participant