Azure / Azure/azure-rest-api-specs
Inconsistency in definition of SearchDocumentsResult->"@search.answers"
@Yahnoosh is already working on this.
Since Apr 9, 2021.
- Dominant language
- TypeSpec
- Stars
- 3.1k
- Forks
- 6k
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 444
Description
The [spec](https://raw.githubusercontent.com/Azure/azure-rest-api-specs/e6fa7db931a3e5182e5685630971b64987719938/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchindex.json) defines `SearchDocumentsResult.Answers` property as a dictionary.
```
"@search.answers": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/definitions/AnswerResult"
}
},
```
However, the response has it as an array of `AnswerResult` objects -
The [documentation](https://docs.microsoft.com/en-us/azure/search/semantic-answers) that shows the response Json also clarifies that.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.