Skip to content

Commit 4a2bfc8

Browse files
jwilliams-mongojeff-allen-mongo
authored andcommitted
(DOCSP-10843): Make embedding iframe query parameters non-case sensitive (#359)
* (DOCSP-10843): Make embedding iframe query parameters non-case sensitive * (DOCSP-10843): consistency fixed
1 parent 537cb7f commit 4a2bfc8

File tree

5 files changed

+15
-35
lines changed

5 files changed

+15
-35
lines changed

source/embedded-chart-error-codes.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,9 +66,9 @@ table for more information on each error code.
6666
<configure-auth-providers>`.
6767

6868
* - ``6``
69-
- Invalid ``autorefresh`` value specified.
69+
- Invalid ``autoRefresh`` value specified.
7070

71-
- The ``autorefresh`` value must be an integer greater than 0.
71+
- The ``autoRefresh`` value must be an integer greater than 0.
7272

7373
* - ``7``
7474
- :ref:`Filter <embed-options-filter>` not allowed.

source/embedded-chart-options.txt

Lines changed: 10 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -252,45 +252,45 @@ variety of options. Options are available to charts charts embedded with the
252252
Configure Auto Refresh and Data Caching Behavior
253253
------------------------------------------------
254254

255-
Use the ``autorefresh`` query parameter to configure the chart
255+
Use the ``autoRefresh`` query parameter to configure the chart
256256
to refresh automatically.
257257

258258
Use the ``maxDataAge`` query parameter to:
259259

260260
- Determine the interval at which the chart refreshes if
261-
``autorefresh`` is ``true``.
261+
``autoRefresh`` is ``true``.
262262
- Configure the maximum age of data to load from the cache when
263-
loading or manually refreshing the chart if ``autorefresh``
263+
loading or manually refreshing the chart if ``autoRefresh``
264264
is ``false`` or omitted.
265265

266266
To learn how |charts| loads data from the cache when loading
267-
or refreshing the chart based on the ``autorefresh`` and
267+
or refreshing the chart based on the ``autoRefresh`` and
268268
``maxDataAge`` values, see :ref:`auto-refresh-behavior`.
269269

270270
Use the options on the
271271
:guilabel:`Unauthenticated` tab on the :guilabel:`Embed Chart`
272-
dialog to customize the ``autorefresh`` value in the iframe
272+
dialog to customize the ``autoRefresh`` value in the iframe
273273
snippet.
274274

275275
Example
276276
~~~~~~~
277277

278278
The following iframe embeds a chart which automatically
279279
refreshes every 30 seconds as defined by the
280-
``autorefresh=true`` and the ``maxDataAge=30`` query
280+
``autoRefresh=true`` and the ``maxDataAge=30`` query
281281
parameters:
282282

283283
.. code-block:: html
284284

285285
<iframe style="border: none;border-radius: 2px;box-shadow: 0 2px
286286
10px 0 rgba(70, 76, 79, .2);" width="640" height="480" src="
287287
{charts-host}/embed/charts?id=b3ca720f-4b4a-40b4-a726-e7dc0c49aa1c&
288-
autorefresh=true&maxDataAge=30"></iframe>
288+
autoRefresh=true&maxDataAge=30"></iframe>
289289

290290
Considerations
291291
~~~~~~~~~~~~~~
292292

293-
- The minimum cache duration is 10 seconds. If ``autorefresh``
293+
- The minimum cache duration is 10 seconds. If ``autoRefresh``
294294
is ``true`` and you specify a ``maxDataAge`` value less than
295295
10, the chart refreshes every 10 seconds.
296296

@@ -311,7 +311,7 @@ variety of options. Options are available to charts charts embedded with the
311311

312312
.. example::
313313

314-
If ``autorefresh`` is ``true``, the cache duration is one
314+
If ``autoRefresh`` is ``true``, the cache duration is one
315315
minute (``maxDataAge=60``), and the expiry date of the
316316
signature is in one hour, the chart refreshes every minute
317317
for an hour. Once one hour has elapsed, the chart will not
@@ -477,25 +477,7 @@ Auto Refresh and Data Caching Behavior
477477
--------------------------------------
478478

479479
The following table describes how |charts| loads data from the cache
480-
when loading or refreshing the chart based on the ``autorefresh`` or
480+
when loading or refreshing the chart based on the
481481
``autoRefresh`` and ``maxDataAge`` values.
482482

483-
.. note::
484-
485-
The casing of the ``autoRefresh`` option differs based on whether
486-
you embed a chart using the Embedding SDK or an iframe:
487-
488-
.. list-table::
489-
:header-rows: 1
490-
:widths: 50 50
491-
492-
* - Embedding Method
493-
- Auto Refresh Option
494-
495-
* - Embedding SDK
496-
- ``autoRefresh``
497-
498-
* - iframe
499-
- ``autorefresh``
500-
501483
.. include:: /includes/autorefresh-maxdataage-values.rst

source/embedding-charts-sdk.txt

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@ Embed Charts with the Embedding SDK
1212
:depth: 2
1313
:class: singlecol
1414

15-
.. |autorefresh| replace:: ``autoRefresh``
16-
1715
.. include:: /includes/sdk-beta.rst
1816

1917
You can embed a chart into a web application with the Charts Embedding

source/filter-embedded-charts.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ an Unauthenticated chart and a Verified Signature chart:
152152
https://charts.mongodb.com/charts-atlasproject1-piocy/embed/charts?
153153
id=93584ddb-1115-4a12-afd9-5129e47bbb0d&
154154
filter={"imdb.rating":%20{$gte:%208}}&
155-
autorefresh=30
155+
autoRefresh=30
156156

157157
The URL uses an encoded ``filter`` parameter of
158158
``{"imdb.rating":%20{$gte:%208}}``. Decoded,
@@ -203,7 +203,7 @@ an Unauthenticated chart and a Verified Signature chart:
203203
timestamp=1564156636&
204204
expires-in=300&
205205
filter=%7B%22imdb.rating%22%3A%20%7B%24gte%3A%208%7D%7D&
206-
autorefresh=30&
206+
autoRefresh=30&
207207
signature=8e0d92b33934c928f6c6974e2f0102ace77f56d851cb0d33893e84c359ab1043
208208

209209
The URL uses an encoded ``filter`` parameter of

source/includes/autorefresh-maxdataage-values.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
:header-rows: 1
33
:widths: 33 33 33
44

5-
* - ``autorefresh`` or ``autoRefresh`` Value
5+
* - ``autoRefresh`` Value
66
- ``maxDataAge`` Value
77
- |charts| Behavior
88

0 commit comments

Comments
 (0)