NETOBSERV-906 Document json format

[jotak]

Hey @jpinsonneau @OlivierCazade @skrthomas ,

This PR is a first step to automate generating doc for our custom the json format, which now become mandatory to have since it is exposed for kafka export (and it is anyway good to have for people willing to query Loki directly).

I didn't find a satisfying Typescript-API-doc-to-asciidoc tool so what I plan to do is doing this in two steps:

• First, as shown in this PR, generate Typescipt-API-to-markdown here, without much post-edition of the generated files
• Next, open a PR on the operator side that pulls markdown from there, do some post-edition (e.g. merge all in a single file, do some sed here and there), and convert to asciidoc. This will allow having our asciidoc consumable for downstream all in one place.

[skrthomas]

/lgtm

[skrthomas]

/lgtm

[jotak]

/approve

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jotak

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [jotak]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment