Azure / Azure/azure-openapi-validator

[new rule]: Single word model names are too generic and have high chance of collision with other RPs.

Open
#317 0 comments 0 reactions 0 assignees View on GitHub
sdk-rule
Dominant language
TypeScript
Stars
53
Forks
57
Avg merge
1d 23h
Merged PRs (30d)
2

Description

### Lint rule description

Single word model names are too generic and have high chance of collision with other RPs.

### Related swagger example

N

### Category

SDK

### Severity level

Warning

### Applies to

Management plane API spec, Data plane API spec

### How to fix the violation

Change the name to a more meaningful name which more than one word

### What't the impact if breaking the rule

High chance of collision with other RPs.

Contributor guide

Open the contributing guide

Research direction

The issue names no implementation files, tests, or entry points. Start by locating the validator's existing naming-rule implementation and its tests, then verify that single-word model names in management- and data-plane API specs produce a warning and that multi-word names do not.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
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.