Azure / Azure/azure-rest-api-specs

Microsoft.Synapse workspaces/keys needs better info about "name"

Open
#17,671 0 comments 0 reactions 0 assignees View on GitHub
customer-reported question Service Attention Synapses
Dominant language
TypeSpec
Stars
3.1k
Forks
5.9k
Avg merge
2d 22h
Merged PRs (30d)
444

Description

The "name" field for Microsoft.Synapse/workspaces/keys is required to be the name of the key being used for the activation. The documentation only shows that this is a string value, but from the REST API you can kinda tell that it has to be the keyName.

Please update the docs to show that this needs to be the key name and not some random string. I worked for 3 days before figuring it out.

Contributor guide

Open the contributing guide

Research direction

Locate the Microsoft.Synapse/workspaces/keys REST API specification and find the documentation for its required "name" field. Update the description to state that it must be the keyName of the key used for activation, then verify the generated documentation reflects that requirement.

Written by the indexing model from the issue text.

Assessment

Tech stack
azure, openapi
Domain
api, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.