Azure / Azure/azure-openapi-validator

[new rule]: mark an 'Id' property to GUID format if it is a real GUID

Open
#319 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

'Id' check, most of the resource ID is a GUID, but some are not, highly recommend to mark an 'Id' property to GUID format if it is a real GUID.

### Related swagger example

N

### Category

SDK

### Severity level

Warning

### Applies to

Management plane API spec, Data plane API spec

### How to fix the violation

If an 'id' is a uuid, then it should be marked as uuid, "format": "uuid"

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

Will help developer to avoid pass wrong id to service

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.