Azure / Azure/azure-rest-api-specs

The property stampId of HardwareSecurityModule should be enum

Open
#10,053 2 comments 0 reactions 0 assignees View on GitHub
Security Service Attention
Dominant language
TypeSpec
Stars
3.1k
Forks
5.9k
Avg merge
3d 2h
Merged PRs (30d)
424

Description

After tested, I found the property [`stampId`](https://github.com/Azure/azure-rest-api-specs/blob/be85a7207da4ed237eef38a945c4b4a6da3b97b0/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2018-10-31-preview/dedicatedhsm.json#L503) of HardwareSecurityModule only allows `stamp1` and `stamp2`. So I think this property should be `enum`. Otherwise, user cannot know what value could be passed?

Contributor guide

Open the contributing guide

Research direction

Open specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2018-10-31-preview/dedicatedhsm.json and inspect HardwareSecurityModule.stampId. Confirm that the allowed values are stamp1 and stamp2, update the property schema to express them as an enum, and validate the specification; done means the permitted values are visible in the API definition.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api
Issue type
Bug
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.