oracle / oracle/oci-ruby-sdk

Gem size reduction

Open
#84 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

SDK
Dominant language
Ruby
Stars
30
Forks
19
PR merge metrics
No merged PRs in 30d

Description

@ZiyaoQiao - I wanted to let you know of a recent change I made to the openapi generator in https://github.com/OpenAPITools/openapi-generator/pull/22052, which was released in 7.17.0. This introduces a base model to share a lot of the duplicated code for models. In one of our recent gems it reduced the overall size significantly. See https://github.com/ManageIQ/kubevirt-sdk-ruby/pull/41.

Please consider including this change in the oci gem to reduce its size. I'd make a PR myself, but I'm not sure how this one is generated. This gem is one of our largest gems, so a reduction in size here will go a long way. Also note that I plan to make more changes to the openapi-generator in the future to even further reduce gem sizes.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing how the OCI Ruby gem is generated, then review the OpenAPI Generator change released in 7.17.0 and the linked kubevirt-sdk-ruby pull request for the base-model approach. Regenerate the gem and verify that model code is shared and the resulting gem is smaller.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, ruby
Domain
cloud, tooling
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.