[OAS] Remove redundant servers from alerting APIs (#169890)

This commit is contained in:
Lisa Cawley 2023-11-02 08:39:22 -07:00 committed by GitHub
parent d8b54cd729
commit 527c2f8b82
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
25 changed files with 52 additions and 470 deletions

View file

@ -14,8 +14,7 @@
},
"servers": [
{
"url": "http://localhost:5601",
"description": "local"
"url": "/"
}
],
"security": [
@ -112,18 +111,8 @@
}
}
}
},
"servers": [
{
"url": "https://localhost:5601"
}
]
},
"servers": [
{
"url": "https://localhost:5601"
}
]
}
},
"/s/{spaceId}/api/alerting/rule/{ruleId}": {
"get": {
@ -177,12 +166,7 @@
}
}
}
},
"servers": [
{
"url": "https://localhost:5601"
}
]
}
},
"delete": {
"summary": "Deletes a rule.",
@ -226,12 +210,7 @@
}
}
}
},
"servers": [
{
"url": "https://localhost:5601"
}
]
}
},
"post": {
"summary": "Creates a rule with a specific rule identifier.",
@ -321,12 +300,7 @@
}
}
}
},
"servers": [
{
"url": "https://localhost:5601"
}
]
}
},
"put": {
"summary": "Updates the attributes for a rule.",
@ -397,18 +371,8 @@
}
}
}
},
"servers": [
{
"url": "https://localhost:5601"
}
]
},
"servers": [
{
"url": "https://localhost:5601"
}
]
}
},
"/s/{spaceId}/api/alerting/rule/{ruleId}/_disable": {
"post": {
@ -453,18 +417,8 @@
}
}
}
},
"servers": [
{
"url": "https://localhost:5601"
}
]
},
"servers": [
{
"url": "https://localhost:5601"
}
]
}
},
"/s/{spaceId}/api/alerting/rule/{ruleId}/_enable": {
"post": {
@ -509,18 +463,8 @@
}
}
}
},
"servers": [
{
"url": "https://localhost:5601"
}
]
},
"servers": [
{
"url": "https://localhost:5601"
}
]
}
},
"/s/{spaceId}/api/alerting/rules/_find": {
"get": {
@ -694,18 +638,8 @@
}
}
}
},
"servers": [
{
"url": "https://localhost:5601"
}
]
},
"servers": [
{
"url": "https://localhost:5601"
}
]
}
},
"/s/{spaceId}/api/alerting/_health": {
"get": {
@ -825,12 +759,7 @@
}
}
}
},
"servers": [
{
"url": "https://localhost:5601"
}
]
}
},
"/s/{spaceId}/api/alerting/rule_types": {
"get": {
@ -1109,12 +1038,7 @@
}
}
}
},
"servers": [
{
"url": "https://localhost:5601"
}
]
}
},
"/s/{spaceId}/api/alerting/rule/{ruleId}/_mute_all": {
"post": {
@ -1149,18 +1073,8 @@
}
}
}
},
"servers": [
{
"url": "https://localhost:5601"
}
]
},
"servers": [
{
"url": "https://localhost:5601"
}
]
}
},
"/s/{spaceId}/api/alerting/rule/{ruleId}/_unmute_all": {
"post": {
@ -1195,18 +1109,8 @@
}
}
}
},
"servers": [
{
"url": "https://localhost:5601"
}
]
},
"servers": [
{
"url": "https://localhost:5601"
}
]
}
},
"/s/{spaceId}/api/alerting/rule/{ruleId}/_update_api_key": {
"post": {
@ -1241,18 +1145,8 @@
}
}
}
},
"servers": [
{
"url": "https://localhost:5601"
}
]
},
"servers": [
{
"url": "https://localhost:5601"
}
]
}
},
"/s/{spaceId}/api/alerting/rule/{ruleId}/alert/{alertId}/_mute": {
"post": {
@ -1290,18 +1184,8 @@
}
}
}
},
"servers": [
{
"url": "https://localhost:5601"
}
]
},
"servers": [
{
"url": "https://localhost:5601"
}
]
}
},
"/s/{spaceId}/api/alerting/rule/{ruleId}/alert/{alertId}/_unmute": {
"post": {
@ -1339,18 +1223,8 @@
}
}
}
},
"servers": [
{
"url": "https://localhost:5601"
}
]
},
"servers": [
{
"url": "https://localhost:5601"
}
]
}
},
"/s/{spaceId}/api/alerts/alert/{alertId}": {
"delete": {
@ -1393,12 +1267,7 @@
}
}
}
},
"servers": [
{
"url": "https://localhost:5601"
}
]
}
},
"get": {
"summary": "Retrieves an alert by its identifier.",
@ -1444,12 +1313,7 @@
}
}
}
},
"servers": [
{
"url": "https://localhost:5601"
}
]
}
},
"post": {
"summary": "Create an alert.",
@ -1600,12 +1464,7 @@
}
}
}
},
"servers": [
{
"url": "https://localhost:5601"
}
]
}
},
"put": {
"summary": "Updates the attributes for an alert.",
@ -1742,18 +1601,8 @@
}
}
}
},
"servers": [
{
"url": "https://localhost:5601"
}
]
},
"servers": [
{
"url": "https://localhost:5601"
}
]
}
},
"/s/{spaceId}/api/alerts/alert/{alertId}/_disable": {
"post": {
@ -1796,18 +1645,8 @@
}
}
}
},
"servers": [
{
"url": "https://localhost:5601"
}
]
},
"servers": [
{
"url": "https://localhost:5601"
}
]
}
},
"/s/{spaceId}/api/alerts/alert/{alertId}/_enable": {
"post": {
@ -1850,18 +1689,8 @@
}
}
}
},
"servers": [
{
"url": "https://localhost:5601"
}
]
},
"servers": [
{
"url": "https://localhost:5601"
}
]
}
},
"/s/{spaceId}/api/alerts/alert/{alertId}/_mute_all": {
"post": {
@ -1904,18 +1733,8 @@
}
}
}
},
"servers": [
{
"url": "https://localhost:5601"
}
]
},
"servers": [
{
"url": "https://localhost:5601"
}
]
}
},
"/s/{spaceId}/api/alerts/alert/{alertId}/_unmute_all": {
"post": {
@ -1958,18 +1777,8 @@
}
}
}
},
"servers": [
{
"url": "https://localhost:5601"
}
]
},
"servers": [
{
"url": "https://localhost:5601"
}
]
}
},
"/s/{spaceId}/api/alerts/alerts/_find": {
"get": {
@ -2136,18 +1945,8 @@
}
}
}
},
"servers": [
{
"url": "https://localhost:5601"
}
]
},
"servers": [
{
"url": "https://localhost:5601"
}
]
}
},
"/s/{spaceId}/api/alerts/alerts/_health": {
"get": {
@ -2263,12 +2062,7 @@
}
}
}
},
"servers": [
{
"url": "https://localhost:5601"
}
]
}
},
"/s/{spaceId}/api/alerts/alerts/list_alert_types": {
"get": {
@ -2418,12 +2212,7 @@
}
}
}
},
"servers": [
{
"url": "https://localhost:5601"
}
]
}
},
"/s/{spaceId}/api/alerts/alert/{alertId}/alert_instance/{alertInstanceId}/_mute": {
"post": {
@ -2476,18 +2265,8 @@
}
}
}
},
"servers": [
{
"url": "https://localhost:5601"
}
]
},
"servers": [
{
"url": "https://localhost:5601"
}
]
}
},
"/s/{spaceId}/api/alerts/alert/{alertId}/alert_instance/{alertInstanceId}/_unmute": {
"post": {
@ -2540,18 +2319,8 @@
}
}
}
},
"servers": [
{
"url": "https://localhost:5601"
}
]
},
"servers": [
{
"url": "https://localhost:5601"
}
]
}
}
},
"components": {

View file

@ -9,8 +9,7 @@ info:
name: Elastic License 2.0
url: https://www.elastic.co/licensing/elastic-license
servers:
- url: http://localhost:5601
description: local
- url: /
security:
- basicAuth: []
- apiKeyAuth: []
@ -68,10 +67,6 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/404_response'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601
/s/{spaceId}/api/alerting/rule/{ruleId}:
get:
summary: Retrieves a rule by its identifier.
@ -105,8 +100,6 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/404_response'
servers:
- url: https://localhost:5601
delete:
summary: Deletes a rule.
operationId: deleteRule
@ -133,8 +126,6 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/404_response'
servers:
- url: https://localhost:5601
post:
summary: Creates a rule with a specific rule identifier.
operationId: createRuleId
@ -192,8 +183,6 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/404_response'
servers:
- url: https://localhost:5601
put:
summary: Updates the attributes for a rule.
operationId: updateRule
@ -236,10 +225,6 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/404_response'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601
/s/{spaceId}/api/alerting/rule/{ruleId}/_disable:
post:
summary: Disables a rule.
@ -267,10 +252,6 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/404_response'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601
/s/{spaceId}/api/alerting/rule/{ruleId}/_enable:
post:
summary: Enables a rule.
@ -298,10 +279,6 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/401_response'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601
/s/{spaceId}/api/alerting/rules/_find:
get:
summary: Retrieves information about rules.
@ -415,10 +392,6 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/401_response'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601
/s/{spaceId}/api/alerting/_health:
get:
summary: Retrieves the health status of the alerting framework.
@ -504,8 +477,6 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/401_response'
servers:
- url: https://localhost:5601
/s/{spaceId}/api/alerting/rule_types:
get:
summary: Retrieves a list of rule types.
@ -691,8 +662,6 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/401_response'
servers:
- url: https://localhost:5601
/s/{spaceId}/api/alerting/rule/{ruleId}/_mute_all:
post:
summary: Mutes all alerts.
@ -714,10 +683,6 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/401_response'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601
/s/{spaceId}/api/alerting/rule/{ruleId}/_unmute_all:
post:
summary: Unmutes all alerts.
@ -739,10 +704,6 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/401_response'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601
/s/{spaceId}/api/alerting/rule/{ruleId}/_update_api_key:
post:
summary: Updates the API key for a rule.
@ -763,10 +724,6 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/400_response'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601
/s/{spaceId}/api/alerting/rule/{ruleId}/alert/{alertId}/_mute:
post:
summary: Mutes an alert.
@ -789,10 +746,6 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/401_response'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601
/s/{spaceId}/api/alerting/rule/{ruleId}/alert/{alertId}/_unmute:
post:
summary: Unmutes an alert.
@ -815,10 +768,6 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/401_response'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601
/s/{spaceId}/api/alerts/alert/{alertId}:
delete:
summary: Permanently removes an alert.
@ -847,8 +796,6 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/401_response'
servers:
- url: https://localhost:5601
get:
summary: Retrieves an alert by its identifier.
operationId: legacyGetAlert
@ -878,8 +825,6 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/401_response'
servers:
- url: https://localhost:5601
post:
summary: Create an alert.
operationId: legacyCreateAlert
@ -989,8 +934,6 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/401_response'
servers:
- url: https://localhost:5601
put:
summary: Updates the attributes for an alert.
operationId: legacyUpdateAlert
@ -1089,10 +1032,6 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/401_response'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601
/s/{spaceId}/api/alerts/alert/{alertId}/_disable:
post:
summary: Disables an alert.
@ -1120,10 +1059,6 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/401_response'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601
/s/{spaceId}/api/alerts/alert/{alertId}/_enable:
post:
summary: Enables an alert.
@ -1151,10 +1086,6 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/401_response'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601
/s/{spaceId}/api/alerts/alert/{alertId}/_mute_all:
post:
summary: Mutes all alert instances.
@ -1182,10 +1113,6 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/401_response'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601
/s/{spaceId}/api/alerts/alert/{alertId}/_unmute_all:
post:
summary: Unmutes all alert instances.
@ -1213,10 +1140,6 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/401_response'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601
/s/{spaceId}/api/alerts/alerts/_find:
get:
summary: Retrieves a paginated set of alerts.
@ -1326,10 +1249,6 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/401_response'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601
/s/{spaceId}/api/alerts/alerts/_health:
get:
summary: Retrieves the health status of the alerting framework.
@ -1412,8 +1331,6 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/401_response'
servers:
- url: https://localhost:5601
/s/{spaceId}/api/alerts/alerts/list_alert_types:
get:
summary: Retrieves a list of alert types.
@ -1516,8 +1433,6 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/401_response'
servers:
- url: https://localhost:5601
/s/{spaceId}/api/alerts/alert/{alertId}/alert_instance/{alertInstanceId}/_mute:
post:
summary: Mutes an alert instance.
@ -1552,10 +1467,6 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/401_response'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601
/s/{spaceId}/api/alerts/alert/{alertId}/alert_instance/{alertInstanceId}/_unmute:
post:
summary: Unmutes an alert instance.
@ -1590,10 +1501,6 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/401_response'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601
components:
securitySchemes:
basicAuth:

View file

@ -12,8 +12,7 @@ tags:
- name: alerting
description: Alerting APIs enable you to create and manage rules and alerts.
servers:
- url: 'http://localhost:5601'
description: local
- url: /
paths:
'/s/{spaceId}/api/alerting/rule':
$ref: 'paths/s@{spaceid}@api@alerting@rule.yaml'

View file

@ -84,5 +84,3 @@ get:
application/json:
schema:
$ref: '../components/schemas/401_response.yaml'
servers:
- url: https://localhost:5601

View file

@ -52,8 +52,4 @@ post:
content:
application/json:
schema:
$ref: '../components/schemas/404_response.yaml'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601
$ref: '../components/schemas/404_response.yaml'

View file

@ -35,8 +35,6 @@ get:
application/json:
schema:
$ref: '../components/schemas/404_response.yaml'
servers:
- url: https://localhost:5601
delete:
summary: Deletes a rule.
@ -67,8 +65,6 @@ delete:
application/json:
schema:
$ref: '../components/schemas/404_response.yaml'
servers:
- url: https://localhost:5601
post:
summary: Creates a rule with a specific rule identifier.
@ -134,8 +130,6 @@ post:
application/json:
schema:
$ref: '../components/schemas/404_response.yaml'
servers:
- url: https://localhost:5601
put:
summary: Updates the attributes for a rule.
@ -187,8 +181,4 @@ put:
content:
application/json:
schema:
$ref: '../components/schemas/404_response.yaml'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601
$ref: '../components/schemas/404_response.yaml'

View file

@ -26,8 +26,4 @@ post:
content:
application/json:
schema:
$ref: '../components/schemas/404_response.yaml'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601
$ref: '../components/schemas/404_response.yaml'

View file

@ -28,8 +28,4 @@ post:
content:
application/json:
schema:
$ref: '../components/schemas/401_response.yaml'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601
$ref: '../components/schemas/401_response.yaml'

View file

@ -24,8 +24,4 @@ post:
content:
application/json:
schema:
$ref: '../components/schemas/401_response.yaml'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601
$ref: '../components/schemas/401_response.yaml'

View file

@ -23,8 +23,4 @@ post:
content:
application/json:
schema:
$ref: '../components/schemas/401_response.yaml'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601
$ref: '../components/schemas/401_response.yaml'

View file

@ -16,8 +16,4 @@ post:
content:
application/json:
schema:
$ref: '../components/schemas/400_response.yaml'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601
$ref: '../components/schemas/400_response.yaml'

View file

@ -23,8 +23,4 @@ post:
content:
application/json:
schema:
$ref: '../components/schemas/401_response.yaml'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601
$ref: '../components/schemas/401_response.yaml'

View file

@ -23,8 +23,4 @@ post:
content:
application/json:
schema:
$ref: '../components/schemas/401_response.yaml'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601
$ref: '../components/schemas/401_response.yaml'

View file

@ -193,6 +193,4 @@ get:
content:
application/json:
schema:
$ref: '../components/schemas/401_response.yaml'
servers:
- url: https://localhost:5601
$ref: '../components/schemas/401_response.yaml'

View file

@ -120,8 +120,4 @@ get:
content:
application/json:
schema:
$ref: '../components/schemas/401_response.yaml'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601
$ref: '../components/schemas/401_response.yaml'

View file

@ -113,8 +113,4 @@ get:
content:
application/json:
schema:
$ref: '../components/schemas/401_response.yaml'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601
$ref: '../components/schemas/401_response.yaml'

View file

@ -78,6 +78,4 @@ get:
content:
application/json:
schema:
$ref: '../components/schemas/401_response.yaml'
servers:
- url: https://localhost:5601
$ref: '../components/schemas/401_response.yaml'

View file

@ -26,8 +26,6 @@ delete:
application/json:
schema:
$ref: '../components/schemas/401_response.yaml'
servers:
- url: https://localhost:5601
get:
summary: Retrieves an alert by its identifier.
@ -58,8 +56,6 @@ get:
application/json:
schema:
$ref: '../components/schemas/401_response.yaml'
servers:
- url: https://localhost:5601
post:
summary: Create an alert.
@ -176,8 +172,6 @@ post:
application/json:
schema:
$ref: '../components/schemas/401_response.yaml'
servers:
- url: https://localhost:5601
put:
summary: Updates the attributes for an alert.
@ -282,9 +276,4 @@ put:
content:
application/json:
schema:
$ref: '../components/schemas/401_response.yaml'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601
$ref: '../components/schemas/401_response.yaml'

View file

@ -23,8 +23,4 @@ post:
content:
application/json:
schema:
$ref: '../components/schemas/401_response.yaml'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601
$ref: '../components/schemas/401_response.yaml'

View file

@ -23,8 +23,4 @@ post:
content:
application/json:
schema:
$ref: '../components/schemas/401_response.yaml'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601
$ref: '../components/schemas/401_response.yaml'

View file

@ -23,8 +23,4 @@ post:
content:
application/json:
schema:
$ref: '../components/schemas/401_response.yaml'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601
$ref: '../components/schemas/401_response.yaml'

View file

@ -23,8 +23,4 @@ post:
content:
application/json:
schema:
$ref: '../components/schemas/401_response.yaml'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601
$ref: '../components/schemas/401_response.yaml'

View file

@ -30,8 +30,4 @@ post:
content:
application/json:
schema:
$ref: '../components/schemas/401_response.yaml'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601
$ref: '../components/schemas/401_response.yaml'

View file

@ -30,8 +30,4 @@ post:
content:
application/json:
schema:
$ref: '../components/schemas/401_response.yaml'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601
$ref: '../components/schemas/401_response.yaml'

View file

@ -106,6 +106,4 @@ get:
content:
application/json:
schema:
$ref: '../components/schemas/401_response.yaml'
servers:
- url: https://localhost:5601
$ref: '../components/schemas/401_response.yaml'