slackapi/python-slack-sdk

More convenient pagination support in SCIM / Audit Logs API clients

Open

#1,121 opened on Sep 21, 2021

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Python (3,738 stars) (885 forks)batch import
Version: 3xdiscussiongood first issuescim-client

Description

If it's possible I'd love for the SCIMClient's searches to be able to be paginated like the WebClient does with the SlackResponse. It looks like it could be done with the body returned.

Category (place an x in each of the [ ])

  • slack_sdk.web.WebClient (sync/async) (Web API client)
  • slack_sdk.webhook.WebhookClient (sync/async) (Incoming Webhook, response_url sender)
  • slack_sdk.models (UI component builders)
  • slack_sdk.oauth (OAuth Flow Utilities)
  • slack_sdk.socket_mode (Socket Mode client)
  • slack_sdk.audit_logs (Audit Logs API client)
  • slack_sdk.scim (SCIM API client)
  • slack_sdk.rtm (RTM client)
  • slack_sdk.signature (Request Signature Verifier)

Requirements

Please read the Contributing guidelines and Code of Conduct before creating this issue or pull request. By submitting, you are agreeing to those rules.

Contributor guide

Tech stack
python
Domain
api
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
PythonSlack SDK basicsREST pagination
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
Examine how pagination is implemented in WebClient (e.g., in slack sdk/web/client.py and SlackResponse class). Then apply similar pattern to SCIMClient in slack sdk/scim/ directory. Note that the SCIM API may have different pagination parameters; check Slack's SCIM API documentation. No existing PRs or comments provide further guidance.