Skip to content

Improve the deprecation messages around include_type_name. #38052

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Jan 31, 2019
Merged

Improve the deprecation messages around include_type_name. #38052

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a41ebc2
Improve the deprecation messages around include_type_name.
jtibshirani Jan 30, 2019
dc096ac
Fix typos in messages.
jtibshirani Jan 31, 2019
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
4 changes: 2 additions & 2 deletions server/src/main/java/org/elasticsearch/rest/action/admin/indices/RestCreateIndexAction.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,8 @@ public class RestCreateIndexAction extends BaseRestHandler {
private static final DeprecationLogger deprecationLogger = new DeprecationLogger(
LogManager.getLogger(RestPutMappingAction.class));
public static final String TYPES_DEPRECATION_MESSAGE = "[types removal] Specifying types in create index " +
"requests is deprecated. The parameter include_type_name should be provided and set to false to be " +
"compatible with the next major version.";
"requests is deprecated. To be compatible with 7.0, the mapping definition should not nested under the " +
"type name, and the parameter include_type_name must be provided and set to false.";
Copy link
Contributor

@markharwood markharwood Jan 31, 2019

Choose a reason for hiding this comment

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

"should not nested"

Worrying, this decline in the be population.

Copy link
Contributor

@mayya-sharipova mayya-sharipova Jan 31, 2019

Choose a reason for hiding this comment

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

"the mapping definition should not nested under the type name"

Thanks Julie, I am ok with this message as well, but may be more explicit instruction what needs to be done could be more clear, e.g using Mark's comment "To be compatible with 7.0, the type must be removed from the usual mapping -> type -> properties hierarchy, and the parameter ..."

Copy link
Contributor Author

@jtibshirani jtibshirani Jan 31, 2019

Choose a reason for hiding this comment

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

Worrying, this decline in the be population.

Indeed!


public RestCreateIndexAction(Settings settings, RestController controller) {
super(settings);
Expand Down
6 changes: 3 additions & 3 deletions .../src/main/java/org/elasticsearch/rest/action/admin/indices/RestGetFieldMappingAction.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,9 @@ public class RestGetFieldMappingAction extends BaseRestHandler {

private static final DeprecationLogger deprecationLogger = new DeprecationLogger(
LogManager.getLogger(RestGetFieldMappingAction.class));
public static final String TYPES_DEPRECATION_MESSAGE = "[types removal] Specifying types in get field mapping " +
"requests is deprecated. The parameter include_type_name should be provided and set to false to be " +
"compatible with the next major version.";
public static final String TYPES_DEPRECATION_MESSAGE = "[types removal] The response format of get field " +
"mapping requests will change in 7.0. Please start using the include_type_name parameter set to false " +
"to move to the new, typeless response format that will become the default.";

public RestGetFieldMappingAction(Settings settings, RestController controller) {
super(settings);
Expand Down
9 changes: 5 additions & 4 deletions server/src/main/java/org/elasticsearch/rest/action/admin/indices/RestGetIndicesAction.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,11 @@
*/
public class RestGetIndicesAction extends BaseRestHandler {

private static final DeprecationLogger deprecationLogger = new DeprecationLogger(LogManager.getLogger(RestGetIndicesAction.class));
static final String TYPES_DEPRECATION_MESSAGE = "[types removal] The response format of get indices requests will change in "
+ "the next major version. Please start using the `include_type_name` parameter set to `false` in the request to "
+ "move to the new, typeless response format that will be the default in 7.0.";
private static final DeprecationLogger deprecationLogger = new DeprecationLogger(
LogManager.getLogger(RestGetIndicesAction.class));
static final String TYPES_DEPRECATION_MESSAGE = "[types removal] The response format of get indices requests " +
"will change in 7.0. Please start using the include_type_name parameter set to false to move to the new, " +
"typeless response format that will become the default.";

private static final Set<String> allowedResponseParameters = Collections
.unmodifiableSet(Stream.concat(Collections.singleton(INCLUDE_TYPE_NAME_PARAMETER).stream(), Settings.FORMAT_PARAMS.stream())
Expand Down
6 changes: 3 additions & 3 deletions server/src/main/java/org/elasticsearch/rest/action/admin/indices/RestGetMappingAction.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,9 +59,9 @@
public class RestGetMappingAction extends BaseRestHandler {
private static final Logger logger = LogManager.getLogger(RestGetMappingAction.class);
private static final DeprecationLogger deprecationLogger = new DeprecationLogger(logger);
public static final String TYPES_DEPRECATION_MESSAGE = "[types removal] Using include_type_name in get" +
" mapping requests is deprecated. The parameter will be removed in the next major version.";

public static final String TYPES_DEPRECATION_MESSAGE = "[types removal] The response format of get index " +
"template requests will change in 7.0. Please start using the include_type_name parameter set to false to " +
Copy link
Contributor

@mayya-sharipova mayya-sharipova Jan 31, 2019

Choose a reason for hiding this comment

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

index template requests

Shouldn't it be "get mapping requests"?

Copy link
Contributor Author

@jtibshirani jtibshirani Jan 31, 2019

Choose a reason for hiding this comment

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

👍

"move to the new, typeless response format that will become the default.";

public RestGetMappingAction(final Settings settings, final RestController controller) {
super(settings);
Expand Down
6 changes: 3 additions & 3 deletions server/src/main/java/org/elasticsearch/rest/action/admin/indices/RestPutMappingAction.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,9 @@
public class RestPutMappingAction extends BaseRestHandler {
private static final DeprecationLogger deprecationLogger = new DeprecationLogger(
LogManager.getLogger(RestPutMappingAction.class));
public static final String TYPES_DEPRECATION_MESSAGE = "[types removal] Specifying types in put mapping " +
"requests is deprecated. The parameter include_type_name should be provided and set to false to be " +
"compatible with the next major version.";
public static final String TYPES_DEPRECATION_MESSAGE = "[types removal] Specifying types in create index " +
"requests is deprecated. To be compatible with 7.0, the mapping definition should not nested under the " +
"type name, and the parameter include_type_name must be provided and set to false.";
Copy link
Contributor

@markharwood markharwood Jan 31, 2019

Choose a reason for hiding this comment

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

Another missing "be".


public RestPutMappingAction(Settings settings, RestController controller) {
super(settings);
Expand Down