Azure / Azure/azure-rest-api-specs

Specify properties on Microsoft.CognitiveServices/accounts apiProperties

Open
#7,244 1 comment 1 reaction 0 assignees View on GitHub
Cognitive - QnA Maker customer-reported needs-team-attention Service Attention
Dominant language
TypeSpec
Stars
3.1k
Forks
5.9k
Avg merge
3d 2h
Merged PRs (30d)
424

Description

Hey,

it seems as if for the above mentioned resource some properties are not specified as needed. If you want to create an account you need to specify an `apiProperties` sub-object within the properties but there's no documentation on that. Here it only says it has to be a not null object.

If you pass an empty object then you get this:
```
Error: Error creating Cognitive Services Account "qnamaker-stable" (Resource Group "qnamaker-stable"): cognitiveservices
.AccountsClient#Create: Failure responding to request: StatusCode=400 -- Original Error: autorest/azure: Service returne
d an error. Status=400 Code="ApiPropertiesInvalid" Message="The given 'apiProperties' '{}' is invalid. Validation errors
: Required properties are missing from object: qnaRuntimeEndpoint. Path ''."
```

So currently it's not possible to create an account with the current state of documentation so the properties should be specified in detail.

Contributor guide

Open the contributing guide

Research direction

Start with the Microsoft.CognitiveServices/accounts API definition and inspect the schema for the properties.apiProperties object. Confirm which required fields the service expects, including qnaRuntimeEndpoint, then update the specification so the documented properties match successful account creation.

Written by the indexing model from the issue text.

Assessment

Tech stack
azure, openapi
Domain
api
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.