kibana/oas_docs
Francesco Fagnani 2c9adae304
[8.19] [Synthetics] Edit private locations labels and tags in Synthetics (#221515) (#224639)
# Backport

This will backport the following commits from `main` to `8.19`:
- [[Synthetics] Edit private locations labels and tags in Synthetics
(#221515)](https://github.com/elastic/kibana/pull/221515)

<!--- Backport version: 10.0.1 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sorenlouv/backport)

<!--BACKPORT [{"author":{"name":"Francesco
Fagnani","email":"fagnani.francesco@gmail.com"},"sourceCommit":{"committedDate":"2025-06-20T07:57:13Z","message":"[Synthetics]
Edit private locations labels and tags in Synthetics (#221515)\n\nThis
PR closes
#221508.\n\n\n\nhttps://github.com/user-attachments/assets/0b57487a-7188-4722-99dc-5cb44c15f129\n\n-
Added a new API endpoint to edit the label of private locations.\n- When
a label is updated, all monitors deployed in that location
are\nautomatically updated to reflect the change.\n- The UI now allows
users to edit only the label of a private location.\n- Added
comprehensive API tests to cover the new
functionality.\n\n---------\n\nCo-authored-by: kibanamachine
<42973632+kibanamachine@users.noreply.github.com>","sha":"b1b8fb0a8851d3e64dd0c24c7c42ebd144de24b8","branchLabelMapping":{"^v9.1.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:feature","ci:project-deploy-observability","Team:obs-ux-management","backport:version","v9.1.0","v8.19.0","author:obs-ux-management"],"title":"[Synthetics]
Edit private locations labels and tags in
Synthetics","number":221515,"url":"https://github.com/elastic/kibana/pull/221515","mergeCommit":{"message":"[Synthetics]
Edit private locations labels and tags in Synthetics (#221515)\n\nThis
PR closes
#221508.\n\n\n\nhttps://github.com/user-attachments/assets/0b57487a-7188-4722-99dc-5cb44c15f129\n\n-
Added a new API endpoint to edit the label of private locations.\n- When
a label is updated, all monitors deployed in that location
are\nautomatically updated to reflect the change.\n- The UI now allows
users to edit only the label of a private location.\n- Added
comprehensive API tests to cover the new
functionality.\n\n---------\n\nCo-authored-by: kibanamachine
<42973632+kibanamachine@users.noreply.github.com>","sha":"b1b8fb0a8851d3e64dd0c24c7c42ebd144de24b8"}},"sourceBranch":"main","suggestedTargetBranches":["8.19"],"targetPullRequestStates":[{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/221515","number":221515,"mergeCommit":{"message":"[Synthetics]
Edit private locations labels and tags in Synthetics (#221515)\n\nThis
PR closes
#221508.\n\n\n\nhttps://github.com/user-attachments/assets/0b57487a-7188-4722-99dc-5cb44c15f129\n\n-
Added a new API endpoint to edit the label of private locations.\n- When
a label is updated, all monitors deployed in that location
are\nautomatically updated to reflect the change.\n- The UI now allows
users to edit only the label of a private location.\n- Added
comprehensive API tests to cover the new
functionality.\n\n---------\n\nCo-authored-by: kibanamachine
<42973632+kibanamachine@users.noreply.github.com>","sha":"b1b8fb0a8851d3e64dd0c24c7c42ebd144de24b8"}},{"branch":"8.19","label":"v8.19.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Shahzad <shahzad31comp@gmail.com>
2025-06-26 13:59:29 +02:00
..
examples [8.x] [DOCS] Remove inference connector docs (#198633) (#199846) 2024-11-12 13:56:59 -06:00
linters [8.x] [DOCS] Removes Serverless API x-beta overlay (#215587) (#215600) 2025-03-25 11:06:39 +01:00
output [8.19] [Synthetics] Edit private locations labels and tags in Synthetics (#221515) (#224639) 2025-06-26 13:59:29 +02:00
overlays [8.19] OpenAI (Other) Connector PKI implementation (#219984) (#225325) 2025-06-25 18:53:31 +01:00
scripts [8.x] [DOCS] Add minimal synthetic APIs (#214518) (#217901) 2025-04-11 10:53:09 -04:00
bundle.json [8.19] [Dashboards as Code] Change access to dashboard route endpoints to internal (#223262) (#224060) 2025-06-17 10:06:00 -04:00
bundle.serverless.json [8.19] [Dashboards as Code] Change access to dashboard route endpoints to internal (#223262) (#224060) 2025-06-17 10:06:00 -04:00
kibana.info.yaml [8.x] [OpenAPI] Fix Serverless API base URL (#202373) (#202583) 2024-12-04 14:15:28 -06:00
makefile [8.x] [DOCS] Removes Serverless API x-beta overlay (#215587) (#215600) 2025-03-25 11:06:39 +01:00
package-lock.json [8.x] Update dependency @redocly/cli to ^1.27.2 (main) (#207527) (#207948) 2025-01-23 00:19:21 +00:00
package.json [8.x] Update dependency @redocly/cli to ^1.27.2 (main) (#207527) (#207948) 2025-01-23 00:19:21 +00:00
README.md [8.x] SKA: Relocate "platform" packages that remain on /packages (#208704) (#212474) 2025-02-28 10:12:01 +00:00

Kibana API reference documentation

Documentation about our OpenAPI bundling workflow and configuration. See Kibana's hosted stateful and serverless docs.

Workflow

The final goal of this workflow is to produce an OpenAPI bundle containing all Kibana's public APIs.

Step 0

OAS from Kibana's APIs are continuously extracted and captured in bundle.json and bundle.serverless.json as fully formed OAS documentation. See node scripts/capture_oas_snapshot --help for more info.

These bundles form the basis of our OpenAPI bundles to which we append and layer extra information before publishing.

Step 1

Append pre-existing bundles not extracted from code using kbn-openapi-bundler to produce the final resulting bundles.

To add more files into the final bundle, edit the appropriate oas_docs/scripts/merge*.js files.

Step 2

Apply any final overalys to the document that might include examples or final tweaks (see the "Scripts" section for more details).

Scripts

The oas_docs/scripts folder contains scripts that point to the source domain-specific OpenAPI bundles and specify additional parameters for producing the final output bundle. Currently, there are the following scripts:

  • merge_ess_oas.js script produces production an output bundle for ESS

  • merge_serverless_oas.js script produces production an output bundle for Serverless

Output Kibana OpenAPI bundles

The oas_docs/output folder contains the final resulting Kibana OpenAPI bundles

  • kibana.yaml production ready ESS OpenAPI bundle
  • kibana.serverless.yaml production ready Serverless OpenAPI bundle

Bundling commands

Besides the scripts in the oas_docs/scripts folder, there is an oas_docs/makefile to simplify the workflow. Use make help to see available commands.