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
  • !5798

[codegen] Helper function for discriminator mapping allowed values

  • Review changes

  • Download
  • Email patches
  • Plain diff
Closed Administrator requested to merge github/fork/CiscoM31/discriminator-allowed-values into master Apr 02, 2020
  • Overview 0
  • Commits 5
  • Pipelines 0
  • Changes 2

Created by: sebastien-rosset

Add a helper function that returns a list of allowed discriminator mapping values for a schema object.

The list of all possible schema discriminator mapping values is obtained from explicit discriminator mapping values in the OpenAPI document, and from inherited discriminators through oneOf, allOf, anyOf.

For example, a discriminator may be defined in a 'Pet' schema as shown below. The Dog and Cat schemas inherit the discriminator through the allOf reference. In the 'Pet' schema, the supported discriminator mapping values for the 'objectType' properties are 'Dog' and 'Cat'. * The allowed discriminator mapping value for the Dog schema is 'Dog'. * The allowed discriminator mapping value for the Cat schema is 'Dog'.

Currently, I don't see any helper function that would return a list of allowed discriminator mapping values, such as "Dog" for the Dog schema.

Pet:
   type: object
   discriminator:
     propertyName: objectType
   required:
     - objectType
   properties:
     objectType:
     type: string
 Dog:
   allOf:
   - $ref: '#/components/schemas/Pet'
   - type: object
     properties:
       p1:
        type: string
 Cat:
   allOf:
   - $ref: '#/components/schemas/Pet'
   - type: object
     properties:
       p2:
         type: string

PR checklist

  • Read the contribution guidelines.
  • If contributing template-only or documentation-only changes which will change sample output, build the project before.
  • Run the shell script(s) under ./bin/ (or Windows batch scripts under.\bin\windows) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the code or mustache templates for a language ({LANG}) (e.g. php, ruby, python, etc).
  • File the PR against the correct branch: master, 4.3.x, 5.0.x. Default: master.
  • Copy the technical committee to review the pull request if your PR is targeting a particular programming language.
Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: github/fork/CiscoM31/discriminator-allowed-values