# Wrong example in API documentation

**URL:** <https://discuss.elastic.co/t/wrong-example-in-api-documentation/237030>\
**Category:** Elastic Search\
**Tags:** elastic-workplace-search\
**Created:** [June 14, 2020, 4:50pm UTC](https://discuss.elastic.co/t/wrong-example-in-api-documentation/237030 "2020-06-14T16:50:10Z")\
**Posts on this page:** 3\
**Page:** 1

<div class="post-metadata">

**Author:** ![brunofarache](https://sea2.discourse-cdn.com/elastic/user_avatar/discuss.elastic.co/brunofarache/32/70331_2.png) [@brunofarache](https://discuss.elastic.co/u/brunofarache)\
**Post date:** [June 14, 2020, 4:50pm UTC](https://discuss.elastic.co/t/wrong-example-in-api-documentation/237030/1 "2020-06-14T16:50:10Z")

</div>

Hello!

I'm building a [Workplace Search java client](https://github.com/brunofarache/workplace-search-java) and noticed there is a mistake in [Workplace Search permissions API documentation](https://www.elastic.co/guide/en/workplace-search/current/workplace-search-document-permissions-api.html#list-all):

```auto
{
  "user": "user1",
  "permissions": [
    "permission2",
    "permission3",
    "permission4"
  ],
  "user": "user2",
  "permissions": [
    "permission2",
    "permission4"
  ]
}

```

This is an invalid json object, the response body should be a json array, containing objects like the following:

```auto
[{
  "user": "user1",
  "permissions": [
    "permission2",
    "permission3",
    "permission4"
  ]
},
{
  "user": "user2",
  "permissions": [
    "permission2",
    "permission4"
  ]
}]

```

---

<div class="post-metadata">

**Author:** ![MadsOhm](https://sea2.discourse-cdn.com/elastic/user_avatar/discuss.elastic.co/madsohm/32/69154_2.png) [@MadsOhm](https://discuss.elastic.co/u/MadsOhm)\
**Post date:** [June 15, 2020, 7:10am UTC](https://discuss.elastic.co/t/wrong-example-in-api-documentation/237030/2 "2020-06-15T07:10:06Z")

</div>

Thanks brunofarache.

I have submitted a pull-request to update our documentation for this API call. 😃

---

<div class="post-metadata">

**Author:** ![system](https://us1.discourse-cdn.com/elastic/original/3X/1/a/1ac57faf039f6b580b3f104ef42a2a89e41014de.png) [@system](https://discuss.elastic.co/u/system)\
**Post date:** [October 31, 2022, 2:48am UTC](https://discuss.elastic.co/t/wrong-example-in-api-documentation/237030/3 "2022-10-31T02:48:05Z")

</div>

Closed on October 31, 2022, 2:48am UTC

This topic was automatically closed 28 days after the last reply. New replies are no longer allowed.