Documentation improvements.

ICTU · Sep 6, 2024 · f7f60a4 · f7f60a4
1 parent 3b9c09b
commit f7f60a4
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 7 deletions.
diff --git a/components/collector/src/source_collectors/github/merge_requests.py b/components/collector/src/source_collectors/github/merge_requests.py
@@ -95,7 +95,7 @@ async def _get_pull_request_response(
                 "owner": self._parameter("owner"),
             },
         )
-        json = await response.json()
+        json = await response.json(content_type=None)
         if repository := json["data"]["repository"]:
             page_info = repository["pullRequests"]["pageInfo"]
             return response, page_info["hasNextPage"], page_info.get("endCursor", "")
@@ -105,13 +105,13 @@ async def _parse_entities(self, responses: SourceResponses) -> Entities:
         """Override to parse the pull requests."""
         pull_requests = []
         for response in responses:
-            json = await response.json()
+            json = await response.json(content_type=None)
             pull_requests.extend(json["data"]["repository"]["pullRequests"]["nodes"])
         return Entities(self._create_entity(pr) for pr in pull_requests)
 
     async def _parse_total(self, responses: SourceResponses) -> Value:
         """Override to parse the total number of pull requests."""
-        return str((await responses[0].json())["data"]["repository"]["pullRequests"]["totalCount"])
+        return str((await responses[0].json(content_type=None))["data"]["repository"]["pullRequests"]["totalCount"])
 
     def _create_entity(self, pull_request) -> Entity:
         """Create an entity from a GitHub JSON pull request."""

diff --git a/components/shared_code/src/shared_data_model/sources/github.py b/components/shared_code/src/shared_data_model/sources/github.py
@@ -35,9 +35,9 @@
     url=HttpUrl("https://github.com/about"),
     parameters={
         "url": URL(
-            name="GitHub instance URL",
-            help="URL of the GitHub instance, with port if necessary, but without path. For example, "
-            "'https://github.com'.",
+            name="GitHub instance API-URL",
+            help="API-URL of the GitHub instance, with port if necessary, but without path. For example, "
+            "'https://api.github.com'.",
             validate_on=["private_token"],
             metrics=ALL_GITHUB_METRICS,
         ),
@@ -56,7 +56,8 @@
             metrics=ALL_GITHUB_METRICS,
         ),
         "private_token": PrivateToken(
-            name="Fine-grained personal access token (with read scope of the repository)",
+            name="Fine-grained personal access token with repository permission 'Pull requests' set to "
+            "access level 'Read-only'.",
             short_name="Personal access token",
             help_url=HttpUrl(
                 "https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/"