Skip to content

Commit 29dbf01

Browse files
authored
(DOCSP-50283) Fix misleading admonition.-v8.0-backport (864) (#867)
# Backport This will backport the following commits from `master` to `v8.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 2ad54cf commit 29dbf01

File tree

8 files changed

+10
-7
lines changed

8 files changed

+10
-7
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 & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,5 +26,5 @@ The following query parameters are optional:
2626
The ``raw`` document contains additional meta information about
2727
the event.
2828

29-
:gold:`IMPORTANT:` The values in the ``raw`` document are subject to change. Do not rely on ``raw`` values for formal monitoring.
29+
.. include:: /includes/api/facts/raw-document-differs.rst
3030
- ``false``

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

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

143-
:gold:`IMPORTANT:` The values in the ``raw`` document are subject to change. Do not rely on ``raw`` values for formal monitoring.
143+
.. include:: /includes/api/facts/raw-document-differs.rst
144144

145145
* - remoteAddress
146146
- string

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@
129129
- Additional meta information about the event. This field only
130130
appears when the ``includeRaw`` query parameter is ``true``.
131131

132-
:gold:`IMPORTANT:` The values in the ``raw`` document are subject to change. Do not rely on ``raw`` values for formal monitoring.
132+
.. include:: /includes/api/facts/raw-document-differs.rst
133133

134134
* - remoteAddress
135135
- string

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

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

141-
:gold:`IMPORTANT:` The values in the ``raw`` document are subject to change. Do not rely on ``raw`` values for formal monitoring.
141+
.. include:: /includes/api/facts/raw-document-differs.rst
142142

143143
* - remoteAddress
144144
- string

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@
200200
- Additional meta information about the event. This field only
201201
appears when the ``includeRaw`` query parameter is ``true``.
202202

203-
:gold:`IMPORTANT:` The values in the ``raw`` document are subject to change. Do not rely on ``raw`` values for formal monitoring.
203+
.. include:: /includes/api/facts/raw-document-differs.rst
204204

205205
* - remoteAddress
206206
- string

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

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

65-
:gold:`IMPORTANT:` The values in the ``raw`` document are subject to change. Do not rely on ``raw`` values for formal monitoring.
65+
.. include:: /includes/api/facts/raw-document-differs.rst
6666
- ``false``
6767

6868
* - minDate

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

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

77-
:gold:`IMPORTANT:` The values in the ``raw`` document are subject to change. Do not rely on ``raw`` values for formal monitoring.
77+
.. include:: /includes/api/facts/raw-document-differs.rst
7878
- ``false``
7979

8080
* - minDate

0 commit comments

Comments
 (0)