[GitHub] [airflow] mik-laj commented on a change in pull request #10333: Unify error messages and complete type field in response

[GitBox <gi...@apache.org>]

mik-laj commented on a change in pull request #10333:
URL: https://github.com/apache/airflow/pull/10333#discussion_r473559486



##########
File path: airflow/api_connexion/openapi/v1.yaml
##########
@@ -19,7 +19,29 @@ openapi: 3.0.3
 
 info:
   title: "Airflow API (Stable)"
-  description: Apache Airflow management API.
+  description: |
+    Apache Airflow management API.
+
+    # Errors
+
+    We follow the error response format proposed in [RFC 7807](https://tools.ietf.org/html/rfc7807)
+    also known as Problem Details for HTTP APIs.  As with our normal API responses,
+    your client must be prepared to gracefully handle additional members of the response.
+    ## Unauthenticated
+    <RedocResponse pointer={"#/components/responses/Unauthenticated"} />

Review comment:
       This element is not supported in the Open Source Redoc version. I would just write 2-3 sentences here what this error message means and when it happens and what can be done to fix it.




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org