Skip to content

Commit 556baac

Browse files
jloleysenskibanamachinelcawl
authored
[8.16] [OAS] Beautify generated operation ids (#198132) (#198556)
# Backport This will backport the following commits from `main` to `8.16`: - [OAS] Beautify generated operation ids (#198132) (e53d68c) <!--- Backport version: 8.9.8 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Jean-Louis Leysens","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-10-30T19:11:24Z","message":"[OAS] Beautify generated operation ids (#198132)","sha":"e53d68c26d6c1f5330ee196938c650a786919a70"},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[]}] BACKPORT--> --------- Co-authored-by: kibanamachine <[email protected]> Co-authored-by: lcawl <[email protected]>
1 parent 16eedd2 commit 556baac

14 files changed

+286
-223
lines changed

‎oas_docs/bundle.json‎

Lines changed: 42 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -347,7 +347,7 @@
347347
"/api/actions": {
348348
"get": {
349349
"deprecated": true,
350-
"operationId": "%2Fapi%2Factions#0",
350+
"operationId": "get-actions",
351351
"parameters": [
352352
{
353353
"description": "The version of the API to use",
@@ -372,7 +372,7 @@
372372
"/api/actions/action": {
373373
"post": {
374374
"deprecated": true,
375-
"operationId": "%2Fapi%2Factions%2Faction#0",
375+
"operationId": "post-actions-action",
376376
"parameters": [
377377
{
378378
"description": "The version of the API to use",
@@ -496,7 +496,7 @@
496496
"delete": {
497497
"deprecated": true,
498498
"description": "WARNING: When you delete a connector, it cannot be recovered.",
499-
"operationId": "%2Fapi%2Factions%2Faction%2F%7Bid%7D#0",
499+
"operationId": "delete-actions-action-id",
500500
"parameters": [
501501
{
502502
"description": "The version of the API to use",
@@ -542,7 +542,7 @@
542542
},
543543
"get": {
544544
"deprecated": true,
545-
"operationId": "%2Fapi%2Factions%2Faction%2F%7Bid%7D#1",
545+
"operationId": "get-actions-action-id",
546546
"parameters": [
547547
{
548548
"description": "The version of the API to use",
@@ -628,7 +628,7 @@
628628
},
629629
"put": {
630630
"deprecated": true,
631-
"operationId": "%2Fapi%2Factions%2Faction%2F%7Bid%7D#2",
631+
"operationId": "put-actions-action-id",
632632
"parameters": [
633633
{
634634
"description": "The version of the API to use",
@@ -754,7 +754,7 @@
754754
"/api/actions/action/{id}/_execute": {
755755
"post": {
756756
"deprecated": true,
757-
"operationId": "%2Fapi%2Factions%2Faction%2F%7Bid%7D%2F_execute#0",
757+
"operationId": "post-actions-action-id-execute",
758758
"parameters": [
759759
{
760760
"description": "The version of the API to use",
@@ -871,7 +871,7 @@
871871
"/api/actions/connector/{id}": {
872872
"delete": {
873873
"description": "WARNING: When you delete a connector, it cannot be recovered.",
874-
"operationId": "%2Fapi%2Factions%2Fconnector%2F%7Bid%7D#0",
874+
"operationId": "delete-actions-connector-id",
875875
"parameters": [
876876
{
877877
"description": "The version of the API to use",
@@ -916,7 +916,7 @@
916916
]
917917
},
918918
"get": {
919-
"operationId": "%2Fapi%2Factions%2Fconnector%2F%7Bid%7D#1",
919+
"operationId": "get-actions-connector-id",
920920
"parameters": [
921921
{
922922
"description": "The version of the API to use",
@@ -1001,7 +1001,7 @@
10011001
]
10021002
},
10031003
"post": {
1004-
"operationId": "%2Fapi%2Factions%2Fconnector%2F%7Bid%3F%7D#0",
1004+
"operationId": "post-actions-connector-id",
10051005
"parameters": [
10061006
{
10071007
"description": "The version of the API to use",
@@ -1130,7 +1130,7 @@
11301130
]
11311131
},
11321132
"put": {
1133-
"operationId": "%2Fapi%2Factions%2Fconnector%2F%7Bid%7D#2",
1133+
"operationId": "put-actions-connector-id",
11341134
"parameters": [
11351135
{
11361136
"description": "The version of the API to use",
@@ -1257,7 +1257,7 @@
12571257
"/api/actions/connector/{id}/_execute": {
12581258
"post": {
12591259
"description": "You can use this API to test an action that involves interaction with Kibana services or integrations with third-party systems.",
1260-
"operationId": "%2Fapi%2Factions%2Fconnector%2F%7Bid%7D%2F_execute#0",
1260+
"operationId": "post-actions-connector-id-execute",
12611261
"parameters": [
12621262
{
12631263
"description": "The version of the API to use",
@@ -1374,7 +1374,7 @@
13741374
"/api/actions/connector_types": {
13751375
"get": {
13761376
"description": "You do not need any Kibana feature privileges to run this API.",
1377-
"operationId": "%2Fapi%2Factions%2Fconnector_types#0",
1377+
"operationId": "get-actions-connector-types",
13781378
"parameters": [
13791379
{
13801380
"description": "The version of the API to use",
@@ -1407,7 +1407,7 @@
14071407
},
14081408
"/api/actions/connectors": {
14091409
"get": {
1410-
"operationId": "%2Fapi%2Factions%2Fconnectors#0",
1410+
"operationId": "get-actions-connectors",
14111411
"parameters": [
14121412
{
14131413
"description": "The version of the API to use",
@@ -1432,7 +1432,7 @@
14321432
"/api/actions/list_action_types": {
14331433
"get": {
14341434
"deprecated": true,
1435-
"operationId": "%2Fapi%2Factions%2Flist_action_types#0",
1435+
"operationId": "get-actions-list-action-types",
14361436
"parameters": [
14371437
{
14381438
"description": "The version of the API to use",
@@ -1456,7 +1456,7 @@
14561456
},
14571457
"/api/alerting/rule/{id}": {
14581458
"delete": {
1459-
"operationId": "%2Fapi%2Falerting%2Frule%2F%7Bid%7D#2",
1459+
"operationId": "delete-alerting-rule-id",
14601460
"parameters": [
14611461
{
14621462
"description": "The version of the API to use",
@@ -1510,7 +1510,7 @@
15101510
]
15111511
},
15121512
"get": {
1513-
"operationId": "%2Fapi%2Falerting%2Frule%2F%7Bid%7D#0",
1513+
"operationId": "get-alerting-rule-id",
15141514
"parameters": [
15151515
{
15161516
"description": "The version of the API to use",
@@ -2446,7 +2446,7 @@
24462446
]
24472447
},
24482448
"post": {
2449-
"operationId": "%2Fapi%2Falerting%2Frule%2F%7Bid%3F%7D#0",
2449+
"operationId": "post-alerting-rule-id",
24502450
"parameters": [
24512451
{
24522452
"description": "The version of the API to use",
@@ -3684,7 +3684,7 @@
36843684
]
36853685
},
36863686
"put": {
3687-
"operationId": "%2Fapi%2Falerting%2Frule%2F%7Bid%7D#1",
3687+
"operationId": "put-alerting-rule-id",
36883688
"parameters": [
36893689
{
36903690
"description": "The version of the API to use",
@@ -4910,7 +4910,7 @@
49104910
},
49114911
"/api/alerting/rule/{id}/_disable": {
49124912
"post": {
4913-
"operationId": "%2Fapi%2Falerting%2Frule%2F%7Bid%7D%2F_disable#0",
4913+
"operationId": "post-alerting-rule-id-disable",
49144914
"parameters": [
49154915
{
49164916
"description": "The version of the API to use",
@@ -4984,7 +4984,7 @@
49844984
},
49854985
"/api/alerting/rule/{id}/_enable": {
49864986
"post": {
4987-
"operationId": "%2Fapi%2Falerting%2Frule%2F%7Bid%7D%2F_enable#0",
4987+
"operationId": "post-alerting-rule-id-enable",
49884988
"parameters": [
49894989
{
49904990
"description": "The version of the API to use",
@@ -5040,7 +5040,7 @@
50405040
},
50415041
"/api/alerting/rule/{id}/_mute_all": {
50425042
"post": {
5043-
"operationId": "%2Fapi%2Falerting%2Frule%2F%7Bid%7D%2F_mute_all#0",
5043+
"operationId": "post-alerting-rule-id-mute-all",
50445044
"parameters": [
50455045
{
50465046
"description": "The version of the API to use",
@@ -5096,7 +5096,7 @@
50965096
},
50975097
"/api/alerting/rule/{id}/_unmute_all": {
50985098
"post": {
5099-
"operationId": "%2Fapi%2Falerting%2Frule%2F%7Bid%7D%2F_unmute_all#0",
5099+
"operationId": "post-alerting-rule-id-unmute-all",
51005100
"parameters": [
51015101
{
51025102
"description": "The version of the API to use",
@@ -5152,7 +5152,7 @@
51525152
},
51535153
"/api/alerting/rule/{id}/_update_api_key": {
51545154
"post": {
5155-
"operationId": "%2Fapi%2Falerting%2Frule%2F%7Bid%7D%2F_update_api_key#0",
5155+
"operationId": "post-alerting-rule-id-update-api-key",
51565156
"parameters": [
51575157
{
51585158
"description": "The version of the API to use",
@@ -5211,7 +5211,7 @@
52115211
},
52125212
"/api/alerting/rule/{rule_id}/alert/{alert_id}/_mute": {
52135213
"post": {
5214-
"operationId": "%2Fapi%2Falerting%2Frule%2F%7Brule_id%7D%2Falert%2F%7Balert_id%7D%2F_mute#0",
5214+
"operationId": "post-alerting-rule-rule-id-alert-alert-id-mute",
52155215
"parameters": [
52165216
{
52175217
"description": "The version of the API to use",
@@ -5276,7 +5276,7 @@
52765276
},
52775277
"/api/alerting/rule/{rule_id}/alert/{alert_id}/_unmute": {
52785278
"post": {
5279-
"operationId": "%2Fapi%2Falerting%2Frule%2F%7Brule_id%7D%2Falert%2F%7Balert_id%7D%2F_unmute#0",
5279+
"operationId": "post-alerting-rule-rule-id-alert-alert-id-unmute",
52805280
"parameters": [
52815281
{
52825282
"description": "The version of the API to use",
@@ -5341,7 +5341,7 @@
53415341
},
53425342
"/api/alerting/rules/_find": {
53435343
"get": {
5344-
"operationId": "%2Fapi%2Falerting%2Frules%2F_find#0",
5344+
"operationId": "get-alerting-rules-find",
53455345
"parameters": [
53465346
{
53475347
"description": "The version of the API to use",
@@ -6409,7 +6409,7 @@
64096409
},
64106410
"/api/security/role": {
64116411
"get": {
6412-
"operationId": "%2Fapi%2Fsecurity%2Frole#0",
6412+
"operationId": "get-security-role",
64136413
"parameters": [
64146414
{
64156415
"description": "The version of the API to use",
@@ -6446,7 +6446,7 @@
64466446
},
64476447
"/api/security/role/{name}": {
64486448
"delete": {
6449-
"operationId": "%2Fapi%2Fsecurity%2Frole%2F%7Bname%7D#1",
6449+
"operationId": "delete-security-role-name",
64506450
"parameters": [
64516451
{
64526452
"description": "The version of the API to use",
@@ -6491,7 +6491,7 @@
64916491
]
64926492
},
64936493
"get": {
6494-
"operationId": "%2Fapi%2Fsecurity%2Frole%2F%7Bname%7D#0",
6494+
"operationId": "get-security-role-name",
64956495
"parameters": [
64966496
{
64976497
"description": "The version of the API to use",
@@ -6537,7 +6537,7 @@
65376537
},
65386538
"put": {
65396539
"description": "Create a new Kibana role or update the attributes of an existing role. Kibana roles are stored in the Elasticsearch native realm.",
6540-
"operationId": "%2Fapi%2Fsecurity%2Frole%2F%7Bname%7D#2",
6540+
"operationId": "put-security-role-name",
65416541
"parameters": [
65426542
{
65436543
"description": "The version of the API to use",
@@ -6856,7 +6856,7 @@
68566856
},
68576857
"/api/security/roles": {
68586858
"post": {
6859-
"operationId": "%2Fapi%2Fsecurity%2Froles#0",
6859+
"operationId": "post-security-roles",
68606860
"parameters": [
68616861
{
68626862
"description": "The version of the API to use",
@@ -7167,7 +7167,7 @@
71677167
"/api/spaces/_copy_saved_objects": {
71687168
"post": {
71697169
"description": "It also allows you to automatically copy related objects, so when you copy a dashboard, this can automatically copy over the associated visualizations, data views, and saved searches, as required. You can request to overwrite any objects that already exist in the target space if they share an identifier or you can use the resolve copy saved objects conflicts API to do this on a per-object basis.",
7170-
"operationId": "%2Fapi%2Fspaces%2F_copy_saved_objects#0",
7170+
"operationId": "post-spaces-copy-saved-objects",
71717171
"parameters": [
71727172
{
71737173
"description": "The version of the API to use",
@@ -7265,7 +7265,7 @@
72657265
},
72667266
"/api/spaces/_disable_legacy_url_aliases": {
72677267
"post": {
7268-
"operationId": "%2Fapi%2Fspaces%2F_disable_legacy_url_aliases#0",
7268+
"operationId": "post-spaces-disable-legacy-url-aliases",
72697269
"parameters": [
72707270
{
72717271
"description": "The version of the API to use",
@@ -7341,7 +7341,7 @@
73417341
"/api/spaces/_get_shareable_references": {
73427342
"post": {
73437343
"description": "Collect references and space contexts for saved objects.",
7344-
"operationId": "%2Fapi%2Fspaces%2F_get_shareable_references#0",
7344+
"operationId": "post-spaces-get-shareable-references",
73457345
"parameters": [
73467346
{
73477347
"description": "The version of the API to use",
@@ -7410,7 +7410,7 @@
74107410
"/api/spaces/_resolve_copy_saved_objects_errors": {
74117411
"post": {
74127412
"description": "Overwrite saved objects that are returned as errors from the copy saved objects to space API.",
7413-
"operationId": "%2Fapi%2Fspaces%2F_resolve_copy_saved_objects_errors#0",
7413+
"operationId": "post-spaces-resolve-copy-saved-objects-errors",
74147414
"parameters": [
74157415
{
74167416
"description": "The version of the API to use",
@@ -7531,7 +7531,7 @@
75317531
"/api/spaces/_update_objects_spaces": {
75327532
"post": {
75337533
"description": "Update one or more saved objects to add or remove them from some spaces.",
7534-
"operationId": "%2Fapi%2Fspaces%2F_update_objects_spaces#0",
7534+
"operationId": "post-spaces-update-objects-spaces",
75357535
"parameters": [
75367536
{
75377537
"description": "The version of the API to use",
@@ -7617,7 +7617,7 @@
76177617
},
76187618
"/api/spaces/space": {
76197619
"get": {
7620-
"operationId": "%2Fapi%2Fspaces%2Fspace#0",
7620+
"operationId": "get-spaces-space",
76217621
"parameters": [
76227622
{
76237623
"description": "The version of the API to use",
@@ -7697,7 +7697,7 @@
76977697
]
76987698
},
76997699
"post": {
7700-
"operationId": "%2Fapi%2Fspaces%2Fspace#1",
7700+
"operationId": "post-spaces-space",
77017701
"parameters": [
77027702
{
77037703
"description": "The version of the API to use",
@@ -7798,7 +7798,7 @@
77987798
"/api/spaces/space/{id}": {
77997799
"delete": {
78007800
"description": "When you delete a space, all saved objects that belong to the space are automatically deleted, which is permanent and cannot be undone.",
7801-
"operationId": "%2Fapi%2Fspaces%2Fspace%2F%7Bid%7D#2",
7801+
"operationId": "delete-spaces-space-id",
78027802
"parameters": [
78037803
{
78047804
"description": "The version of the API to use",
@@ -7846,7 +7846,7 @@
78467846
]
78477847
},
78487848
"get": {
7849-
"operationId": "%2Fapi%2Fspaces%2Fspace%2F%7Bid%7D#0",
7849+
"operationId": "get-spaces-space-id",
78507850
"parameters": [
78517851
{
78527852
"description": "The version of the API to use",
@@ -7881,7 +7881,7 @@
78817881
]
78827882
},
78837883
"put": {
7884-
"operationId": "%2Fapi%2Fspaces%2Fspace%2F%7Bid%7D#1",
7884+
"operationId": "put-spaces-space-id",
78857885
"parameters": [
78867886
{
78877887
"description": "The version of the API to use",
@@ -7990,7 +7990,7 @@
79907990
},
79917991
"/api/status": {
79927992
"get": {
7993-
"operationId": "%2Fapi%2Fstatus#0",
7993+
"operationId": "get-status",
79947994
"parameters": [
79957995
{
79967996
"description": "The version of the API to use",

0 commit comments

Comments
 (0)