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.

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

Correct the documentation for create_doc privilege #47784

Merged
merged 11 commits into from
Nov 19, 2019
Merged

Correct the documentation for create_doc privilege #47784

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
699b427
correct the documentation for create_doc privilege
Oct 9, 2019
059e993
address review comments
Oct 9, 2019
8be6d1b
address review comment
Oct 15, 2019
f4b2a0d
Merge branch 'master' into correct-create-doc-documentation
Oct 15, 2019
b51c37d
address review comment
Oct 15, 2019
4ab8451
[DOCS] Fixes bulleted list in admonition
lcawl Oct 18, 2019
01fe086
Update docs/reference/docs/index_.asciidoc
bizybot Oct 20, 2019
3c1b7f0
Merge branch 'master' into correct-create-doc-documentation
Oct 22, 2019
9ed6f21
address review comment
Oct 22, 2019
da89f8a
Merge branch 'master' into correct-create-doc-documentation
Oct 28, 2019
c595944
Merge branch 'master' into correct-create-doc-documentation
elasticmachine Nov 19, 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
3 changes: 2 additions & 1 deletion docs/reference/docs/index_.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,8 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=if_primary_term]
(Optional, enum) Set to `create` to only index the document
if it does not already exist (_put if absent_). If a document with the specified
`_id` already exists, the indexing operation will fail. Same as using the
`<index>/_create` endpoint. Valid values: `index`, `create`. Default: `index`.
`<index>/_create` endpoint. Valid values: `index`, `create`.
If document id is specified, it defaults to `index` or else it defaults to `create`.
bizybot marked this conversation as resolved.
Show resolved Hide resolved

include::{docdir}/rest-api/common-parms.asciidoc[tag=pipeline]

Expand Down
15 changes: 11 additions & 4 deletions x-pack/docs/en/security/authorization/privileges.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,10 +171,17 @@ Privilege to index documents. Also grants access to the update mapping action.
However, it does not enable a user to update existing documents.
+
--
NOTE: When indexing documents with an external `_id` either via the index API or
the bulk API, the request must use `op_type` as `create`. If `_id`s are
generated automatically, the authorization happens as if the `op_type` is set to
`create`.
[NOTE]
====
This privilege relies on the `op_type` of indexing requests (<<docs-index_>> and
Copy link
Contributor

Choose a reason for hiding this comment

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

This privilege relies on....

It seems to me that the implication here is that when you have only create_doc privilege, you cannot use the index or bulk APIs successfully unless you use one of the three options below. If that's true, I don't think we're making that dependency clear enough. I'd suggest changing "the op_type can be set to create..." to something like "...you must set the op_type to create..."

Copy link
Contributor Author

Choose a reason for hiding this comment

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

When you index a document (with no '_id'), then the 'op_type' is set to 'create' internally. I think the implication is correct here but open for other suggestions. Thank you.

Copy link
Contributor

Choose a reason for hiding this comment

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

Perhaps something more like you must ensure that the op_type is set to create ?

<<docs-bulk>>). When ingesting documents as a user who has the `create_doc`
privilege (and no higher privilege such as `index` or `write`), the `op_type`
can be set to `create` through one of the following:

* Explicitly setting the `op_type` in the index or bulk APIs
* Using the `_create` endpoint for the index API
* Creating a document with an auto-generated `_id`
====

--

Expand Down