added description with example to bucket query param

badges · Feb 25, 2024 · e0778d7 · e0778d7
1 parent 1ac2ad2
commit e0778d7
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/services/scoop/scoop-version.service.js b/services/scoop/scoop-version.service.js
@@ -38,7 +38,12 @@ export default class ScoopVersion extends ConditionalGithubAuthV3Service {
           '[Scoop](https://scoop.sh/) is a command-line installer for Windows',
         parameters: [
           pathParam({ name: 'app', example: 'ngrok' }),
-          queryParam({ name: 'bucket', example: 'extras' }),
+          queryParam({
+            name: 'bucket',
+            description:
+              "App's containing bucket. Can either be a name (e.g `extras`) or a URL to a GitHub Repo (e.g `https://github.com/jewlexx/personal-scoop`)",
+            example: 'extras',
+          }),
         ],
       },
     },