Azure / Azure/azure-rest-api-specs
Possible mistake in FormRecognizer/stable/2023-07-31/FormRecognizer.json
- Dominant language
- TypeSpec
- Stars
- 3.1k
- Forks
- 5.9k
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 444
Description
Hello,
I believe I have found a mistake in the FormRecognizer.json file located at
https://github.com/Azure/azure-rest-api-specs/blob/main/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/FormRecognizer.json
The issue is around the GetOperation function as shown in the example:
[specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/GetOperation.json
](https://github.com/Azure/azure-rest-api-specs/blob/main/specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/examples/GetOperation.json)
If you look at the parameter "operationId" you can see it is a GUID, but in the response, it is a string, a "{number} _ {guid}". In the FormRecognizer.json file (c line 3148) it defines PathOperationId with a format of uuid, which I think needs removing and the pattern changing to "^[0-9]*_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
I hope that this is the right place to report this.
Regards
Contributor guide
Research direction
Start with specification/cognitiveservices/data-plane/FormRecognizer/stable/2023-07-31/FormRecognizer.json around line 3148 and compare PathOperationId with examples/GetOperation.json. Verify how the operationId parameter and response are represented, then confirm the schema and example consistently accept the documented number_guid form.
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
- Clearly specified
- Newbie friendliness
- 43/100