[OAS][DOCS] Add overlays for connector config and examples #191791
Merged
Conversation
This file contains 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
lcawl
added
WIP
🤖 GitHub commentsExpand to view the GitHub comments
Just comment with:
|
|
Pinging @elastic/response-ops (Team:ResponseOps) |
lcawl
changed the title
lcawl
force-pushed
the
connector-overlays
branch
from
a209317 to
fff1665
Compare
pmuellr
approved these changes
Sep 5, 2024
There was a problem hiding this comment.
From the PR, in the /oas_docs directory, I was able to run the following to display the rendered version:
make api-docs; make api-docs-overlay; make api-docs-overlay-preview
Looks to me like it's structurally correct - I can see various config and examples in both the serverless and non-serverless versions.
💚 Build Succeeded
Metrics [docs]
History
To update your PR or re-run it, just comment with: |
💔 All backports failed
Manual backportTo create the backport manually run: Questions ?Please refer to the Backport tool documentation |
lcawl
added
backport:skip
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Relates to #191679, which automated the openAPI output for connectors.
This PR creates an overlay to append some information that is missing from the automated output:
There are some other notable absences, which this PR doesn't address:
The rest of the manually-maintained files are now obsolete and are therefore removed.
The PR also adds two commands to the makefile to make it easier to preview docs locally.