documentation: which method for character encoding for pipe `|`

[tim-lai]

@char0n , cc: @frantuma
moving from closed PR comment: #2038 to this ticket.

I just noticed something with the transform-spec-fragment.js... Using a copy/paste from the raw content, there exists a |, e.g. Header Object | Reference Object], which gets transformed to \|. This is fine, and renders as expected in Monaco.

However, there's also usage of | as the html separator for |. e.g. Header Object | Reference Object].

Opinions on which or either of them to use? If the former, I can make a pass of existing docs to convert them for consistency's sake. If the latter, I'll update this PR to only use &#124;

[char0n]

@tim-lai my take on this: #2038 (comment)

[tim-lai]

IMHO it doesn't matter. Both character sequences render correctly and are used within the OpenAPI documentation interchangeably.

Great. Will leave as-is. Thanks.