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

Type removal for 2.0 #54

Merged
merged 3 commits into from
May 18, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/workflows/test_unreleased.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ jobs:
matrix:
entry:
- { opensearch_ref: '1.x' }
- { opensearch_ref: '2.0' }
- { opensearch_ref: '2.x' }
- { opensearch_ref: 'main' }
steps:
- name: Checkout OpenSearch
uses: actions/checkout@v2
Expand Down
18 changes: 0 additions & 18 deletions docs/build/OpenSearch/Client.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,6 @@ The class defines the following methods:
----
/*
$params['index'] = (string) Default index for items which don't provide one
$params['type'] = DEPRECATED (string) Default document type for items which don't provide one
$params['wait_for_active_shards'] = (string) Sets the number of shard copies that must be active before proceeding with the bulk operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
$params['refresh'] = (enum) If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. (Options = true,false,wait_for)
$params['routing'] = (string) Specific routing value
Expand Down Expand Up @@ -129,7 +128,6 @@ $params['body'] = (array) A comma-separated list of scroll IDs to clear if
----
/*
$params['index'] = (list) A comma-separated list of indices to restrict the results
$params['type'] = DEPRECATED (list) A comma-separated list of types to restrict the results
$params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)
$params['ignore_throttled'] = (boolean) Whether specified concrete, expanded or aliased indices should be ignored when throttled
$params['allow_no_indices'] = (boolean) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
Expand Down Expand Up @@ -159,7 +157,6 @@ $params['body'] = (array) A query to restrict the results specifie
/*
$params['id'] = (string) Document ID (Required)
$params['index'] = (string) The name of the index (Required)
$params['type'] = DEPRECATED (string) The type of the document
$params['wait_for_active_shards'] = (string) Sets the number of shard copies that must be active before proceeding with the index operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
$params['refresh'] = (enum) If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. (Options = true,false,wait_for)
$params['routing'] = (string) Specific routing value
Expand All @@ -182,7 +179,6 @@ $params['body'] = (array) The document (Required)
/*
$params['id'] = (string) The document ID (Required)
$params['index'] = (string) The name of the index (Required)
$params['type'] = DEPRECATED (string) The type of the document
$params['wait_for_active_shards'] = (string) Sets the number of shard copies that must be active before proceeding with the delete operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
$params['refresh'] = (enum) If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. (Options = true,false,wait_for)
$params['routing'] = (string) Specific routing value
Expand All @@ -204,7 +200,6 @@ $params['version_type'] = (enum) Specific version type (Options = inte
----
/*
$params['index'] = (list) A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices (Required)
$params['type'] = DEPRECATED (list) A comma-separated list of document types to search; leave empty to perform the operation on all types
$params['analyzer'] = (string) The analyzer to use for the query string
$params['analyze_wildcard'] = (boolean) Specify whether wildcard and prefix queries should be analyzed (default: false)
$params['default_operator'] = (enum) The default operator for query string query (AND or OR) (Options = AND,OR) (Default = OR)
Expand Down Expand Up @@ -264,7 +259,6 @@ $params['master_timeout'] = (time) Specify timeout for connection to master
/*
$params['id'] = (string) The document ID (Required)
$params['index'] = (string) The name of the index (Required)
$params['type'] = DEPRECATED (string) The type of the document (use `_all` to fetch the first document matching the ID across all types)
$params['stored_fields'] = (list) A comma-separated list of stored fields to return in the response
$params['preference'] = (string) Specify the node or shard the operation should be performed on (default: random)
$params['realtime'] = (boolean) Specify whether to perform the operation in realtime or search mode
Expand All @@ -289,7 +283,6 @@ $params['version_type'] = (enum) Specific version type (Options = internal,e
/*
$params['id'] = (string) The document ID (Required)
$params['index'] = (string) The name of the index (Required)
$params['type'] = DEPRECATED (string) The type of the document; deprecated and optional starting with 7.0
$params['preference'] = (string) Specify the node or shard the operation should be performed on (default: random)
$params['realtime'] = (boolean) Specify whether to perform the operation in realtime or search mode
$params['refresh'] = (boolean) Refresh the shard containing the document before performing the operation
Expand All @@ -313,7 +306,6 @@ $params['version_type'] = (enum) Specific version type (Options = internal,e
/*
$params['id'] = (string) The document ID (Required)
$params['index'] = (string) The name of the index (Required)
$params['type'] = DEPRECATED (string) The type of the document
$params['analyze_wildcard'] = (boolean) Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false)
$params['analyzer'] = (string) The analyzer for the query string query
$params['default_operator'] = (enum) The default operator for query string query (AND or OR) (Options = AND,OR) (Default = OR)
Expand Down Expand Up @@ -360,7 +352,6 @@ $params['body'] = (array) An index filter specified with the Query
/*
$params['id'] = (string) The document ID (Required)
$params['index'] = (string) The name of the index (Required)
$params['type'] = DEPRECATED (string) The type of the document (use `_all` to fetch the first document matching the ID across all types)
$params['stored_fields'] = (list) A comma-separated list of stored fields to return in the response
$params['preference'] = (string) Specify the node or shard the operation should be performed on (default: random)
$params['realtime'] = (boolean) Specify whether to perform the operation in realtime or search mode
Expand Down Expand Up @@ -425,7 +416,6 @@ $params['master_timeout'] = (time) Specify timeout for connection to master
/*
$params['id'] = (string) The document ID (Required)
$params['index'] = (string) The name of the index (Required)
$params['type'] = DEPRECATED (string) The type of the document; deprecated and optional starting with 7.0
$params['preference'] = (string) Specify the node or shard the operation should be performed on (default: random)
$params['realtime'] = (boolean) Specify whether to perform the operation in realtime or search mode
$params['refresh'] = (boolean) Refresh the shard containing the document before performing the operation
Expand All @@ -449,7 +439,6 @@ $params['version_type'] = (enum) Specific version type (Options = internal,e
/*
$params['id'] = (string) Document ID
$params['index'] = (string) The name of the index (Required)
$params['type'] = DEPRECATED (string) The type of the document
$params['wait_for_active_shards'] = (string) Sets the number of shard copies that must be active before proceeding with the index operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
$params['op_type'] = (enum) Explicit operation type. Defaults to `index` for requests with an explicit document ID, and to `create`for requests without an explicit document ID (Options = index,create)
$params['refresh'] = (enum) If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. (Options = true,false,wait_for)
Expand Down Expand Up @@ -487,7 +476,6 @@ $params['body'] = (array) The document (Required)
----
/*
$params['index'] = (string) The name of the index
$params['type'] = DEPRECATED (string) The type of the document
$params['stored_fields'] = (list) A comma-separated list of stored fields to return in the response
$params['preference'] = (string) Specify the node or shard the operation should be performed on (default: random)
$params['realtime'] = (boolean) Specify whether to perform the operation in realtime or search mode
Expand All @@ -510,7 +498,6 @@ $params['body'] = (array) Document identifiers; can be either `docs`
----
/*
$params['index'] = (list) A comma-separated list of index names to use as default
$params['type'] = DEPRECATED (list) A comma-separated list of document types to use as default
$params['search_type'] = (enum) Search operation type (Options = query_then_fetch,query_and_fetch,dfs_query_then_fetch,dfs_query_and_fetch)
$params['max_concurrent_searches'] = (number) Controls the maximum number of concurrent searches the multi search api will execute
$params['typed_keys'] = (boolean) Specify whether aggregation and suggester names should be prefixed by their respective types in the response
Expand All @@ -528,7 +515,6 @@ $params['pre_filter_shard_size'] = (number) A threshold that enforces a
----
/*
$params['index'] = (list) A comma-separated list of index names to use as default
$params['type'] = DEPRECATED (list) A comma-separated list of document types to use as default
$params['search_type'] = (enum) Search operation type (Options = query_then_fetch,query_and_fetch,dfs_query_then_fetch,dfs_query_and_fetch)
$params['typed_keys'] = (boolean) Specify whether aggregation and suggester names should be prefixed by their respective types in the response
$params['max_concurrent_searches'] = (number) Controls the maximum number of concurrent searches the multi search api will execute
Expand Down Expand Up @@ -688,7 +674,6 @@ $params['body'] = (array) The scroll ID if not passed by URL o
----
/*
$params['index'] = (list) A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
$params['type'] = DEPRECATED (list) A comma-separated list of document types to search; leave empty to perform the operation on all types
$params['analyzer'] = (string) The analyzer to use for the query string
$params['analyze_wildcard'] = (boolean) Specify whether wildcard and prefix queries should be analyzed (default: false)
$params['ccs_minimize_roundtrips'] = (boolean) Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution (Default = true)
Expand Down Expand Up @@ -746,7 +731,6 @@ $params['expand_wildcards'] = (enum) Whether to expand wildcard expression to
----
/*
$params['index'] = (list) A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
$params['type'] = DEPRECATED (list) A comma-separated list of document types to search; leave empty to perform the operation on all types
$params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)
$params['ignore_throttled'] = (boolean) Whether specified concrete, expanded or aliased indices should be ignored when throttled
$params['allow_no_indices'] = (boolean) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
Expand Down Expand Up @@ -789,7 +773,6 @@ $params['id'] = (string) The id of the document, when not specifie
/*
$params['id'] = (string) Document ID (Required)
$params['index'] = (string) The name of the index (Required)
$params['type'] = DEPRECATED (string) The type of the document
$params['wait_for_active_shards'] = (string) Sets the number of shard copies that must be active before proceeding with the update operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
$params['_source'] = (list) True or false to return the _source field or not, or a list of fields to return
$params['_source_excludes'] = (list) A list of fields to exclude from the returned _source field
Expand All @@ -816,7 +799,6 @@ $params['body'] = (array) The request definition requires eith
----
/*
$params['index'] = (list) A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices (Required)
$params['type'] = DEPRECATED (list) A comma-separated list of document types to search; leave empty to perform the operation on all types
$params['analyzer'] = (string) The analyzer to use for the query string
$params['analyze_wildcard'] = (boolean) Specify whether wildcard and prefix queries should be analyzed (default: false)
$params['default_operator'] = (enum) The default operator for query string query (AND or OR) (Options = AND,OR) (Default = OR)
Expand Down
Loading