guardrail-dev / guardrail-dev/guardrail

Cascade vendor prefix checks down to a property with no prefix.

Open
#750 0 comments 0 reactions 0 assignees View on GitHub
core documentation enhancement good first issue help wanted
Dominant language
Scala
Stars
541
Forks
138
PR merge metrics
No merged PRs in 30d

Description

Right now we have most of our vendor extensions prefixed with the language or platform in use. So `x-scala-type` describes a custom type for Scala clients, and `x-jvm-type` does the same, but covers all JVM languages. We should also have `x-type`, which would apply to everything. (This is probably not useful for custom types, but would be useful for other properties, like the new `x-{scala,java,jvm}-class-name` extension.)

Referenced in a comment on https://github.com/twilio/guardrail/pull/719

Contributor guide

Open the contributing guide

Research direction

Start by locating the vendor-extension handling and existing checks for x-scala-, x-java-, and x-jvm- properties, using the comment referenced from pull request #719 as context. Confirm the precedence behavior in the relevant tests or add coverage so an unprefixed x-type applies when no more-specific property is present.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, scala
Domain
tooling
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.