Skip to content

Commit 472acf7

Browse files
olcbeanjavanna
authored andcommitted
[DOCS] fix put_mapping snippet (#28814)
Add a java snippet to be run in an integration test in order to guarantee that the snippet is correct Closes #28778
1 parent 25834e2 commit 472acf7

File tree

3 files changed

+48
-12
lines changed

3 files changed

+48
-12
lines changed

docs/java-api/admin/indices/put-mapping.asciidoc

+2-12
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,9 @@
33

44
The PUT mapping API allows you to add a new type while creating an index:
55

6-
[source,java]
6+
["source","java",subs="attributes,callouts,macros"]
77
--------------------------------------------------
8-
client.admin().indices().prepareCreate("twitter") <1>
9-
.addMapping("tweet", "{\n" + <2>
10-
" \"tweet\": {\n" +
11-
" \"properties\": {\n" +
12-
" \"message\": {\n" +
13-
" \"type\": \"text\"\n" +
14-
" }\n" +
15-
" }\n" +
16-
" }\n" +
17-
" }")
18-
.get();
8+
include-tagged::{client-tests}/IndicesDocumentationIT.java[index-with-mapping]
199
--------------------------------------------------
2010
<1> <<java-admin-indices-create-index,Creates an index>> called `twitter`
2111
<2> It also adds a `tweet` mapping type.

docs/java-api/index.asciidoc

+2
Original file line numberDiff line numberDiff line change
@@ -186,6 +186,8 @@ it to the `transformers`:
186186
</transformer>
187187
--------------------------------------------------
188188

189+
:client-tests: {docdir}/../../server/src/test/java/org/elasticsearch/client/documentation
190+
189191
include::client.asciidoc[]
190192

191193
include::docs.asciidoc[]
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
/*
2+
* Licensed to Elasticsearch under one or more contributor
3+
* license agreements. See the NOTICE file distributed with
4+
* this work for additional information regarding copyright
5+
* ownership. Elasticsearch licenses this file to you under
6+
* the Apache License, Version 2.0 (the "License"); you may
7+
* not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing,
13+
* software distributed under the License is distributed on an
14+
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
* KIND, either express or implied. See the License for the
16+
* specific language governing permissions and limitations
17+
* under the License.
18+
*/
19+
20+
package org.elasticsearch.client.documentation;
21+
22+
import org.elasticsearch.action.admin.indices.create.CreateIndexResponse;
23+
import org.elasticsearch.client.Client;
24+
import org.elasticsearch.test.ESIntegTestCase;
25+
26+
public class IndicesDocumentationIT extends ESIntegTestCase {
27+
28+
public void createMappings() {
29+
Client client = client();
30+
31+
// tag::index-with-mapping
32+
client.admin().indices().prepareCreate("twitter") // <1>
33+
.addMapping("\"tweet\": {\n" + // <2>
34+
" \"properties\": {\n" +
35+
" \"message\": {\n" +
36+
" \"type\": \"text\"\n" +
37+
" }\n" +
38+
" }\n" +
39+
"}")
40+
.get();
41+
// end::index-with-mapping
42+
}
43+
44+
}

0 commit comments

Comments
 (0)