Skip to content

Commit 87d120a

Browse files
lcawlkibanamachine
andauthored
[9.2] [DOCS] Add synthetic API response descriptions (#240917) (#241202)
# Backport This will backport the following commits from `main` to `9.2`: - [[DOCS] Add synthetic API response descriptions (#240917)](#240917) <!--- Backport version: 10.1.0 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) <!--BACKPORT [{"author":{"name":"Lisa Cawley","email":"[email protected]"},"sourceCommit":{"committedDate":"2025-10-28T20:32:05Z","message":"[DOCS] Add synthetic API response descriptions (#240917)","sha":"38ada44bb2dddca770b89a7bb726b1696803154a","branchLabelMapping":{"^v9.3.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","Team:Fleet","docs","Team:obs-ux-management","backport:version","v9.3.0","v9.2.1"],"title":"[DOCS] Add synthetic API response descriptions","number":240917,"url":"https://github.com/elastic/kibana/pull/240917","mergeCommit":{"message":"[DOCS] Add synthetic API response descriptions (#240917)","sha":"38ada44bb2dddca770b89a7bb726b1696803154a"}},"sourceBranch":"main","suggestedTargetBranches":["9.2"],"targetPullRequestStates":[{"branch":"main","label":"v9.3.0","branchLabelMappingKey":"^v9.3.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/240917","number":240917,"mergeCommit":{"message":"[DOCS] Add synthetic API response descriptions (#240917)","sha":"38ada44bb2dddca770b89a7bb726b1696803154a"}},{"branch":"9.2","label":"v9.2.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> --------- Co-authored-by: kibanamachine <[email protected]>
1 parent 5cae8bf commit 87d120a

File tree

3 files changed

+5
-1
lines changed

3 files changed

+5
-1
lines changed

oas_docs/output/kibana.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70453,6 +70453,7 @@ paths:
7045370453
description: The unique identifier of the deleted monitor.
7045470454
type: string
7045570455
type: array
70456+
description: A successful response.
7045670457
summary: Delete monitors
7045770458
tags:
7045870459
- synthetics
@@ -70558,6 +70559,7 @@ paths:
7055870559
}
7055970560
schema:
7056070561
type: object
70562+
description: A successful response.
7056170563
'404':
7056270564
description: If the monitor is not found, the API returns a 404 error.
7056370565
summary: Get a monitor
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
2-
"./oas_docs/output/kibana.yaml": 75,
2+
"./oas_docs/output/kibana.yaml": 73,
33
"./oas_docs/output/kibana.serverless.yaml": 276
44
}

x-pack/solutions/observability/plugins/synthetics/docs/openapi/synthetic_apis.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -295,6 +295,7 @@ paths:
295295
type: string
296296
responses:
297297
'200':
298+
description: A successful response.
298299
content:
299300
application/json:
300301
schema:
@@ -475,6 +476,7 @@ paths:
475476
}
476477
responses:
477478
'200':
479+
description: A successful response.
478480
content:
479481
application/json:
480482
schema:

0 commit comments

Comments
 (0)