Skip to content
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

Add missing type for ignore_dynamic_beyond_limit for the Indices Settings API #2653

Merged
merged 2 commits into from
Jun 26, 2024

Conversation

achyutjhunjhunwala
Copy link
Contributor

Summary

The Index Settings API returns an additional optional field called ignore_dynamic_beyond_limit.
The Type definition for the same was missing in the specifications. Hence as part of this PR added.

Full API details from the edge-lite server

Request

GET /logs-endpoint.alerts-default/_settings

Response

{
  ".ds-logs-endpoint.alerts-default-2024.06.24-000001": {
    "settings": {
      "index": {
        "mapping": {
          "nested_fields": {
            "limit": "80"
          },
          "total_fields": {
            "limit": "5000",
            "ignore_dynamic_beyond_limit": "true"
          },
          "ignore_malformed": "true"
        },
        "hidden": "true",
        "provided_name": ".ds-logs-endpoint.alerts-default-2024.06.24-000001",
        "final_pipeline": ".fleet_final_pipeline-1",
        "creation_date": "1719193327497",
        "number_of_replicas": "1",
        "uuid": "GnzWPltpSHKtwnyC3QdH2Q",
        "version": {
          "created": "8508000"
        },
        "lifecycle": {
          "name": "logs"
        },
        "codec": "best_compression",
        "routing": {
          "allocation": {
            "include": {
              "_tier_preference": "data_hot"
            }
          }
        },
        "number_of_shards": "1",
        "default_pipeline": "logs-endpoint.alerts-8.14.0"
      }
    }
  }
}

@achyutjhunjhunwala achyutjhunjhunwala changed the title Add missing type for ignore_dynamic_beyond_limit for the Indices Sett… Add missing type for ignore_dynamic_beyond_limit for the Indices Settings API Jun 26, 2024
Copy link
Member

@pquentin pquentin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This look good, but I have a question about the doc string.

specification/indices/_types/IndexSettings.ts Outdated Show resolved Hide resolved
Copy link
Contributor

Following you can find the validation results for the APIs you have changed.

API Status Request Response
indices.add_block 🟢 2/2 2/2
indices.analyze 🟢 20/20 20/20
indices.clear_cache 🟢 4/4 4/4
indices.clone 🟢 5/5 5/5
indices.close 🟢 49/49 49/49
indices.create_data_stream 🟢 28/28 28/28
indices.create 🔴 908/945 945/945
indices.data_streams_stats 🟢 4/4 4/4
indices.delete_alias 🔴 15/15 5/15
indices.delete_data_lifecycle Missing test Missing test
indices.delete_data_stream 🟢 28/28 28/28
indices.delete_index_template 🟢 1/1 1/1
indices.delete_template 🟢 9/9 9/9
indices.delete 🟢 105/105 105/105
indices.disk_usage 🟢 5/5 5/5
indices.downsample 🟢 1/1 1/1
indices.exists_alias 🟢 36/36 36/36
indices.exists_index_template Missing test Missing test
indices.exists_template 🟢 15/15 15/15
indices.exists 🟢 39/39 39/39
indices.explain_data_lifecycle Missing test Missing test
indices.field_usage_stats 🟢 5/5 5/5
indices.flush 🟢 30/30 30/30
indices.forcemerge 🔴 12/12 11/12
indices.get_alias 🔴 83/83 71/83
indices.get_data_lifecycle Missing test Missing test
indices.get_data_stream 🔴 12/12 3/12
indices.get_field_mapping 🔴 15/15 14/15
indices.get_index_template 🔴 19/19 15/19
indices.get_mapping 🔴 120/120 108/120
indices.get_settings 🔴 61/61 59/61
indices.get_template 🟢 30/30 30/30
indices.get 🟢 53/53 53/53
indices.migrate_to_data_stream Missing test Missing test
indices.modify_data_stream Missing test Missing test
indices.open 🟢 18/18 18/18
indices.promote_data_stream Missing test Missing test
indices.put_alias 🔴 59/59 20/59
indices.put_data_lifecycle Missing test Missing test
indices.put_index_template 🔴 50/52 52/52
indices.put_mapping 🔴 75/103 103/103
indices.put_settings 🔴 54/57 57/57
indices.put_template 🔴 44/49 49/49
indices.recovery 🟢 9/9 9/9
indices.refresh 🟢 264/264 264/264
indices.reload_search_analyzers 🟢 2/2 2/2
indices.resolve_cluster 🔴 10/12 12/12
indices.resolve_index 🟢 6/6 6/6
indices.rollover 🔴 26/26 1/26
indices.segments 🔴 6/6 5/6
indices.shard_stores 🔴 5/5 4/5
indices.shrink 🟢 5/5 5/5
indices.simulate_index_template 🔴 6/7 5/7
indices.simulate_template 🔴 5/5 4/5
indices.split 🟢 11/11 11/11
indices.stats 🔴 103/103 31/102
indices.unfreeze 🟢 1/1 1/1
indices.update_aliases 🔴 26/26 7/26
indices.validate_query 🟢 7/7 7/7

You can validate these APIs yourself by using the make validate target.

@elastic elastic deleted a comment from github-actions bot Jun 26, 2024
Copy link
Member

@pquentin pquentin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! LGTM.

@pquentin pquentin merged commit 084db75 into main Jun 26, 2024
8 checks passed
@pquentin pquentin deleted the fix-missing-tpe-for-ignore_dynamic_beyond_limit branch June 26, 2024 13:52
Copy link
Contributor

The backport to 8.13 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-8.13 8.13
# Navigate to the new working tree
cd .worktrees/backport-8.13
# Create a new branch
git switch --create backport-2653-to-8.13
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 084db754215a47db52b5c288629a21f1737c9081
# Push it to GitHub
git push --set-upstream origin backport-2653-to-8.13
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-8.13

Then, create a pull request where the base branch is 8.13 and the compare/head branch is backport-2653-to-8.13.

Copy link
Contributor

The backport to 8.14 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-8.14 8.14
# Navigate to the new working tree
cd .worktrees/backport-8.14
# Create a new branch
git switch --create backport-2653-to-8.14
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 084db754215a47db52b5c288629a21f1737c9081
# Push it to GitHub
git push --set-upstream origin backport-2653-to-8.14
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-8.14

Then, create a pull request where the base branch is 8.14 and the compare/head branch is backport-2653-to-8.14.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants