kibana/docs
Youhei Sakurai ceb7ad761d
Sort out objectization in variable substitution (#162382)
Closes #162381

## Summary

This PR is,,,

1. Adding documentation about objectization in variable substitution.
2. Fixing a glitch in the illegal double quotes `""`.
    <details open="true"><summary>details</summary>
    
For example, `""${ZERO}""` may have substituted `"0"` but this
substitution must not occur because no quotes surround the `${ZERO}` in
the context of JSON syntax. `""${ZERO}""` is jut `${ZERO}` with forward
and training `""`.</details>
3. Promoting triple quotes `"""` as an alternative to the illegal double
quotes `""`.
    <details open="true"><summary>details</summary>
    
Now `"""${ZERO}"""` is a way to substitute `"""0"""` rather than `0`
that `"${ZERO}"` may substitute. The same as before, these single and
triple quotes work only in the request body.</details>

### Checklist

- [x] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)
- [x]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials
- [x] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios
- [x] This was checked for [cross-browser
compatibility](https://www.elastic.co/support/matrix#matrix_browsers)

Note: Regex negative lookahead `x(?!y)` and ~~lookbehind `(?<!y)x`~~
(_EDIT: no lookbehind anymore_) assertions
([cf.](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_expressions/Assertions#other_assertions))
are used in this PR. So, I've checked the following steps on each
browser.

Browsers:
- Chrome 115.0.5790.102
- Firefox 115.0.2
- Edge 115.0.1901.183
- Safari 16.3 (18614.4.6.1.6) ~~CAN'T CHECK~~ - Safari has recently
added support for the negative lookbehind as per this 16.4 release note.

>
https://developer.apple.com/documentation/safari-release-notes/safari-16_4-release-notes
> Added support for RegExp lookbehind assertions.

Steps:
1. Go to Dev Tools > Console.
2. Click `Variables` on the top.
4. Define variable `ZERO` with `0`.
6. Run the following command.

```http
POST test/_doc
{
  "field": "${ZERO}"
}
```

### For maintainers

- [x] This was checked for breaking API changes and was [labeled
appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)

## Release note

Improves a way of variable substitution and its documentation

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
2023-07-27 09:30:52 +09:00
..
api [DOCS] Clarify API key authorization for alerting (#161717) 2023-07-17 09:41:23 -07:00
api-generated [Cases] Update docs for remaining guardrails (#162492) 2023-07-26 12:29:38 +02:00
apm [APM] Update Storage Explorer docs (#162163) 2023-07-20 09:29:54 +01:00
canvas [Canvas] Update function reference docs (#156409) 2023-05-03 11:24:47 -07:00
concepts [docs] [kql] Update KQL docs to include info about errors with multiple field types (#158035) 2023-05-23 12:29:47 -04:00
dev-tools Sort out objectization in variable substitution (#162382) 2023-07-27 09:30:52 +09:00
developer [Lens][Event annotations] Move logic into packages (#161500) 2023-07-19 09:46:57 -05:00
development/plugins/expressions/public Remove old doc generation system for core APIs (#134313) 2022-06-21 17:43:17 +02:00
discover [DOCS] License level required (#160638) 2023-06-28 09:48:25 +01:00
fleet Update Fleet overview topic (#121153) 2021-12-14 09:14:02 -08:00
getting-started [DOCS] Fix links to ingest content in the obs guide (#158984) 2023-06-06 16:05:13 -07:00
management [DOCS] Document Generative AI Token Usage dashboard in Gen AI connector (#162374) 2023-07-26 08:55:16 -07:00
maps [DOCS] Remove outdated Maps video (#161991) 2023-07-25 06:08:21 -04:00
migration [DOCS] Remove 8.0.0 coming tag (#125229) 2022-02-10 07:58:28 -05:00
observability Move observability content (#79978) 2020-10-13 16:08:48 +01:00
osquery [DOCS] Screenshot updated - Osquery (#160774) 2023-06-29 11:05:07 +01:00
settings [APM] Add missing settings to documentation (#161603) 2023-07-13 15:33:01 -07:00
setup [DOC+] License not available is KB-ES connection error (#161176) 2023-07-04 09:26:43 -05:00
siem [DOCS] Elastic Sec Overview (Fixing Image) (#104529) 2021-07-07 09:58:09 -04:00
spaces Removing docs about multi-tenancy (#143698) 2022-10-24 16:01:43 -04:00
user Change default session idle timeout to 3 days. (#162313) 2023-07-26 14:29:04 +02:00
accessibility.asciidoc
action-type-template.asciidoc [DOCS] Edit layout of connector pages (#151534) 2023-02-21 08:20:21 -08:00
apis.asciidoc [DOCS] Create open API specification for find rules (#147061) 2022-12-12 11:36:44 -08:00
CHANGELOG.asciidoc Change default session idle timeout to 3 days. (#162313) 2023-07-26 14:29:04 +02:00
gs-index.asciidoc [DOCS] Remove or move book-scoped attributes (#155210) 2023-04-20 09:12:09 -07:00
index.asciidoc [DOCS] Add TOC to landing page (#161411) 2023-07-07 12:03:32 -04:00
index.x.asciidoc
landing-page.asciidoc [DOCS] Add TOC to landing page (#161411) 2023-07-07 12:03:32 -04:00
limitations.asciidoc [DOCS] Reallocates limitations to point-of-use (#79582) 2020-11-19 10:49:27 -06:00
migration.asciidoc
redirects.asciidoc [ML] AIOps: Rename Explain Log Rate Spikes to Log Rate Analysis. (#161764) 2023-07-19 16:46:31 +02:00
rule-type-template.asciidoc [DOCS] Create and manage rule action frequencies (#150957) 2023-02-23 13:16:46 -08:00
template.asciidoc [DOCS] Remove snapshot and restore docs (#114836) 2021-11-16 16:59:24 -05:00