Azure / Azure/azure-rest-api-specs
[Question] Missing application/json Content Type in API Specification for DocumentIntelligence
- Dominant language
- TypeSpec
- Stars
- 3.1k
- Forks
- 5.9k
- Avg merge
- 3d 2h
- Merged PRs (30d)
- 424
Description
### API Spec link
https://github.com/Azure/azure-rest-api-specs/blob/main/specification/ai/data-plane/DocumentIntelligence/stable/2024-11-30/DocumentIntelligence.json
### API Spec version
2024-11-30
### Question/Query
We've encountered a discrepancy regarding the content-type specification for the API. Our understanding, based on both the Document Intelligence documentation (https://learn.microsoft.com/en-us/rest/api/aiservices/document-models/analyze-document?view=rest-aiservices-v4.0%20(2024-11-30)&viewFallbackFrom=rest-aiservices-2023-07-31&preserve-view=true&tabs=HTTP) and direct API testing, is that the Document Intelligence service successfully accepts application/json as a content type.
However, we've observed that application/json is currently not listed as an accepted content-type within the API specification itself.
Is this correct?
### Environment
_No response_
Contributor guide
Research direction
Start with specification/ai/data-plane/DocumentIntelligence/stable/2024-11-30/DocumentIntelligence.json and compare its content-type definition with the linked Document Intelligence documentation. Verify whether the service accepts application/json, then document the confirmed behavior and whether the API specification needs correction.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100