Skip to content

Commit

Permalink
feat(AIP-136): disable http-name-variable and http-parent-variable (#…
Browse files Browse the repository at this point in the history
…1040)

Disable the AIP-136 rules `http-name-variable` and `http-parent-variable` after discussion on https://togithub.com/aip-dev/google.aip.dev/issues/955 identified that these rules were insufficient and not tied to specific guidance.

Fixes #1023 by disabling it.

Note: The rule documentation has a notice that will be highlighted/formatted to stand out.
  • Loading branch information
noahdietz authored Nov 1, 2022
1 parent 96f76e1 commit 0e871f9
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 2 deletions.
3 changes: 3 additions & 0 deletions docs/rules/0136/http-name-variable.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ redirect_from:
- /0136/http-name-variable
---

**Important:** This rule has been temporarily disabled as it does not match any
AIP guidance. See discussion [here][https://github.com/aip-dev/google.aip.dev/issues/955].

# Custom methods: HTTP name variable

This rule enforces that custom methods only use the `name` variable if the RPC
Expand Down
3 changes: 3 additions & 0 deletions docs/rules/0136/http-parent-variable.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ redirect_from:
- /0136/http-parent-variable
---

**Important:** This rule has been temporarily disabled as it does not match any
AIP guidance. See discussion [here][https://github.com/aip-dev/google.aip.dev/issues/955].

# Custom methods: HTTP parent variable

This rule enforces that custom methods only use the `parent` variable if the
Expand Down
6 changes: 4 additions & 2 deletions rules/aip0136/aip0136.go
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,14 @@ func AddRules(r lint.RuleRegistry) error {
136,
httpBody,
httpMethod,
httpNameVariable,
httpParentVariable,
noPrepositions,
standardMethodsOnly,
uriSuffix,
verbNoun,
// These rules are disabled as they have no matching AIP guidance.
// See https://github.com/aip-dev/google.aip.dev/issues/955 for details.
// httpNameVariable,
// httpParentVariable,
)
}

Expand Down

0 comments on commit 0e871f9

Please sign in to comment.