Put response error json response in markdown code block?

[PeterDaveHello]

Initially, I thought it's a hyperlink issue, that the string https://platform.openai.com/account/api-keys.","type":"invalid_request_error","param":null,"code":"invalid_api_key"}} been recognized as a link to https://platform.openai.com/account/api-keys.%22,%22type%22:%22invalid_request_error%22,%22param%22:null,%22code%22:%22invalid_api_key%22%7D%7D, but my second thought is maybe we should be the error json response in a markdown code block?

[josStorer]

Wrapping it in a code block will completely disable the link highlighting. I prefer to keep it as it is, so that in some cases the links are available and in other cases, users need to manually select them.
If wrapped in a code block, it means that users will always have to select manually

[PeterDaveHello]

In the example, you can see that the users still need to manually select them as the hyperlink isn't correct. In that scenario, the code block can help read and select 😅

[josStorer]

The following screenshot demonstrates the comparison of two situations.

The one above shows the case where text wrapped in code block, and the one below shows the current situation (but should be with red text).

I believe that if the link highlighted is invalid, causing users to have to select manually, the manual selection cost for users is the same regardless of how it is displayed.

However, the current display method (below) allows users to immediately notice that there is a clickable link. If it is invalid, users can manually select it, and if it is valid, users can directly click to enter. I think this form is more user-friendly.

[PeterDaveHello]

It looks like it's because of different markdown render implementations. GitHub's code block can still have the link as the example below so that we can make both of us.

{"error":{"message":"Incorrect API key provided: sk-********************************. You can find your API key at https://platform.openai.com/account/api-keys.","type":"invalid_request_error","param":null,"code":"invalid_api_key"}}

{
  "error": {
    "message": "Incorrect API key provided: sk-********************************. You can find your API key at https://platform.openai.com/account/api-keys.",
    "type": "invalid_request_error",
    "param": null,
    "code": "invalid_api_key"
  }
}

Or, as our points are both user-friendly, could making the json output prettier without a code block make sense of it?

[PeterDaveHello]

Though the hyperlink on GitHub is also not correct, but not that strange 😆

[josStorer]

I can't see GitHub's code block providing link highlighting here. If you are referring to the strange markdown rendering in my previous screenshot, it's because that is not actually a valid JSON. I entered it randomly, so it's normal that it didn't render correctly.

But that's not important, you are right. I can try to format the error json text to make it prettier. This usually can also fix the link, as shown in the following:

[PeterDaveHello]

I can't see GitHub's code block providing link highlighting here.

Sorry, looks like it's done by my extensions, not GitHub.

If you are referring to the strange markdown rendering in my previous screenshot, it's because that is not actually a valid JSON. I entered it randomly, so it's normal that it didn't render correctly.

I'm actually referring to the case that was originally reported. That link was really weird 🤣

[josStorer]

v2.4.9

[PeterDaveHello]

Now it looks better 👍

{
"error": {
"message": "Incorrect API key provided: asdasda. You can find your API key at https://platform.openai.com/account/api-keys.",
"type": "invalid_request_error",
"param": null,
"code": "invalid_api_key"
}
}