Skip to content
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

[OpenAPI][DOCS] Capitalize roles tag in serverless overlay #198883

Merged
merged 2 commits into from
Nov 7, 2024
Merged

[OpenAPI][DOCS] Capitalize roles tag in serverless overlay #198883

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cc841d3
[OpenAPI][DOCS] Add roles tag to serverless overlays
lcawl Nov 5, 2024
5c99d4a
Merge branch 'main' into serverless-roles-tag
lcawl Nov 7, 2024
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
16 changes: 12 additions & 4 deletions oas_docs/overlays/kibana.overlays.serverless.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ info:
title: Overlays for the Kibana API document
version: 0.0.1
actions:
# Clean up server definitions
# Clean up server definitions
- target: '$.servers.*'
description: Remove all servers so we can add our own.
remove: true
Expand All @@ -15,12 +15,12 @@ actions:
variables:
kibana_url:
default: localhost:5601
# Mark all operations as beta
# Mark all operations as beta
- target: "$.paths[*]['get','put','post','delete','options','head','patch','trace']"
description: Add x-beta
update:
x-beta: true
# Add some tag descriptions and displayNames
# Add some tag descriptions and displayNames
- target: '$.tags[?(@.name=="alerting")]'
description: Change tag description and displayName
update:
Expand Down Expand Up @@ -50,6 +50,14 @@ actions:
description: Change displayName
update:
x-displayName: "Machine learning"
- target: '$.tags[?(@.name=="roles")]'
description: Change displayName and description
update:
x-displayName: "Roles"
description: Manage the roles that grant Elasticsearch and Kibana privileges.
externalDocs:
description: Kibana role management
url: https://www.elastic.co/guide/en/kibana/master/kibana-role-management.html
- target: '$.tags[?(@.name=="slo")]'
description: Change displayName
update:
Expand All @@ -65,7 +73,7 @@ actions:
x-displayName: "System"
description: >
Get information about the system status, resource usage, and installed plugins.
# Remove extra tags from operations
# Remove extra tags from operations
- target: "$.paths[*][*].tags[1:]"
description: Remove all but first tag from operations
remove: true