Azure / Azure/azure-openapi-validator

[new rule]: Validate the operationId case sensitive and consistent

Open
#415 0 comments 0 reactions 1 assignee Assigned to @konrad-jamrozik View on GitHub
sdk-rule
Dominant language
TypeScript
Stars
53
Forks
57
Avg merge
1d 23h
Merged PRs (30d)
2

Description

### Lint rule description

https://github.com/Azure/azure-rest-api-specs-pr/pull/9366 Here is example PR.

In get method the operationId is "customConfiguration_Get", but in patch method the operationId is "CustomConfiguration_Update".

We need to make sure resource type in operationId is case sensitive and consistent.

### Related swagger example

https://github.com/Azure/azure-rest-api-specs-pr/pull/9366

### Category

Documentation

### Severity level

Error

### Applies to

Management plane API spec, Data plane API spec, RPaaS API spec

### How to fix the violation

Make sure resource type is consistent

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

Doc generation fail.

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.