feat: Add reports usage to readme

Resolves #109 (closed)

spec/openapi.yaml

@@ -47,6 +47,8 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/CommitValidationStatuses"
+        500:
+          description: Error while retrieving data
 
   /eca/status/{fingerprint}/ui:
     get:
@@ -57,6 +59,8 @@ paths:
           description: Success. An HTML page containing status info
         404:
           description: Not Found
+        500:
+          description: Error while retrieving data
 
   /eca/lookup:
     get:
@@ -69,6 +73,8 @@ paths:
           description: User exists with no ECA
         404:
           description: User not found
+        500:
+          description: Error while retrieving data
 
   /webhooks/gitlab/system:
     post:
@@ -95,6 +101,12 @@ paths:
 
   /reports/gitlab/private-projects:
     parameters:
+      - name: key
+        in: query
+        description: The endpoint access key
+        required: true
+        schema:
+          type: string
       - name: status
         in: query
         description: the project's current status - active/deleted
@@ -132,7 +144,7 @@ paths:
               schema:
                 $ref: "#/components/schemas/Error"
         401:
-          description: Unauthorized - user not allowed
+          description: Unauthorized - invalid key
         500:
           description: Error while processing request