chore: address review comments

flanksource · Jun 26, 2024 · df3bf3d · df3bf3d
1 parent 6cd1100
commit df3bf3d
Showing 1 changed file with 17 additions and 11 deletions.
diff --git a/canary-checker/docs/reference/1-prometheus.mdx b/canary-checker/docs/reference/1-prometheus.mdx
@@ -23,32 +23,38 @@ The Prometheus Check connects to the Prometheus host, performs the desired query
     { field: 'query', description: 'PromQL query to execute', required: true },
     {
       field: 'username',
-      description: 'PromQL query to execute',
+      description: 'Username for basic auth',
       scheme: 'EnvVar'
     },
     {
       field: 'password',
-      description: 'PromQL query to execute',
+      description: 'Password for basic auth',
       scheme: 'EnvVar'
     },
     {
       field: 'bearer',
-      description: 'PromQL query to execute',
+      description: 'Bearer token to use for authentication',
       scheme: 'EnvVar'
     },
-    { field: 'oauth', description: 'PromQL query to execute', scheme: '[oAuth](#oauth)' },
+    { field: 'oauth', scheme: '[OAuth](#oauth)' }
   ]}
 />
 
 ## OAuth
 
-<Fields rows={[
-  {field: "clientID", description: "Client ID", scheme: "EnvVar"},
-  {field: "clientSecret", description: "Client Secret", scheme: "EnvVar"},
-  {field: "scope", description: "oAuth Scopes", scheme: "`[]string`"},
-  {field: "tokenURL", description: "Token URL", scheme: "string"},
-  {field: "params", description: "Endpoint parameters", scheme: "`map[string]string`"},
-]}/>
+<Fields
+  rows={[
+    { field: 'clientID', description: 'Client ID', scheme: 'EnvVar' },
+    { field: 'clientSecret', description: 'Client Secret', scheme: 'EnvVar' },
+    { field: 'scope', description: 'Scopes to request', scheme: '`[]string`' },
+    { field: 'tokenURL', description: 'Token URL', scheme: 'string' },
+    {
+      field: 'params',
+      description: 'OAuth parameters when requesting a token',
+      scheme: '`map[string]string`'
+    }
+  ]}
+/>
 
 ## Result Variables