puppetlabs / puppetlabs/puppet-resource_api
register_type with non-symbolized attribute names creates confusion
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 27
- Forks
- 42
- PR merge metrics
- No merged PRs in 30d
Description
Use Case
When specifying an attribute name key as a string ({{'foo' => }}) instead of a symbol ({{foo: }}), the current rsapi implementation will also require the provider to use a string instead of a symbol for this attribute. This could cause confusion and issues down the line.
Describe the Solution You Would Like
???
Additional Context
Originally filed as https://tickets.puppetlabs.com/browse/FM-7730.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the register_type entry point and tracing how attribute-name keys are passed from rsapi to the provider. Define the intended behavior for string and symbol keys, then add regression coverage showing that providers do not need to use a different key type.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- api
- Issue type
- Bug
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100