Azure / Azure/azure-rest-api-specs

Inconsistency in definition of SearchResult->"@search.captions"

Open
#13,847 1 comment 0 reactions 2 assignees Claimed by @Yahnoosh View on GitHub
Search Service Attention
Dominant language
TypeSpec
Stars
3.1k
Forks
5.9k
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 `SearchResult.Captions` property as a dictionary.
```
"@search.captions": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/definitions/CaptionResult"
}
},
```

However, the response has it as an array of CaptionResult objects -
```
"@search.captions": [
{
"text": "Arcadia Resort & Restaurant. The largest year-round resort in the area offering more of everything for your vacation – at the best value! What can you enjoy while at the resort, aside from the mile-long sandy beaches of the lake? Check out our activities sure to excite both young and young-at-heart guests.",
"highlights": null
}
],
```

The [documentation](https://docs.microsoft.com/en-us/azure/search/semantic-answers) that shows the response Json also clarifies that.

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.