github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 01:38:56 -04:00
Code Issues Projects Releases Packages Wiki Activity

[OAS][DOCS] Add feedback links for Kibana APIs (#191145)

Browse source
This commit is contained in:
Lisa Cawley 2024-08-23 13:46:12 -07:00 • committed by GitHub
parent 5ff457ca94
commit 0770e947e2
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 98 additions and 62 deletions
Download patch file Download diff file Expand all files Collapse all files

8
.gitignore vendored
View file

@ -141,3 +141,11 @@ x-pack/test/security_api_integration/plugins/audit_log/audit.log
# ignore FTR temp directory
.ftr
role_users.json
# Ignore temporary files in oas_docs
output/kibana.serverless.tmp1.yaml
output/kibana.serverless.tmp2.yaml
output/kibana.tmp1.yaml
output/kibana.tmp2.yaml
output/kibana.new.yaml
output/kibana.serverless.new.yaml

3
oas_docs/kibana.info.serverless.yaml
View file

@ -32,6 +32,9 @@ info:
url: https://www.elastic.co/licensing/elastic-license
contact:
name: Kibana Team
x-feedbackLink:
label: Feedback
url: https://github.com/elastic/docs-content/issues/new?assignees=&labels=feedback%2Ccommunity&projects=&template=api-feedback.yaml&title=%5BFeedback%5D%3A+
security:
- apiKeyAuth: []
components:

3
oas_docs/kibana.info.yaml
View file

@ -30,6 +30,9 @@ info:
url: https://www.elastic.co/licensing/elastic-license
contact:
name: Kibana Team
x-feedbackLink:
label: Feedback
url: https://github.com/elastic/docs-content/issues/new?assignees=&labels=feedback%2Ccommunity&projects=&template=api-feedback.yaml&title=%5BFeedback%5D%3A+
servers:
- url: https://{kibana_url}
variables:

73
oas_docs/output/kibana.serverless.yaml
View file

@ -52,6 +52,10 @@ info:
url: 'https://www.elastic.co/licensing/elastic-license'
title: Kibana Serverless APIs
version: 1.0.2
x-feedbackLink:
label: Feedback
url: >-
https://github.com/elastic/docs-content/issues/new?assignees=&labels=feedback%2Ccommunity&projects=&template=api-feedback.yaml&title=%5BFeedback%5D%3A+
servers:
- url: 'http://{kibana_host}:{port}'
variables:
@ -879,37 +883,6 @@ paths:
summary: Create agent action
tags:
- Elastic Agent actions
'/agents/{agentId}/actions/{actionId}/cancel':
parameters:
- in: path
name: agentId
required: true
schema:
type: string
- in: path
name: actionId
required: true
schema:
type: string
post:
operationId: agent-action-cancel
parameters:
- $ref: '#/components/parameters/Fleet_kbn_xsrf'
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
type: object
properties:
item:
$ref: '#/components/schemas/Fleet_agent_action'
description: OK
'400':
$ref: '#/components/responses/Fleet_error'
summary: Cancel agent action
tags:
- Elastic Agent actions
'/agents/{agentId}/reassign':
parameters:
- in: path
@ -1230,6 +1203,32 @@ paths:
summary: Get agent action status
tags:
- Elastic Agent actions
'/agents/actions/{actionId}/cancel':
parameters:
- in: path
name: actionId
required: true
schema:
type: string
post:
operationId: agent-action-cancel
parameters:
- $ref: '#/components/parameters/Fleet_kbn_xsrf'
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
type: object
properties:
item:
$ref: '#/components/schemas/Fleet_agent_action'
description: OK
'400':
$ref: '#/components/responses/Fleet_error'
summary: Cancel agent action
tags:
- Elastic Agent actions
/agents/bulk_reassign:
post:
operationId: bulk-reassign-agents
@ -2190,6 +2189,7 @@ paths:
- maxExecutableActions
- maxAlerts
- maxQueuedActions
- ruleExecution
type: string
required:
- reason
@ -2261,6 +2261,7 @@ paths:
- maxExecutableActions
- maxAlerts
- maxQueuedActions
- ruleExecution
nullable: true
type: string
required:
@ -2367,6 +2368,7 @@ paths:
- maxExecutableActions
- maxAlerts
- maxQueuedActions
- ruleExecution
nullable: true
type: string
required:
@ -3322,6 +3324,7 @@ paths:
- maxExecutableActions
- maxAlerts
- maxQueuedActions
- ruleExecution
type: string
required:
- reason
@ -3393,6 +3396,7 @@ paths:
- maxExecutableActions
- maxAlerts
- maxQueuedActions
- ruleExecution
nullable: true
type: string
required:
@ -3499,6 +3503,7 @@ paths:
- maxExecutableActions
- maxAlerts
- maxQueuedActions
- ruleExecution
nullable: true
type: string
required:
@ -4425,6 +4430,7 @@ paths:
- maxExecutableActions
- maxAlerts
- maxQueuedActions
- ruleExecution
type: string
required:
- reason
@ -4496,6 +4502,7 @@ paths:
- maxExecutableActions
- maxAlerts
- maxQueuedActions
- ruleExecution
nullable: true
type: string
required:
@ -4602,6 +4609,7 @@ paths:
- maxExecutableActions
- maxAlerts
- maxQueuedActions
- ruleExecution
nullable: true
type: string
required:
@ -5592,6 +5600,7 @@ paths:
- maxExecutableActions
- maxAlerts
- maxQueuedActions
- ruleExecution
type: string
required:
- reason
@ -5663,6 +5672,7 @@ paths:
- maxExecutableActions
- maxAlerts
- maxQueuedActions
- ruleExecution
nullable: true
type: string
required:
@ -5769,6 +5779,7 @@ paths:
- maxExecutableActions
- maxAlerts
- maxQueuedActions
- ruleExecution
nullable: true
type: string
required:

73
oas_docs/output/kibana.yaml
View file

@ -51,6 +51,10 @@ info:
url: 'https://www.elastic.co/licensing/elastic-license'
title: Kibana APIs
version: 1.0.2
x-feedbackLink:
label: Feedback
url: >-
https://github.com/elastic/docs-content/issues/new?assignees=&labels=feedback%2Ccommunity&projects=&template=api-feedback.yaml&title=%5BFeedback%5D%3A+
servers:
- url: 'https://{kibana_url}'
variables:
@ -862,37 +866,6 @@ paths:
summary: Create agent action
tags:
- Elastic Agent actions
'/agents/{agentId}/actions/{actionId}/cancel':
parameters:
- in: path
name: agentId
required: true
schema:
type: string
- in: path
name: actionId
required: true
schema:
type: string
post:
operationId: agent-action-cancel
parameters:
- $ref: '#/components/parameters/Fleet_kbn_xsrf'
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
type: object
properties:
item:
$ref: '#/components/schemas/Fleet_agent_action'
description: OK
'400':
$ref: '#/components/responses/Fleet_error'
summary: Cancel agent action
tags:
- Elastic Agent actions
'/agents/{agentId}/reassign':
parameters:
- in: path
@ -1213,6 +1186,32 @@ paths:
summary: Get agent action status
tags:
- Elastic Agent actions
'/agents/actions/{actionId}/cancel':
parameters:
- in: path
name: actionId
required: true
schema:
type: string
post:
operationId: agent-action-cancel
parameters:
- $ref: '#/components/parameters/Fleet_kbn_xsrf'
responses:
'200':
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
type: object
properties:
item:
$ref: '#/components/schemas/Fleet_agent_action'
description: OK
'400':
$ref: '#/components/responses/Fleet_error'
summary: Cancel agent action
tags:
- Elastic Agent actions
/agents/bulk_reassign:
post:
operationId: bulk-reassign-agents
@ -2892,6 +2891,7 @@ paths:
- maxExecutableActions
- maxAlerts
- maxQueuedActions
- ruleExecution
type: string
required:
- reason
@ -2963,6 +2963,7 @@ paths:
- maxExecutableActions
- maxAlerts
- maxQueuedActions
- ruleExecution
nullable: true
type: string
required:
@ -3069,6 +3070,7 @@ paths:
- maxExecutableActions
- maxAlerts
- maxQueuedActions
- ruleExecution
nullable: true
type: string
required:
@ -4024,6 +4026,7 @@ paths:
- maxExecutableActions
- maxAlerts
- maxQueuedActions
- ruleExecution
type: string
required:
- reason
@ -4095,6 +4098,7 @@ paths:
- maxExecutableActions
- maxAlerts
- maxQueuedActions
- ruleExecution
nullable: true
type: string
required:
@ -4201,6 +4205,7 @@ paths:
- maxExecutableActions
- maxAlerts
- maxQueuedActions
- ruleExecution
nullable: true
type: string
required:
@ -5127,6 +5132,7 @@ paths:
- maxExecutableActions
- maxAlerts
- maxQueuedActions
- ruleExecution
type: string
required:
- reason
@ -5198,6 +5204,7 @@ paths:
- maxExecutableActions
- maxAlerts
- maxQueuedActions
- ruleExecution
nullable: true
type: string
required:
@ -5304,6 +5311,7 @@ paths:
- maxExecutableActions
- maxAlerts
- maxQueuedActions
- ruleExecution
nullable: true
type: string
required:
@ -6294,6 +6302,7 @@ paths:
- maxExecutableActions
- maxAlerts
- maxQueuedActions
- ruleExecution
type: string
required:
- reason
@ -6365,6 +6374,7 @@ paths:
- maxExecutableActions
- maxAlerts
- maxQueuedActions
- ruleExecution
nullable: true
type: string
required:
@ -6471,6 +6481,7 @@ paths:
- maxExecutableActions
- maxAlerts
- maxQueuedActions
- ruleExecution
nullable: true
type: string
required: