Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BUG] [ASCIIDOC] Asciidoc generator sets not defined example values as string value "null" #20670

Conversation

karlo0
Copy link
Contributor

@karlo0 karlo0 commented Feb 16, 2025

The Asciidoc generator writes for not defined example values of e.g. model attributes the string value "null" instead of leaving it empty.

Furthermore, override the toRegularExpression method to avoid additional escapes of e.g. \ -> \\, -> \ in regular expressions by skipping calling the submethod escapeText.
Note: We don't need additonal escapes in regular expressions for the asciidoc generator since we want to print the plain regular expression as it is in a doc file.

This PR closes Issue #17149.

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 Git BASH)
    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 is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@JkbLskw

…e values wrongly to the string value "null" instead of the expected not set value
@wing328
Copy link
Member

wing328 commented Feb 17, 2025

the change makes sense. thanks for the contribution.

@wing328 wing328 merged commit c586362 into OpenAPITools:master Feb 17, 2025
15 checks passed
@wing328 wing328 added this to the 7.12.0 milestone Feb 17, 2025
@karlo0 karlo0 deleted the bugfix-17149-asciidoc-generator-sets-not-defined-example-values-wrongly-as-null-word-string branch February 17, 2025 13:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants