Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lcawl merged 1 commit into from
Aug 23, 2024
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 3 additions & 0 deletions oas_docs/kibana.info.serverless.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
3 changes: 3 additions & 0 deletions oas_docs/kibana.info.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
73 changes: 42 additions & 31 deletions oas_docs/output/kibana.serverless.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -2190,6 +2189,7 @@ paths:
- maxExecutableActions
- maxAlerts
- maxQueuedActions
- ruleExecution
type: string
required:
- reason
Expand Down Expand Up @@ -2261,6 +2261,7 @@ paths:
- maxExecutableActions
- maxAlerts
- maxQueuedActions
- ruleExecution
nullable: true
type: string
required:
Expand Down Expand Up @@ -2367,6 +2368,7 @@ paths:
- maxExecutableActions
- maxAlerts
- maxQueuedActions
- ruleExecution
nullable: true
type: string
required:
Expand Down Expand Up @@ -3322,6 +3324,7 @@ paths:
- maxExecutableActions
- maxAlerts
- maxQueuedActions
- ruleExecution
type: string
required:
- reason
Expand Down Expand Up @@ -3393,6 +3396,7 @@ paths:
- maxExecutableActions
- maxAlerts
- maxQueuedActions
- ruleExecution
nullable: true
type: string
required:
Expand Down Expand Up @@ -3499,6 +3503,7 @@ paths:
- maxExecutableActions
- maxAlerts
- maxQueuedActions
- ruleExecution
nullable: true
type: string
required:
Expand Down Expand Up @@ -4425,6 +4430,7 @@ paths:
- maxExecutableActions
- maxAlerts
- maxQueuedActions
- ruleExecution
type: string
required:
- reason
Expand Down Expand Up @@ -4496,6 +4502,7 @@ paths:
- maxExecutableActions
- maxAlerts
- maxQueuedActions
- ruleExecution
nullable: true
type: string
required:
Expand Down Expand Up @@ -4602,6 +4609,7 @@ paths:
- maxExecutableActions
- maxAlerts
- maxQueuedActions
- ruleExecution
nullable: true
type: string
required:
Expand Down Expand Up @@ -5592,6 +5600,7 @@ paths:
- maxExecutableActions
- maxAlerts
- maxQueuedActions
- ruleExecution
type: string
required:
- reason
Expand Down Expand Up @@ -5663,6 +5672,7 @@ paths:
- maxExecutableActions
- maxAlerts
- maxQueuedActions
- ruleExecution
nullable: true
type: string
required:
Expand Down Expand Up @@ -5769,6 +5779,7 @@ paths:
- maxExecutableActions
- maxAlerts
- maxQueuedActions
- ruleExecution
nullable: true
type: string
required:
Expand Down
73 changes: 42 additions & 31 deletions oas_docs/output/kibana.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -2892,6 +2891,7 @@ paths:
- maxExecutableActions
- maxAlerts
- maxQueuedActions
- ruleExecution
type: string
required:
- reason
Expand Down Expand Up @@ -2963,6 +2963,7 @@ paths:
- maxExecutableActions
- maxAlerts
- maxQueuedActions
- ruleExecution
nullable: true
type: string
required:
Expand Down Expand Up @@ -3069,6 +3070,7 @@ paths:
- maxExecutableActions
- maxAlerts
- maxQueuedActions
- ruleExecution
nullable: true
type: string
required:
Expand Down Expand Up @@ -4024,6 +4026,7 @@ paths:
- maxExecutableActions
- maxAlerts
- maxQueuedActions
- ruleExecution
type: string
required:
- reason
Expand Down Expand Up @@ -4095,6 +4098,7 @@ paths:
- maxExecutableActions
- maxAlerts
- maxQueuedActions
- ruleExecution
nullable: true
type: string
required:
Expand Down Expand Up @@ -4201,6 +4205,7 @@ paths:
- maxExecutableActions
- maxAlerts
- maxQueuedActions
- ruleExecution
nullable: true
type: string
required:
Expand Down Expand Up @@ -5127,6 +5132,7 @@ paths:
- maxExecutableActions
- maxAlerts
- maxQueuedActions
- ruleExecution
type: string
required:
- reason
Expand Down Expand Up @@ -5198,6 +5204,7 @@ paths:
- maxExecutableActions
- maxAlerts
- maxQueuedActions
- ruleExecution
nullable: true
type: string
required:
Expand Down Expand Up @@ -5304,6 +5311,7 @@ paths:
- maxExecutableActions
- maxAlerts
- maxQueuedActions
- ruleExecution
nullable: true
type: string
required:
Expand Down Expand Up @@ -6294,6 +6302,7 @@ paths:
- maxExecutableActions
- maxAlerts
- maxQueuedActions
- ruleExecution
type: string
required:
- reason
Expand Down Expand Up @@ -6365,6 +6374,7 @@ paths:
- maxExecutableActions
- maxAlerts
- maxQueuedActions
- ruleExecution
nullable: true
type: string
required:
Expand Down Expand Up @@ -6471,6 +6481,7 @@ paths:
- maxExecutableActions
- maxAlerts
- maxQueuedActions
- ruleExecution
nullable: true
type: string
required:
Expand Down