Azure / Azure/azure-rest-api-specs
Inconsistent Error messages for most requests involving x-ms-partitionkey/x-ms-documentdb-partitionkey
- Dominant language
- TypeSpec
- Stars
- 3.1k
- Forks
- 5.9k
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 444
Description
When interacting with endpoints that require a partitionkey to be sent as a header, failure to provide one results in a suggestion to fix the `x-ms-partitionkey` header value and `BadRequest`.

In reality, it should suggest fixing the `x-ms-documentdb-partitionkey` as described in [Delete Document](https://docs.microsoft.com/en-us/rest/api/cosmos-db/delete-a-document)
Here is an example of providing a `x-ms-partitionkey` header and receiving a `BadRequest`...

And here is an example of providing a `x-ms-documentdb-partitionkey` header and receiving a Successful Response...

Contributor guide
Research direction
No source file or test is named. Start by reproducing the documented delete-document requests with and without each partition-key header, then trace the Azure REST specification or service entry covering these endpoints. Done means the error identifies x-ms-documentdb-partitionkey consistently and requests using that header continue to succeed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100