-
Notifications
You must be signed in to change notification settings - Fork 868
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Rename] kbn-spec-to-console in packages directory to osd-spec-to-console #37 #57
Merged
mihirsoni
merged 2 commits into
opensearch-project:dashboards
from
mihirsoni:kbn-spec-to-console
Mar 5, 2021
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
\ mini utility to convert [OpenSearch's REST spec](https://github.com/elastic/elasticsearch/blob/master/rest-api-spec) to Console's (OpenSearch Dashboards) autocomplete format. | ||
|
||
|
||
It is used to semi-manually update Console's autocompletion rules. | ||
|
||
### Retrieving the spec | ||
|
||
If you don't have a copy of the OpenSearch repo on your machine, follow these steps to clone only the rest API specs | ||
|
||
``` | ||
mkdir opensearch-spec && cd opensearch-spec | ||
git init | ||
git remote add origin https://github.com/elastic/elasticsearch | ||
git config core.sparsecheckout true | ||
echo "rest-api-spec/src/main/resources/rest-api-spec/api/*\nx-pack/plugin/src/test/resources/rest-api-spec/api/*" > .git/info/sparse-checkout | ||
git pull --depth=1 origin master | ||
``` | ||
|
||
### Usage | ||
|
||
You need to run the command twice: once for the **OSS** specs and once for the **X-Pack** specs | ||
At the root of the OpenSearch Dashboards repository, run the following commands: | ||
|
||
```sh | ||
# OSS | ||
yarn spec_to_console -g "<OPENSEARCH-REPO-FOLDER>/rest-api-spec/src/main/resources/rest-api-spec/api/*" -d "src/plugins/console/server/lib/spec_definitions/json/generated" | ||
|
||
# X-pack | ||
yarn spec_to_console -g "<OPENSEARCH-REPO-FOLDER>/x-pack/plugin/src/test/resources/rest-api-spec/api/*" -d "x-pack/plugins/console_extensions/server/lib/spec_definitions/json/generated" | ||
``` | ||
|
||
### Information used in Console that is not available in the REST spec | ||
|
||
* Request bodies | ||
* Data fetched at runtime: indices, fields, snapshots, etc | ||
* Ad hoc additions |
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
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
File renamed without changes.
File renamed without changes.
File renamed without changes.
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.
do we delete x-pack?