Skip to content

[DOCS][8.x]:Update depreciation notice for index mapping updates privileges #130916

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
Jul 21, 2025
Merged

[DOCS][8.x]:Update depreciation notice for index mapping updates privileges #130916

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
126aa86
Update index mapping update privileges
charlotte-hoblik Jul 9, 2025
ebe8240
Remove `depricated` tag
charlotte-hoblik Jul 11, 2025
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
38 changes: 20 additions & 18 deletions docs/reference/security/authorization/privileges.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -328,11 +328,11 @@ be mapped rather than an explicit <<indices-put-mapping,update mapping>> request
`create`::
Privilege to index documents.
+
deprecated:[8.0] Also grants the permission to update the index mapping (but
not the data streams mapping), using
the {ref}/indices-put-mapping.html[updating mapping API] or by relying on
{ref}/dynamic-mapping.html[dynamic field mapping]. In a future major release,
this privilege will not grant any mapping update permissions.
deprecated:[8.0] Starting from 8.0, this privilege no longer grants the permission
Copy link
Contributor

@3kt 3kt Jul 10, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Could we call this a change rather than a deprecation? Or maybe a notice? Or something like a partial deprecation? Do we have a clear nomenclature for what such a thing should be called?
My point is that the "deprecated" term tends to push people away from the feature, rather than bringing attention to what exactly changed.

Copy link
Contributor Author

@charlotte-hoblik charlotte-hoblik Jul 11, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Thanks for the feedback! I used deprecated:[8.0] just for the visual effect, since the syntax doesn’t support alternatives like change. I used an important block instead in the 9.x PR, and added the same here. Let me know what you think!

Screenshot 2025-07-11 at 16 09 05 Screenshot 2025-07-11 at 16 19 32

I went with IMPORTANT admonition because it felt like the clearest fit, but if you think NOTE would be more appropriate, happy to switch.

Here’s the list of supported admonitions and when to use them: https://elastic.github.io/docs-builder/syntax/admonitions/

to update index mappings. In earlier versions, it implicitly permitted index mapping
updates (excluding data stream mappings) via the {ref}/indices-put-mapping.html[updating mapping API]
or through {ref}/dynamic-mapping.html[dynamic field mapping].
Mapping update capabilities will be fully removed in a future major release.
+
--
NOTE: This privilege does not restrict the index operation to the creation
Expand All @@ -346,11 +346,11 @@ privilege for an alternative.
Privilege to index documents.
It does not grant the permission to update or overwrite existing documents.
+
deprecated:[8.0] Also grants the permission to update the index mapping (but
not the data streams mapping), using
the {ref}/indices-put-mapping.html[updating mapping API] or by relying on
{ref}/dynamic-mapping.html[dynamic field mapping]. In a future major release,
this privilege will not grant any mapping update permissions.
deprecated:[8.0] Starting from 8.0, this privilege no longer grants the permission
to update index mappings. In earlier versions, it implicitly permitted index mapping
updates (excluding data stream mappings) via the {ref}/indices-put-mapping.html[updating mapping API]
or through {ref}/dynamic-mapping.html[dynamic field mapping].
Mapping update capabilities will be fully removed in a future major release.
+
--
[NOTE]
Expand Down Expand Up @@ -403,11 +403,11 @@ Privilege to delete an index or data stream.
`index`::
Privilege to index and update documents.
+
deprecated:[8.0] Also grants the permission to update the index mapping (but
not the data streams mapping), using
the {ref}/indices-put-mapping.html[updating mapping API] or by relying on
{ref}/dynamic-mapping.html[dynamic field mapping]. In a future major release,
this privilege will not grant any mapping update permissions.
deprecated:[8.0] Starting from 8.0, this privilege no longer grants the permission
to update index mappings. In earlier versions, it implicitly permitted index mapping
updates (excluding data stream mappings) via the {ref}/indices-put-mapping.html[updating mapping API]
or through {ref}/dynamic-mapping.html[dynamic field mapping].
Mapping update capabilities will be fully removed in a future major release.

`maintenance`::
Permits refresh, flush, synced flush and force merge index administration operations.
Expand Down Expand Up @@ -468,9 +468,11 @@ Privilege to perform all write operations to documents, which includes the
permission to index, update, and delete documents as well as performing bulk
operations, while also allowing to dynamically update the index mapping.
+
deprecated:[8.0] It also grants the permission to update the index mapping (but
not the data streams mapping), using the {ref}/indices-put-mapping.html[updating mapping API].
This will be retracted in a future major release.
deprecated:[8.0] Starting from 8.0, this privilege no longer grants the permission
to update index mappings. In earlier versions, it implicitly permitted index mapping
updates (excluding data stream mappings) via the {ref}/indices-put-mapping.html[updating mapping API]
or through {ref}/dynamic-mapping.html[dynamic field mapping].
Mapping update capabilities will be fully removed in a future major release.


==== Run as privilege
Expand Down