Document new exceptions in README

Signed-off-by: Adam Cmiel <acmiel@redhat.com>
release-engineering · Mar 28, 2019 · 8e68fa2 · 8e68fa2
1 parent abde779
commit 8e68fa2
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/docs/usage/v1.md b/docs/usage/v1.md
@@ -44,14 +44,19 @@ Error messages have following format:
   "message": "<detailed error description>",
 }
 ```
+There may potentially be other fields providing further details,
+such as `"validation_info"` if the error is caused by validation failure,
+or `"quay_response"` if the error occurs while pushing to quay.
 
 
 | HTTP Code / `status` |  `error`    |  Explanation        |
 |-----------|------------------------|---------------------|
 |400| OMPSUploadedFileError | Uploaded file didn't meet expectations (not a zip file, too big after unzip, corrupted zip file) |
 |400| OMPSExpectedFileError | Expected file hasn't been attached |
+|400| PackageValidationError | Package failed validation (e.g. invalid yaml, missing required fields...) |
 |400| OMPSInvalidVersionFormat | Invalid version format in URL |
 |403| OMPSAuthorizationHeaderRequired| No `Authorization` header found in request|
+|403| QuayAuthorizationError | Unauthorized access to quay |
 |500| QuayCourierError | operator-courier module raised exception during building and pushing manifests to quay|
 |500| QuayPackageError | Failed to get information about application packages from quay |
 

diff --git a/docs/usage/v2.md b/docs/usage/v2.md
@@ -44,14 +44,19 @@ Error messages have following format:
   "message": "<detailed error description>",
 }
 ```
+There may potentially be other fields providing further details,
+such as `"validation_info"` if the error is caused by validation failure,
+or `"quay_response"` if the error occurs while pushing to quay.
 
 
 | HTTP Code / `status` |  `error`    |  Explanation        |
 |-----------|------------------------|---------------------|
 |400| OMPSUploadedFileError | Uploaded file didn't meet expectations (not a zip file, too big after unzip, corrupted zip file) |
 |400| OMPSExpectedFileError | Expected file hasn't been attached |
+|400| PackageValidationError | Package failed validation (e.g. invalid yaml, missing required fields...) |
 |400| OMPSInvalidVersionFormat | Invalid version format in URL |
 |403| OMPSAuthorizationHeaderRequired| No `Authorization` header found in request|
+|403| QuayAuthorizationError | Unauthorized access to quay |
 |500| QuayCourierError | operator-courier module raised exception during building and pushing manifests to quay|
 |500| QuayPackageError | Failed to get information about application packages from quay |