Enable Markdown in schema descriptions (devfile#93)

* Fix the space and line return management as generated by the operator-sdk in the CRD OpenApi schema, so that the descriptions in Json schemas can be markdown with lists. It mainly cleans up spaces added before and after line returns. And double every line return unless it is before a list item. * Copy the descriptions to a new `markdownDescription` so that VSCode can present markdown in hovers. * Update generated schemas Signed-off-by: David Festal <[email protected]>
jignyasamishra · Jul 2, 2020 · 122bbc6 · 122bbc6
1 parent f5fd4ba
commit 122bbc6
Show file tree

Hide file tree

Showing 6 changed files with 3,267 additions and 1,570 deletions.
diff --git a/build.sh b/build.sh
@@ -94,6 +94,7 @@ onError() {
 }
 trap 'onError' ERR
 
+sed -i -e '/"description":/s/ \\n - /\\n- /g' -e '/"description":/s/ \\n \([^-]\)/\\n\\n\1/g' "${BASE_DIR}/schemas/devworkspace-template.json" "${BASE_DIR}/schemas/devworkspace.json"
 
 transform "devworkspace" "${BASE_DIR}/schemas/devworkspace-template.json" ""
 transform "devworkspace" "${BASE_DIR}/schemas/devworkspace.json" 's#"path" *: *"/properties/spec/#"path": "/properties/spec/properties/template/#'

diff --git a/schema-transformation-rules/devworkspace/addMarkdownDescription.jq b/schema-transformation-rules/devworkspace/addMarkdownDescription.jq
@@ -0,0 +1 @@
+walk(if type == "object" and .description then . += { markdownDescription: .description } else . end)
diff --git a/schemas/devfile.json b/schemas/devfile.json
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		walk(if type == "object" and .description then . += { markdownDescription: .description } else . end)