Skip to content

Commit 694d9aa

Browse files
authored
(DOCSP-50283) Fix misleading admonition.-v7.0-backport (864) (#868)
# Backport This will backport the following commits from `master` to `v7.0`: - [(DOCSP-50283) Fix misleading admonition. (#864)](10gen/docs-ops-manager#864) <!--- Backport version: 9.6.1 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport)
1 parent 660a66f commit 694d9aa

File tree

8 files changed

+10
-28
lines changed

8 files changed

+10
-28
lines changed
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
:gold:`IMPORTANT:` The values in the ``raw`` document differ depending
2+
on the resource that the event applies to. Use this field with caution,
3+
as its structure may vary across resource types.

source/includes/api/list-tables/events/query-params/get-one.rst

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,5 @@ The following query parameters are optional:
2626
The ``raw`` document contains additional meta information about
2727
the event.
2828

29-
.. important::
30-
31-
The values in the ``raw`` document are subject to change. Do
32-
not rely on ``raw`` values for formal monitoring.
29+
.. include:: /includes/api/facts/raw-document-differs.rst
3330
- ``false``

source/includes/api/list-tables/events/responses/orgs-cloud.rst

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -140,10 +140,7 @@
140140
- Additional meta information about the event. This field only
141141
appears when the ``includeRaw`` query parameter is ``true``.
142142

143-
.. important::
144-
145-
The values in the ``raw`` document are subject to change. Do
146-
not rely on ``raw`` values for formal monitoring.
143+
.. include:: /includes/api/facts/raw-document-differs.rst
147144

148145
* - remoteAddress
149146
- string

source/includes/api/list-tables/events/responses/orgs-onprem.rst

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -131,10 +131,7 @@
131131
- Additional meta information about the event. This field only
132132
appears when the ``includeRaw`` query parameter is ``true``.
133133

134-
.. important::
135-
136-
The values in the ``raw`` document are subject to change. Do
137-
not rely on ``raw`` values for formal monitoring.
134+
.. include:: /includes/api/facts/raw-document-differs.rst
138135

139136
* - remoteAddress
140137
- string

source/includes/api/list-tables/events/responses/projects-cloud.rst

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -138,10 +138,7 @@
138138
- Additional meta information about the event. This field only
139139
appears when the ``includeRaw`` query parameter is ``true``.
140140

141-
.. important::
142-
143-
The values in the ``raw`` document are subject to change. Do
144-
not rely on ``raw`` values for formal monitoring.
141+
.. include:: /includes/api/facts/raw-document-differs.rst
145142

146143
* - remoteAddress
147144
- string

source/includes/api/list-tables/events/responses/projects-onprem.rst

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -205,10 +205,7 @@
205205
- Additional meta information about the event. This field only
206206
appears when the ``includeRaw`` query parameter is ``true``.
207207

208-
.. important::
209-
210-
The values in the ``raw`` document are subject to change. Do
211-
not rely on ``raw`` values for formal monitoring.
208+
.. include:: /includes/api/facts/raw-document-differs.rst
212209

213210
* - remoteAddress
214211
- string

source/reference/api/events/get-all-events-for-org.txt

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,10 +62,7 @@ returned events:
6262
The ``raw`` document contains additional meta information about
6363
the event.
6464

65-
.. important::
66-
67-
The values in the ``raw`` document are subject to change. Do
68-
not rely on ``raw`` values for formal monitoring.
65+
.. include:: /includes/api/facts/raw-document-differs.rst
6966
- ``false``
7067

7168
* - minDate

source/reference/api/events/get-all-events-for-project.txt

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -74,10 +74,7 @@ returned events:
7474
The ``raw`` document contains additional meta information about
7575
the event.
7676

77-
.. important::
78-
79-
The values in the ``raw`` document are subject to change. Do
80-
not rely on ``raw`` values for formal monitoring.
77+
.. include:: /includes/api/facts/raw-document-differs.rst
8178
- ``false``
8279

8380
* - minDate

0 commit comments

Comments
 (0)