Skip to content
This repository was archived by the owner on Sep 28, 2022. It is now read-only.

Commit 1d7f107

Browse files
authored
[fix] Correctly aim at the right doc snippet files (#94)
## What does this PR do ? Updated a few doc files to aim the real existing **.java** files, instead of some **.js** - collection/**get-mapping** - collection/**truncate** - document/**delete-by-query** - document/**update-by-query** ## Current behaviour ![image](https://user-images.githubusercontent.com/2495908/86008042-93361d00-ba18-11ea-96c3-588bb781958a.png) ### How should this be manually tested? Clone and launch: `npm install & npm run doc-prepare & npm run doc-build` You should not see any errors related to missing snippets. ### Boyscout To get the ci build to succed, had to update [document/update test file](https://github.com/kuzzleio/sdk-java/blob/ad15a06170fa0d69f97b50a34a29705d40510617/doc/3/controllers/document/update/snippets/update.test.yml#L11) to expect: `'expected: "_id=some-id, _version=2"'` instead of: `'{expected: "_id=some-id, _version=2"}'`
1 parent 88c2c0a commit 1d7f107

5 files changed

Lines changed: 5 additions & 5 deletions

File tree

doc/3/controllers/collection/get-mapping/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,4 @@ Returns a `ConcurrentHashMap<String, Object>` representing the collection mappin
3030

3131
## Usage
3232

33-
<<< ./snippets/get-mapping.js
33+
<<< ./snippets/get-mapping.java

doc/3/controllers/collection/truncate/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,4 @@ public CompletableFuture<Void> truncate(
2626

2727
## Usage
2828

29-
<<< ./snippets/truncate.js
29+
<<< ./snippets/truncate.java

doc/3/controllers/document/delete-by-query/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,4 +43,4 @@ Returns an `ArrayList<String>` containing the deleted document ids.
4343

4444
## Usage
4545

46-
<<< ./snippets/delete-by-query.js
46+
<<< ./snippets/delete-by-query.java

doc/3/controllers/document/update-by-query/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,4 +73,4 @@ Each errored document is an object of the `errors` array with the following prop
7373

7474
## Usage
7575

76-
<<< ./snippets/update-by-query.js
76+
<<< ./snippets/update-by-query.java

doc/3/controllers/document/update/snippets/update.test.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ hooks:
88
curl -XPOST -d '{"name":"John"}' -H "Content-Type: application/json" kuzzle:7512/nyc-open-data/yellow-taxi/some-id/_create
99
after:
1010
template: print-result
11-
expected: "{_id=some-id, _version=2}"
11+
expected: "_id=some-id, _version=2"

0 commit comments

Comments
 (0)