docs: add post-process for external SDK types #2563
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,38 @@ | ||||||||
| #!/bin/bash | ||||||||
|
|
||||||||
| set -o errexit | ||||||||
| set -o nounset | ||||||||
| set -o pipefail | ||||||||
|
|
||||||||
| # This script post-processes generated API reference docs to replace links to | ||||||||
| # external SDK types with their primitive equivalents, so the docs do not | ||||||||
| # reference missing type definitions. | ||||||||
| # | ||||||||
| # It operates in-place on the generated markdown files under ./docs/. | ||||||||
|
|
||||||||
| SCRIPT_ROOT="$(dirname "${BASH_SOURCE[0]}")/../.." | ||||||||
|
|
||||||||
| # Candidate docs to process (some may not exist in all builds) | ||||||||
| DOC_FILES=( | ||||||||
| "${SCRIPT_ROOT}/docs/konnect-api-reference.md" | ||||||||
| "${SCRIPT_ROOT}/docs/all-api-reference.md" | ||||||||
| "${SCRIPT_ROOT}/docs/configuration-api-reference.md" | ||||||||
| "${SCRIPT_ROOT}/docs/gateway-operator-api-reference.md" | ||||||||
| "${SCRIPT_ROOT}/docs/incubator-api-reference.md" | ||||||||
| ) | ||||||||
|
|
||||||||
| for f in "${DOC_FILES[@]}"; do | ||||||||
| if [[ -f "${f}" ]]; then | ||||||||
| echo "INFO: post-processing ${f}" | ||||||||
| # Map external types to primitives for readability and to avoid dead anchors. | ||||||||
| # AuthType -> string | ||||||||
| sed -i -E 's/_\[AuthType\]\(#authtype\)_/_string_/g' "${f}" | ||||||||
| # CreateControlPlaneRequestClusterType -> string | ||||||||
| sed -i -E 's/_\[CreateControlPlaneRequestClusterType\]\(#createcontrolplanerequestclustertype\)_/_string_/g' "${f}" | ||||||||
| # ControlPlaneClusterType -> string | ||||||||
| sed -i -E 's/_\[ControlPlaneClusterType\]\(#controlplaneclustertype\)_/_string_/g' "${f}" | ||||||||
| # ProxyURL -> object (array forms keep the trailing " array") | ||||||||
| sed -i -E 's/_\[ProxyURL\]\(#proxyurl\) array_/_object array_/g' "${f}" | ||||||||
| sed -i -E 's/_\[ProxyURL\]\(#proxyurl\)_/_object_/g' "${f}" | ||||||||
| fi | ||||||||
| done | ||||||||
|
Contributor
There was a problem hiding this comment.
Suggested change
|
||||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How to maintain this list? Is it generated by some other scripts or maintained manually?
If it is maintained manually, I think we need some comments/documents to introduce how to keep them up to date.