mik-laj opened a new issue #9736:
URL: https://github.com/apache/airflow/issues/9736


   Hello,
   
   We have a fantastic REST API.  However, something can always be improved. 
The current problem reported by users are not very friendly error messages for 
end-users  To address this issue, we should follow 
[RFC-7807](https://tools.ietf.org/html/rfc7807) more closely. 
   
   Our error responses do not include the URI in the type field. We can fill 
this field with the link to the specification in Web UI:
   https://github.com/apache/airflow/pull/9504
   https://github.com/apache/airflow/pull/9144 
   
   >    This specification does this by identifying a specific type of problem 
(e.g., "out of credit") with a URI [RFC3986]; HTTP APIs can do this by 
nominating new URIs under their control, or by reusing existing ones.
   
   Title and details are not standardized.  The API was developed by many 
contributors and there was freedom in the content of these fields. The content 
of these fields was not reviewed. 
   It is worth noting that the `title` field should do not contain any 
arguments. A common mistake is to put identifiers in the title e.g. `Dag run 
with ID = {} is not found`. It should not change from occurrence to occurrence 
of the problem.  The `details` field may contain more detailed information.
   
   Best regards,
   Kamil
   
     


----------------------------------------------------------------
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:
[email protected]


Reply via email to