Azure / Azure/azure-openapi-validator

[new rule]: Add a lint rule to check weird operationId

Open
#451 1 comment 0 reactions 1 assignee Claimed by @jianyexi View on GitHub
sdk-rule
Dominant language
TypeScript
Stars
53
Forks
57
Avg merge
1d 23h
Merged PRs (30d)
2

Description

### Lint rule description

There's a case where service team trying to add apiVersion as a suffix to by pass the unique operationid rule. see details here https://github.com/Azure/azure-rest-api-specs/pull/22240#discussion_r1100937515
I wonder if we could add a lint rule to check weird suffix like this and provide some tips when they have operationId conflcts to avoid them use anything tricky to by pass the new rule.

### Related swagger example

https://github.com/Azure/azure-rest-api-specs/pull/22240#discussion_r1100937515

### Category

SDK

### Severity level

Error

### Applies to

Management plane API spec

### How to fix the violation

change the operationId into a meaningful operationId

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

SDK interface looks weird and will cause unnecessary breaking change if service team choose to fix it next time.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.