Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • O openapi-generator
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 3,476
    • Issues 3,476
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 402
    • Merge requests 402
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • OpenAPI Tools
  • openapi-generator
  • Merge requests
  • !12783

[PHP] Allow strings with only whitespaces in enums

  • Review changes

  • Download
  • Email patches
  • Plain diff
Merged Administrator requested to merge github/fork/thomasphansen/th_php_allow_whitespace_filled_strings_in_enums into master Jul 07, 2022
  • Overview 2
  • Commits 1
  • Pipelines 0
  • Changes 1

Created by: thomasphansen

The current implementation of the PHP client doesn't allow strings containing only white spaces (like ' ') as values for enum, despite they being valid in OpenAPI specification (or, at least not forbidden). This is a fragment of Microsoft Business Central API for reading/posting a Journal Entry (I'm only showing the relevant field):

components:
  schemas:
    JournalEntry:
      - type: object
        properties:
          'Document_Type':
            type: string
            enum:
              - ' '
              - 'Payment'
              - 'Invoice'
              - 'Credit Memo'
              - 'Finance Charge Memo'
              - 'Reminder'
              - 'Refund'
            default: ' '

Microsoft Business Central API demands the default value to be a string with exactly one space character inside it, otherwise it fails. The current PHP generator sanitizes the enum options, removing all white spaces - even if the option contain only white spaces. This PR changes the generator, so that it accepts whitespace-only strings as valid enum options and name them as SPACE_X, where X is the number of spaces inside that string. The change does NOT affect the trimming of enum options containing characters other than spaces - which means, this should not be a BC: it only affect a currently unsupported scenario.

We already use this change in our own branch of openapi-generator - I'm creating some PRs upstream, so that we can share the small bugs we have fixed, and this is one of them! 😄

The immediate benefit of this PR is to allow the OpenAPIGenerator PHP client to work with Microsoft Business Central, but it will surely benefit other APIs using space-only strings as enum values. 😉

Cheers!

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 
    ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    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*. For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master (6.1.0) (minor release - breaking changes with fallbacks), 7.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the [technical committee] @jebentier, @dkarlovi, @mandrean, @jfastnacht, @ybelenko, @renepardon
Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: github/fork/thomasphansen/th_php_allow_whitespace_filled_strings_in_enums