Update API Specs for dev console #2226

kristenTian · 2022-08-30T22:26:18Z

Signed-off-by: Kristen Tian [email protected]

Description

Update API Specs for dev console following SOP: https://cptnb.github.io/opensearch-dashboards-dev-docs/core-plugins/console/console/

Reminder to keep the opensearch documents until 4350 is addressed.

Issues Resolved

#2219

Check List

Commits are signed per the DCO using --signoff

joshuarrrr

Nice, this seems like a big win. Only one note about future enhancements to the generation script.

joshuarrrr · 2022-08-31T05:37:15Z

src/plugins/console/server/lib/spec_definitions/json/generated/cat.fielddata.json

-        "osd",
+        "kb",


This 💯 looked like a regression to me, and then I took a second look at what this array is... 😂

Yeah it was ha.

joshuarrrr · 2022-08-31T05:38:58Z

src/plugins/console/server/lib/spec_definitions/json/generated/cat.segments.json

@@ -15,6 +15,8 @@
        "p",
        "pb"
      ],
+      "master_timeout": "",


Out of scope for this PR, but as a note, we may want to update the generation script to ignore deprecated properties, as a more subtle way of guiding folks to the new usage. 🤔

Yeah maybe for our side we can just move this out. We can set up some mechanism but good catch @joshuarrrr!. @kristenTian can we delete line 18 due to it not being inclusive?

Will delete all master_timeout under src/plugins/console/server/lib/spec_definitions/json/generated path

joshuarrrr · 2022-08-31T05:42:55Z

Can you also update the commit message to be more explanatory about how this changeset was generated? It's just a helpful breadcrumb for the next dev that needs to do this.

kavilla · 2022-08-31T18:45:22Z

src/plugins/console/server/lib/spec_definitions/json/generated/indices.add_block.json

+  "indices.add_block": {
+    "url_params": {
+      "timeout": "",
+      "master_timeout": "",


same for this can we just remove this master_timeout?

kavilla · 2022-08-31T18:45:51Z

...lugins/console/server/lib/spec_definitions/json/generated/indices.delete_index_template.json

+  "indices.delete_index_template": {
+    "url_params": {
+      "timeout": "",
+      "master_timeout": "",


same remove master_timeout

kavilla · 2022-08-31T18:46:08Z

...lugins/console/server/lib/spec_definitions/json/generated/indices.exists_index_template.json

+  "indices.exists_index_template": {
+    "url_params": {
+      "flat_settings": "__flag__",
+      "master_timeout": "",


same remove master_timeout

kavilla · 2022-08-31T18:46:18Z

src/plugins/console/server/lib/spec_definitions/json/generated/indices.get_index_template.json

+  "indices.get_index_template": {
+    "url_params": {
+      "flat_settings": "__flag__",
+      "master_timeout": "",


same remove master_timeout

kavilla

For the sake of being inclusive, lets just remove the master_timeout

kavilla · 2022-08-31T18:46:23Z

src/plugins/console/server/lib/spec_definitions/json/generated/indices.put_index_template.json

+    "url_params": {
+      "create": "__flag__",
+      "cause": "",
+      "master_timeout": "",


same remove master_timeout

kavilla · 2022-08-31T18:46:30Z

...gins/console/server/lib/spec_definitions/json/generated/indices.simulate_index_template.json

+    "url_params": {
+      "create": "__flag__",
+      "cause": "",
+      "master_timeout": "",


same remove master_timeout

kavilla · 2022-08-31T18:46:36Z

src/plugins/console/server/lib/spec_definitions/json/generated/indices.simulate_template.json

+    "url_params": {
+      "create": "__flag__",
+      "cause": "",
+      "master_timeout": "",


same remove master_timeout

kavilla · 2022-08-31T18:46:53Z

src/plugins/console/server/lib/spec_definitions/json/generated/snapshot.clone.json

+{
+  "snapshot.clone": {
+    "url_params": {
+      "master_timeout": "",


same remove master_timeout

kristenTian · 2022-08-31T20:05:30Z

Can you also update the commit message to be more explanatory about how this changeset was generated? It's just a helpful breadcrumb for the next dev that needs to do this.

added the SOP/doc

codecov-commenter · 2022-08-31T21:29:03Z

Codecov Report

Merging #2226 (8537e72) into main (65005be) will decrease coverage by 0.01%.
The diff coverage is n/a.

❗ Current head 8537e72 differs from pull request most recent head 90d0ddf. Consider uploading reports for the commit 90d0ddf to get more accurate results

@@            Coverage Diff             @@
##             main    #2226      +/-   ##
==========================================
- Coverage   67.21%   67.20%   -0.02%     
==========================================
  Files        3100     3100              
  Lines       59579    59579              
  Branches     9064     9064              
==========================================
- Hits        40049    40043       -6     
- Misses      17344    17349       +5     
- Partials     2186     2187       +1

Impacted Files	Coverage Δ
...s/osd-optimizer/src/node/node_auto_tranpilation.ts	`83.67% <0.00%> (-4.09%)`	⬇️
packages/osd-optimizer/src/node/cache.ts	`50.00% <0.00%> (-2.78%)`	⬇️
...ared/static/forms/hook_form_lib/hooks/use_field.ts	`65.70% <0.00%> (-0.97%)`	⬇️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

Signed-off-by: Kristen Tian <[email protected]>

joshuarrrr

LGTM!

kavilla · 2022-09-08T00:10:57Z

Thank you!

* Update API Specs for dev console * Remove deprecated field - master_timeout Signed-off-by: Kristen Tian <[email protected]> Signed-off-by: Sergey V. Osipov <[email protected]>

kristenTian requested a review from kavilla August 30, 2022 22:26

kristenTian requested a review from a team as a code owner August 30, 2022 22:26

kristenTian mentioned this pull request Aug 30, 2022

[BUG] Update the documentation links for the specs opensearch-project/OpenSearch#4350

Open

joshuarrrr previously approved these changes Aug 31, 2022

View reviewed changes

kavilla reviewed Aug 31, 2022

View reviewed changes

kristenTian dismissed joshuarrrr’s stale review via 8537e72 August 31, 2022 20:17

kristenTian force-pushed the main-spec branch from 8537e72 to 90d0ddf Compare August 31, 2022 20:27

kristenTian added 2 commits September 2, 2022 16:06

Update API Specs for dev console

f62de5f

Signed-off-by: Kristen Tian <[email protected]>

Remove deprecated field - master_timeout

56a09fe

Signed-off-by: Kristen Tian <[email protected]>

kristenTian force-pushed the main-spec branch from 90d0ddf to 56a09fe Compare September 2, 2022 23:07

kristenTian requested review from joshuarrrr and kavilla September 2, 2022 23:09

joshuarrrr approved these changes Sep 7, 2022

View reviewed changes

kavilla approved these changes Sep 8, 2022

View reviewed changes

kavilla merged commit 7f71c87 into opensearch-project:main Sep 8, 2022

ananzh added the v3.0.0 label Sep 8, 2022

joshuarrrr mentioned this pull request Oct 4, 2022

[BUG] Auto-complete menu of Dev Tools is missing _index_template and perhaps others #2219

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update API Specs for dev console #2226

Update API Specs for dev console #2226

kristenTian commented Aug 30, 2022 •

edited

Loading

joshuarrrr left a comment

joshuarrrr Aug 31, 2022

kavilla Aug 31, 2022

joshuarrrr Aug 31, 2022

kavilla Aug 31, 2022

kristenTian Aug 31, 2022

joshuarrrr commented Aug 31, 2022

kavilla Aug 31, 2022 •

edited

Loading

kavilla Aug 31, 2022

kavilla Aug 31, 2022

kavilla Aug 31, 2022

kavilla left a comment

kavilla Aug 31, 2022

kavilla Aug 31, 2022

kavilla Aug 31, 2022

kavilla Aug 31, 2022

kristenTian commented Aug 31, 2022

codecov-commenter commented Aug 31, 2022

joshuarrrr left a comment

kavilla commented Sep 8, 2022

Update API Specs for dev console #2226

Update API Specs for dev console #2226

Conversation

kristenTian commented Aug 30, 2022 • edited Loading

Description

Issues Resolved

Check List

joshuarrrr left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

joshuarrrr commented Aug 31, 2022

kavilla Aug 31, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kavilla left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kristenTian commented Aug 31, 2022

codecov-commenter commented Aug 31, 2022

Codecov Report

joshuarrrr left a comment

Choose a reason for hiding this comment

kavilla commented Sep 8, 2022

kristenTian commented Aug 30, 2022 •

edited

Loading

kavilla Aug 31, 2022 •

edited

Loading