Method get

scripts/github_client.py:54–81

Get a specific value of a resource from an endpoint in the GitHub API. Args: github_org (str): The name of the GitHub organization to search. repo (str): The name of the repository to search. endpoint (str):

(
        self,
        github_org: str,
        repo: str,
        endpoint: str,
        query_params: dict | None = None,
        timeout: int | None = None,
    )

        return url

    def get(
        self,
        github_org: str,
        repo: str,
        endpoint: str,
        query_params: dict | None = None,
        timeout: int | None = None,
    ):
        """Get a specific value of a resource from an endpoint in the GitHub API.

        Args:
            github_org (str):
                The name of the GitHub organization to search.
            repo (str):
                The name of the repository to search.
            endpoint (str):
                The endpoint for the resource. For example, issues/{issue_number}. This means we'd
                be making a request to https://api.github.com/repos/{github_org}/{repo}/issues/{issue_number}.
            query_params (dict):
                A dictionary mapping any query parameters to the desired value. Defaults to None.
            timeout (int):
                How long to wait before the request times out. Defaults to None.

        Returns:
            requests.models.Response
        """
        url = self._construct_url(github_org, repo, endpoint)
        return requests.get(url, headers=self.headers, params=query_params, timeout=timeout)

    def post(self, github_org: str, repo: str, endpoint: str, payload: dict):
        """Post to an endpooint in the GitHub API.