puppetlabs / puppetlabs/puppet-resource_api

Add `default:` for `connection_info` attributes on transports

Open
#231 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Ruby
Stars
27
Forks
42
PR merge metrics
No merged PRs in 30d

Description

Use Case

Optional attributes for transport connection_info often have default values. Currently this requires calling out the default value in the desc string and defining a fallback calculation in code, leading to duplication at best and inconsistency at worst.

Describe the Solution You Would Like

Define a default: key equivalent to the attributes in types.

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 transport connection_info attributes are defined and how type attributes currently handle defaults. Compare the existing description and fallback behavior, then determine the tests covering connection_info defaults. Done means transports can declare a default value through a default: key without duplicating it in descriptions or fallback calculations.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
api
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.