Azure / Azure/azure-rest-api-specs
[BUG] dns resolver pagination Swagger docs
- 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/dnsresolver/resource-manager/Microsoft.Network/stable/2022-07-01/dnsresolver.json
### API Spec version
2022-07-01
### Describe the bug
related to https://github.com/Azure/azure-sdk-for-python/issues/37004 there is an issue with the iterator is reaching the 100th entry (or the last item within page, if top is set).
At least there is an issue within the python SDK (not tested with other SDKs).
Happens with
Package Name: azure-mgmt-dnsresolver
Package Version: 1.0.0
Solved with
Package Name: azure-mgmt-dnsresolver
Package Version: 1.1.0b1
Related to the issue history, this is an issue with the API swagger documentation.
The fix within the SDK is currently a beta version. Please provide a fix within the API SWAGGER documentation which results in a stable release version. (We are using the SDK within a production environment)
### Expected behavior
No issue with the iterator within the Swagger created SDK
### Actual behavior
Please check https://github.com/Azure/azure-sdk-for-python/issues/37004
### Reproduction Steps
Please check https://github.com/Azure/azure-sdk-for-python/issues/37004
### Environment
Package Name: azure-mgmt-dnsresolver
Package Version: 1.0.0
Operating System: MAC and linux
Python Version: 3.11
Contributor guide
Research direction
Start with specification/dnsresolver/resource-manager/Microsoft.Network/stable/2022-07-01/dnsresolver.json and read the related azure-sdk-for-python issue for the pagination behavior and expected fix. Verify the Swagger change against the 2022-07-01 DNS Resolver API so the generated SDK iterator reaches entries beyond a page boundary and supports a stable SDK release.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, python
- Domain
- api, documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100