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

feat: x-enum-description support added to kotlin-server code generator #19041

Merged
merged 1 commit into from
Jul 1, 2024

Conversation

deicon
Copy link
Contributor

@deicon deicon commented Jul 1, 2024

Using the x-enum-description it's possible to add descriptive comments onto the generated enum values.
This PR adds the comments per enum value based on this extension to kotlin-server generator.

Kotlin committee members

@jimschubert
@dr4ke616
@karismann @Zomzog @andrewemery @4brunu @yutaka0m @stefankoppier

components:
  schemas:
    Pony:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/Type'
    Type:
      type: string
      enum:
        - Earth
        - Pegasi
        - Mercury
      x-enum-descriptions:
        - The planet we all live on
        - Pegasi b is a gas giant exoplanet that orbits a G-type star
        - Mercury is the first planet from the Sun and the smallest in the Solar System

will generate a comment on each value

...
/**
 * 
 *
 * Values: Earth,Pegasi,Mercury
 */


enum class Type(val value: kotlin.String) {


    /**
    * The planet we all live on
    */
    @JsonProperty(value = "Earth")
    Earth("Earth"),


    /**
    * Pegasi b is a gas giant exoplanet that orbits a G-type star
    */
    @JsonProperty(value = "Pegasi")
    Pegasi("Pegasi"),
...

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/configs/*.yaml
    ./bin/utils/export_docs_generators.sh
    
    (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.6.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.

@4brunu 4brunu merged commit c9da04c into OpenAPITools:master Jul 1, 2024
15 checks passed
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.

None yet

2 participants