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

[Ruby] Add x-group-parameters support to Ruby client

  • Review changes

  • Download
  • Email patches
  • Plain diff
Merged Administrator requested to merge github/fork/harmony7/ruby-group-parameters into master Mar 08, 2022
  • Overview 0
  • Commits 2
  • Pipelines 0
  • Changes 6

Created by: harmony7

This PR introduces support for x-group-parameters in the ruby-client templates, similar to how it has been added to PHP (#1337) and others in the past.

This helps prevent breakage if the order of parameter documentation changes, and at Fastly helped us in writing data-driven tests. (Other use cases #641 (closed) #5451 (closed))

Support for grouped parameters already exists in the Codegen, so these changes are completely self-contained in template files only. Unfortunately it seems tests for the API files in the Ruby client file have not existed, and for now I didn't have the time to draft them from scratch.

I'm branching from 6.0.x as I believe this can be considered breaking. The existence of x-group-parameters is automatically picked up from input files, and the updated generated client will break user code using those operations.

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 (5.3.0), 6.0.x
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

cc @cliffano @zlx @autopp

Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: github/fork/harmony7/ruby-group-parameters