Change: Improve secret scanning API usage examples

greenbone · Oct 10, 2023 · 17d8436 · 17d8436
1 parent 32734df
commit 17d8436
Showing 1 changed file with 9 additions and 3 deletions.
diff --git a/pontos/github/api/secret_scanning.py b/pontos/github/api/secret_scanning.py
@@ -147,7 +147,7 @@ async def organization_alerts(
 
                 async with GitHubAsyncRESTApi(token) as api:
                     async for alert in api.secret_scanning.organization_alerts(
-                        "my-enterprise"
+                        "my-org"
                     ):
                         print(alert)
         """
@@ -202,7 +202,7 @@ async def alerts(
 
                 async with GitHubAsyncRESTApi(token) as api:
                     async for alert in api.secret_scanning.alerts(
-                        "my-enterprise"
+                        "my-org/my-repo"
                     ):
                         print(alert)
         """
@@ -288,12 +288,18 @@ async def update_alert(
             .. code-block:: python
 
                 from pontos.github.api import GitHubAsyncRESTApi
+                from pontos.github.models.secret_scanning import (
+                    AlertState,
+                    Resolution,
+                )
 
                 async with GitHubAsyncRESTApi(token) as api:
-                    alert = await api.dependabot.update(
+                    alert = await api.secret_scanning.update_alert(
                         "foo/bar",
                         123,
                         AlertState.RESOLVED,
+                        resolution=Resolution.WONT_FIX,
+                        resolution_comment="Not applicable",
                     )
         """
         api = f"/repos/{repo}/secret-scanning/alerts/{alert_number}"