Skip to content

Commit 48ebe66

Browse files
therveNouemanKHAL
andauthored
Document pagination method (#996)
* Document pagination method * Apply suggestions from code review Co-authored-by: NouemanKHAL <[email protected]> Co-authored-by: NouemanKHAL <[email protected]>
1 parent 1254b41 commit 48ebe66

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,23 @@ async def main():
9898
asyncio.run(main())
9999
```
100100

101+
### Pagination
102+
103+
Several listing operations have a pagination method to help consume all the items available.
104+
For example, to retrieve all your incidents:
105+
106+
```python
107+
from datadog_api_client import ApiClient, Configuration
108+
from datadog_api_client.v2.api.incidents_api import IncidentsApi
109+
110+
configuration = Configuration()
111+
configuration.unstable_operations["list_incidents"] = True
112+
with ApiClient(configuration) as api_client:
113+
api_instance = IncidentsApi(api_client)
114+
for incident in api_instance.list_incidents_with_pagination():
115+
print(incident.id)
116+
```
117+
101118
## Documentation for API Endpoints and Models
102119

103120
Documentation for API endpoints and models are available on [readthedocs](https://datadog-api-client.readthedocs.io/).

0 commit comments

Comments
 (0)