Skip to content

Commit de95122

Browse files
committed
Start a short "Troubleshooting guide"
1 parent d609712 commit de95122

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README.adoc

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -260,6 +260,36 @@ JIRA_API_TOKEN_REDHAT=your-PAT
260260

261261
We also use https://smee.io/ to get web hooks delivered to the local env.
262262

263+
== Troubleshooting
264+
265+
Sometimes attempting to make REST requests to Jira API may result in an `Internal Server Error` without much additional
266+
details, e.g.:
267+
[source,json]
268+
----
269+
{
270+
"errorMessages": [
271+
"Internal server error"
272+
],
273+
"errors": {}
274+
}
275+
----
276+
277+
If the request constantly fails even after several retries, it most likely mean that the request contains some fields
278+
that are not present on the "view" the rest request is trying to update. To help track down the reason behind it:
279+
280+
- Enable the request/response logging for a particular rest client (most likely for the "destination" one):
281+
+
282+
[source,json]
283+
----
284+
jira.project-group."<your-project-group-name>".destination.log-requests=true
285+
----
286+
+
287+
- Get the request body of the failing request
288+
- Use your favorite tool for sending REST requests to send a failing request "manually"
289+
- Start removing any fields from the JSON that are "optional" and send requests with modified JSON
290+
* Keep doing so until you identify the field causing the problem
291+
292+
263293
[[license]]
264294
== License
265295

0 commit comments

Comments
 (0)