Details
-
Suggestion
-
Resolution: Unresolved
-
None
-
None
-
1
-
Description
The REST API documentation, especially around endpoints that offer POST capability needs to be dramatically improved. There are many endpoints where there are limits to the amount of data, dependencies, required fields, etc that are not documented.
As an example, the REST endpoint for creating a pull request, the description must be under 32,768 characters. This limitation is not documented in the base documentation for the pull request feature or the REST API documentation.
The lack of detail in the documentation results in painful troubleshooting when the user inadvertently exceeds limits they had no idea that existed. The first step would be to consult the documentation, but there is no information that provides any troubleshooting assistance.