Jelajahi Sumber

Fix #47 - Mention API keys in the documentation

George S. Baugh 10 tahun lalu
induk
melakukan
3e62bf6dad
5 mengubah file dengan 8 tambahan dan 8 penghapusan
  1. 2 2
      bin/testrail-report
  2. 2 2
      bin/testrail-runs
  3. 2 2
      bin/testrail-tests
  4. 1 1
      lib/Test/Rail/Parser.pm
  5. 1 1
      lib/TestRail/API.pm

+ 2 - 2
bin/testrail-report

@@ -62,7 +62,7 @@ These override the config, if present.  If neither are used, you will be prompte
 
     --apiurl   [url] : full URL to get to TestRail index document
 
-    --password [key] : Your TestRail Password.
+    --password [key] : Your TestRail Password or a valid API key (TestRail 4.2 and above).
 
     --user    [name] : Your TestRail User Name.
 
@@ -187,7 +187,7 @@ PARAMETERS:
                      If neither are used, you will be prompted.
 
   --apiurl   [url] : full URL to get to TestRail index document
-  --password [key] : Your TestRail Password.
+  --password [key] : Your TestRail Password, or a valid API key (TestRail 4.2 and above).
   --user    [name] : Your TestRail User Name.
 
   [BEHAVIOR]

+ 2 - 2
bin/testrail-runs

@@ -35,7 +35,7 @@ Groups by plan for runs which are children of a plan.
     If neither are used, you will be prompted.
 
   --apiurl   [url] : full URL to get to TestRail index document
-  --password [key] : Your TestRail Password.
+  --password [key] : Your TestRail Password, or a valid API key (TestRail 4.2 and above).
   --user    [name] : Your TestRail User Name.
 
 =head2 TESTING OPTIONS:
@@ -86,7 +86,7 @@ PARAMETERS:
     If neither are used, you will be prompted.
 
   --apiurl   [url] : full URL to get to TestRail index document
-  --password [key] : Your TestRail Password.
+  --password [key] : Your TestRail Password or API key (TestRail 4.4 and above).
   --user    [name] : Your TestRail User Name.
 
 TESTING OPTIONS:

+ 2 - 2
bin/testrail-tests

@@ -43,7 +43,7 @@ testrail-tests - list tests in a run matching the provided filters.
     If neither are used, you will be prompted.
 
   --apiurl   [url] : full URL to get to TestRail index document
-  --password [key] : Your TestRail Password.
+  --password [key] : Your TestRail Password, or a valid API key (TestRail 4.2 and above).
   --user    [name] : Your TestRail User Name.
 
 =head2 TESTING OPTIONS:
@@ -106,7 +106,7 @@ PARAMETERS:
     If neither are used, you will be prompted.
 
   --apiurl   [url] : full URL to get to TestRail index document
-  --password [key] : Your TestRail Password.
+  --password [key] : Your TestRail Password or a valid API key (TestRail 4.2 and above).
   --user    [name] : Your TestRail User Name.
 
 TESTING OPTIONS:

+ 1 - 1
lib/Test/Rail/Parser.pm

@@ -46,7 +46,7 @@ Get the TAP Parser ready to talk to TestRail, and register a bunch of callbacks
 
 =item B<user> - STRING: Name of your TestRail user.
 
-=item B<pass> - STRING: Said user's password.
+=item B<pass> - STRING: Said user's password, or one of their valid API keys (TestRail 4.2 and above).
 
 =item B<debug> - BOOLEAN: Print a bunch of extra messages
 

+ 1 - 1
lib/TestRail/API.pm

@@ -51,7 +51,7 @@ Creates new C<TestRail::API> object.
 
 =item STRING C<USER> - Your TestRail User.
 
-=item STRING C<PASSWORD> - Your TestRail password.
+=item STRING C<PASSWORD> - Your TestRail password, or a valid API key (TestRail 4.2 and above).
 
 =item BOOLEAN C<DEBUG> - Print the JSON responses from TL with your requests.