Skip to content

[DOCS] Add minimal synthetic APIs#214518

Merged
lcawl merged 22 commits intoelastic:mainfrom
lcawl:synthetic-api-docs
Apr 10, 2025
Merged

[DOCS] Add minimal synthetic APIs#214518
lcawl merged 22 commits intoelastic:mainfrom
lcawl:synthetic-api-docs

Conversation

@lcawl
Copy link
Copy Markdown
Contributor

@lcawl lcawl commented Mar 14, 2025 •
edited by kibanamachine
Loading

Summary

Relates to #206243

This PR includes the synthetic APIs in the OpenAPI document, since https://www.elastic.co/guide/en/kibana/current/synthetics-apis.html will not exist in the narrative V9 docs.

In the long run if this API persists, ideally this information would be generated from the code but this is a stop-gap.

NOTE: Some of the properties are commented out since they were missing information such as type in the original documentation.

Preview

image

Checklist

Check the PR satisfies following conditions.

Reviewers should verify this PR satisfies this list as well.

  • Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
  • Documentation was added for features that require explanation or tutorials
  • Unit or functional tests were updated or added to match the most common scenarios
  • If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the docker list
  • This was checked for breaking HTTP API changes, and any breaking changes have been approved by the breaking-change committee. The release_note:breaking label should be applied in these situations.
  • Flaky Test Runner was used on any tests changed
  • The PR description includes the appropriate Release Notes section, and the correct release_note:* label is applied per the guidelines

Identify risks

Does this PR introduce any risks? For example, consider risks like hard to test bugs, performance regression, potential of data loss.

Describe the risk, its severity, and mitigation for each identified risk. Invite stakeholders and evaluate how to proceed before merging.

@lcawl lcawl added release_note:skip Skip the PR/issue when compiling release notes docs backport:version Backport to applied version labels v9.1.0 v8.19.0 v8.18.1 v9.0.1 labels Mar 14, 2025
@lcawl lcawl mentioned this pull request Mar 14, 2025
Closed
9 tasks
@lcawl lcawl marked this pull request as ready for review March 14, 2025 09:20
@lcawl lcawl requested a review from a team as a code owner March 14, 2025 09:20
@lcawl lcawl requested a review from a team March 17, 2025 15:33
@botelastic botelastic bot added the Team:actionable-obs Formerly "obs-ux-management", responsible for SLO, o11y alerting, significant events, & synthetics. label Mar 17, 2025
@elasticmachine
Copy link
Copy Markdown
Contributor

elasticmachine commented Mar 17, 2025

Pinging @elastic/obs-ux-management-team (Team:obs-ux-management)

@bmorelli25
Copy link
Copy Markdown
Member

bmorelli25 commented Mar 28, 2025

@elasticmachine merge upstream

@elasticmachine
Copy link
Copy Markdown
Contributor

elasticmachine commented Mar 28, 2025

merge conflict between base and head

colleenmcginnis
colleenmcginnis reviewed Apr 2, 2025
View reviewed changes
@lcawl lcawl force-pushed the synthetic-api-docs branch from 640ae50 to 521827f Compare April 4, 2025 02:07
lcawl and others added 12 commits April 7, 2025 18:06
@lcawl
[DOCS] Add minimal synthetic APIs
96eb469
@lcawl
More edits
ec3abc5
@lcawl
Add more paths
ef7c1f2
@lcawl
Add more paths
5c38283
@lcawl
Fix array definitions
d7efb7b
@lcawl @colleenmcginnis
Update x-pack/solutions/observability/plugins/synthetics/docs/openapi…
7fa6468 
…/synthetic_apis.yaml

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>
@lcawl @colleenmcginnis
Update x-pack/solutions/observability/plugins/synthetics/docs/openapi…
4e64212 
…/synthetic_apis.yaml

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>
@lcawl @colleenmcginnis
Update x-pack/solutions/observability/plugins/synthetics/docs/openapi…
363d4ce 
…/synthetic_apis.yaml

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>
@lcawl @colleenmcginnis
Update x-pack/solutions/observability/plugins/synthetics/docs/openapi…
4978dd3 
…/synthetic_apis.yaml

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>
@lcawl @colleenmcginnis
Update x-pack/solutions/observability/plugins/synthetics/docs/openapi…
3a52893 
…/synthetic_apis.yaml

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>
@lcawl @colleenmcginnis
Update x-pack/solutions/observability/plugins/synthetics/docs/openapi…
a1da39b 
…/synthetic_apis.yaml

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>
@lcawl
Augment descriptions
f227ffb
@lcawl lcawl enabled auto-merge (squash) April 9, 2025 19:26
@lcawl lcawl merged commit e00f013 into elastic:main Apr 10, 2025
9 checks passed
@kibanamachine
Copy link
Copy Markdown
Contributor

kibanamachine commented Apr 10, 2025

Starting backport for target branches: 8.18, 8.x, 9.0

https://github.com/elastic/kibana/actions/runs/14386588657

@elasticmachine
Copy link
Copy Markdown
Contributor

elasticmachine commented Apr 10, 2025

💚 Build Succeeded

Metrics [docs]

✅ unchanged

History

@kibanamachine
Copy link
Copy Markdown
Contributor

kibanamachine commented Apr 10, 2025

💔 All backports failed

Status Branch Result
❌ 8.18 Backport failed because of merge conflicts

You might need to backport the following PRs to 8.18:
- [Security Solution] Improving documentations for bulk_actions (#216852)
- [Fleet] Fix fleet server policy creation with non es default output (#214590)
❌ 8.x Backport failed because of merge conflicts
❌ 9.0 Backport failed because of merge conflicts

You might need to backport the following PRs to 9.0:
- [Saved objects] Update import docs (#216658)

Manual backport

To create the backport manually run:

node scripts/backport --pr 214518

Questions ?

Please refer to the Backport tool documentation

@lcawl lcawl deleted the synthetic-api-docs branch April 10, 2025 17:54
@lcawl lcawl mentioned this pull request Apr 10, 2025
Merged
lcawl added a commit to lcawl/kibana that referenced this pull request Apr 10, 2025
@lcawl @colleenmcginnis
[DOCS] Add minimal synthetic APIs (elastic#214518)
c8f1833 
Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>
(cherry picked from commit e00f013)
@kibanamachine kibanamachine mentioned this pull request Apr 10, 2025
Merged
@lcawl lcawl mentioned this pull request Apr 10, 2025
Merged
lcawl added a commit to lcawl/kibana that referenced this pull request Apr 10, 2025
@lcawl @colleenmcginnis
[DOCS] Add minimal synthetic APIs (elastic#214518)
a7ceec0 
Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>
(cherry picked from commit e00f013)
lcawl added a commit to lcawl/kibana that referenced this pull request Apr 10, 2025
@lcawl @colleenmcginnis
[DOCS] Add minimal synthetic APIs (elastic#214518)
5423ee0 
Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>
(cherry picked from commit e00f013)
@lcawl lcawl mentioned this pull request Apr 10, 2025
Merged
@lcawl
Copy link
Copy Markdown
Contributor Author

lcawl commented Apr 10, 2025

💚 All backports created successfully

Status Branch Result
✅ 9.0
✅ 8.x
✅ 8.18

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

@kibanamachine kibanamachine mentioned this pull request Apr 11, 2025
Merged
9 tasks
lcawl added a commit that referenced this pull request Apr 11, 2025
@lcawl @kibanamachine
[8.x] [DOCS] Add minimal synthetic APIs (#214518) (#217901)
d882e4b 
# Backport

This will backport the following commits from `main` to `8.x`:
- [[DOCS] Add minimal synthetic APIs
(#214518)](#214518)

<!--- Backport version: 9.6.6 -->

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

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2025-04-10T17:26:49Z","message":"[DOCS]
Add minimal synthetic APIs (#214518)\n\nCo-authored-by: Colleen McGinnis
<colleen.j.mcginnis@gmail.com>","sha":"e00f013b62a42a2870be3b7a3e4cadab8ba191c4","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","docs","Team:obs-ux-management","backport:version","v9.1.0","v8.19.0","v8.18.1","v9.0.1"],"title":"[DOCS]
Add minimal synthetic
APIs","number":214518,"url":"https://github.com/elastic/kibana/pull/214518","mergeCommit":{"message":"[DOCS]
Add minimal synthetic APIs (#214518)\n\nCo-authored-by: Colleen McGinnis
<colleen.j.mcginnis@gmail.com>","sha":"e00f013b62a42a2870be3b7a3e4cadab8ba191c4"}},"sourceBranch":"main","suggestedTargetBranches":["8.x","8.18","9.0"],"targetPullRequestStates":[{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/214518","number":214518,"mergeCommit":{"message":"[DOCS]
Add minimal synthetic APIs (#214518)\n\nCo-authored-by: Colleen McGinnis
<colleen.j.mcginnis@gmail.com>","sha":"e00f013b62a42a2870be3b7a3e4cadab8ba191c4"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.18","label":"v8.18.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"9.0","label":"v9.0.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
lcawl added a commit that referenced this pull request Apr 11, 2025
@lcawl @kibanamachine
[8.18] [DOCS] Add minimal synthetic APIs (#214518) (#217902)
c3769d1 
# Backport

This will backport the following commits from `main` to `8.18`:
- [[DOCS] Add minimal synthetic APIs
(#214518)](#214518)

<!--- Backport version: 9.6.6 -->

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

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2025-04-10T17:26:49Z","message":"[DOCS]
Add minimal synthetic APIs (#214518)\n\nCo-authored-by: Colleen McGinnis
<colleen.j.mcginnis@gmail.com>","sha":"e00f013b62a42a2870be3b7a3e4cadab8ba191c4","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","docs","Team:obs-ux-management","backport:version","v9.1.0","v8.19.0","v8.18.1","v9.0.1"],"title":"[DOCS]
Add minimal synthetic
APIs","number":214518,"url":"https://github.com/elastic/kibana/pull/214518","mergeCommit":{"message":"[DOCS]
Add minimal synthetic APIs (#214518)\n\nCo-authored-by: Colleen McGinnis
<colleen.j.mcginnis@gmail.com>","sha":"e00f013b62a42a2870be3b7a3e4cadab8ba191c4"}},"sourceBranch":"main","suggestedTargetBranches":["8.x","8.18","9.0"],"targetPullRequestStates":[{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/214518","number":214518,"mergeCommit":{"message":"[DOCS]
Add minimal synthetic APIs (#214518)\n\nCo-authored-by: Colleen McGinnis
<colleen.j.mcginnis@gmail.com>","sha":"e00f013b62a42a2870be3b7a3e4cadab8ba191c4"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.18","label":"v8.18.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"9.0","label":"v9.0.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
@kibanamachine kibanamachine added v8.18.0 backport missing Added to PRs automatically when the are determined to be missing a backport. labels Apr 11, 2025
@kibanamachine
Copy link
Copy Markdown
Contributor

kibanamachine commented Apr 14, 2025

Looks like this PR has backport PRs but they still haven't been merged. Please merge them ASAP to keep the branches relatively in sync.

lcawl added a commit that referenced this pull request Apr 14, 2025
@lcawl @kibanamachine
[9.0] [DOCS] Add minimal synthetic APIs (#214518) (#217900)
85f32f9 
# Backport

This will backport the following commits from `main` to `9.0`:
- [[DOCS] Add minimal synthetic APIs
(#214518)](#214518)

<!--- Backport version: 9.6.6 -->

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

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2025-04-10T17:26:49Z","message":"[DOCS]
Add minimal synthetic APIs (#214518)\n\nCo-authored-by: Colleen McGinnis
<colleen.j.mcginnis@gmail.com>","sha":"e00f013b62a42a2870be3b7a3e4cadab8ba191c4","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","docs","Team:obs-ux-management","backport:version","v9.1.0","v8.19.0","v8.18.1","v9.0.1"],"title":"[DOCS]
Add minimal synthetic
APIs","number":214518,"url":"https://github.com/elastic/kibana/pull/214518","mergeCommit":{"message":"[DOCS]
Add minimal synthetic APIs (#214518)\n\nCo-authored-by: Colleen McGinnis
<colleen.j.mcginnis@gmail.com>","sha":"e00f013b62a42a2870be3b7a3e4cadab8ba191c4"}},"sourceBranch":"main","suggestedTargetBranches":["8.x","8.18","9.0"],"targetPullRequestStates":[{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/214518","number":214518,"mergeCommit":{"message":"[DOCS]
Add minimal synthetic APIs (#214518)\n\nCo-authored-by: Colleen McGinnis
<colleen.j.mcginnis@gmail.com>","sha":"e00f013b62a42a2870be3b7a3e4cadab8ba191c4"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.18","label":"v8.18.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"9.0","label":"v9.0.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
@kibanamachine kibanamachine added v9.0.0 and removed backport missing Added to PRs automatically when the are determined to be missing a backport. labels Apr 14, 2025
@mistic mistic removed the v9.0.0 label Apr 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@dominiqueclarke dominiqueclarke dominiqueclarke left review comments

@justinkambic justinkambic justinkambic approved these changes

+1 more reviewer

@colleenmcginnis colleenmcginnis colleenmcginnis approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

backport:version Backport to applied version labels docs release_note:skip Skip the PR/issue when compiling release notes Team:actionable-obs Formerly "obs-ux-management", responsible for SLO, o11y alerting, significant events, & synthetics. v8.18.0 v8.18.1 v8.19.0 v9.0.1 v9.1.0

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

8 participants

@lcawl @elasticmachine @bmorelli25 @kibanamachine @colleenmcginnis @dominiqueclarke @justinkambic @mistic