Browse Source

better schema descriptions

Tony Fernandez 7 months ago
parent
commit
d11c517f67
1 changed files with 3 additions and 3 deletions
  1. 3 3
      borgmatic/config/schema.yaml

+ 3 - 3
borgmatic/config/schema.yaml

@@ -1630,17 +1630,17 @@ properties:
             username:
             username:
                 type: string
                 type: string
                 description: |
                 description: |
-                    The username used for authentication.
+                    The username used for authentication. Not needed if using an API key.
                 example: testuser
                 example: testuser
             password:
             password:
                 type: string
                 type: string
                 description: |
                 description: |
-                    The password used for authentication.
+                    The password used for authentication. Not needed if using an API key.
                 example: fakepassword
                 example: fakepassword
             api_key:
             api_key:
                 type: string
                 type: string
                 description: |
                 description: |
-                    The API key used for authentication.
+                    The API key used for authentication. Not needed if using an username/password.
                 example: fakekey
                 example: fakekey
             start:
             start:
                 type: object
                 type: object