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

[8.16] [OAS] Beautify generated operation ids (#198132) #198556

Merged
merged 4 commits into from
Oct 31, 2024
Merged

[8.16] [OAS] Beautify generated operation ids (#198132) #198556

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
95cd0ee
[OAS] Beautify generated operation ids (#198132)
jloleysens Oct 30, 2024
03ffef1
[CI] Auto-commit changed files from 'node scripts/capture_oas_snapsho…
kibanamachine Oct 31, 2024
948d02f
Remove serverless files
lcawl Oct 31, 2024
16a8eb1
[CI] Auto-commit changed files from 'make api-docs && make api-docs-s…
kibanamachine Oct 31, 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
84 changes: 42 additions & 42 deletions oas_docs/bundle.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -347,7 +347,7 @@
"/api/actions": {
"get": {
"deprecated": true,
"operationId": "%2Fapi%2Factions#0",
"operationId": "get-actions",
"parameters": [
{
"description": "The version of the API to use",
Expand All @@ -372,7 +372,7 @@
"/api/actions/action": {
"post": {
"deprecated": true,
"operationId": "%2Fapi%2Factions%2Faction#0",
"operationId": "post-actions-action",
"parameters": [
{
"description": "The version of the API to use",
Expand Down Expand Up @@ -496,7 +496,7 @@
"delete": {
"deprecated": true,
"description": "WARNING: When you delete a connector, it cannot be recovered.",
"operationId": "%2Fapi%2Factions%2Faction%2F%7Bid%7D#0",
"operationId": "delete-actions-action-id",
"parameters": [
{
"description": "The version of the API to use",
Expand Down Expand Up @@ -542,7 +542,7 @@
},
"get": {
"deprecated": true,
"operationId": "%2Fapi%2Factions%2Faction%2F%7Bid%7D#1",
"operationId": "get-actions-action-id",
"parameters": [
{
"description": "The version of the API to use",
Expand Down Expand Up @@ -628,7 +628,7 @@
},
"put": {
"deprecated": true,
"operationId": "%2Fapi%2Factions%2Faction%2F%7Bid%7D#2",
"operationId": "put-actions-action-id",
"parameters": [
{
"description": "The version of the API to use",
Expand Down Expand Up @@ -754,7 +754,7 @@
"/api/actions/action/{id}/_execute": {
"post": {
"deprecated": true,
"operationId": "%2Fapi%2Factions%2Faction%2F%7Bid%7D%2F_execute#0",
"operationId": "post-actions-action-id-execute",
"parameters": [
{
"description": "The version of the API to use",
Expand Down Expand Up @@ -871,7 +871,7 @@
"/api/actions/connector/{id}": {
"delete": {
"description": "WARNING: When you delete a connector, it cannot be recovered.",
"operationId": "%2Fapi%2Factions%2Fconnector%2F%7Bid%7D#0",
"operationId": "delete-actions-connector-id",
"parameters": [
{
"description": "The version of the API to use",
Expand Down Expand Up @@ -916,7 +916,7 @@
]
},
"get": {
"operationId": "%2Fapi%2Factions%2Fconnector%2F%7Bid%7D#1",
"operationId": "get-actions-connector-id",
"parameters": [
{
"description": "The version of the API to use",
Expand Down Expand Up @@ -1001,7 +1001,7 @@
]
},
"post": {
"operationId": "%2Fapi%2Factions%2Fconnector%2F%7Bid%3F%7D#0",
"operationId": "post-actions-connector-id",
"parameters": [
{
"description": "The version of the API to use",
Expand Down Expand Up @@ -1130,7 +1130,7 @@
]
},
"put": {
"operationId": "%2Fapi%2Factions%2Fconnector%2F%7Bid%7D#2",
"operationId": "put-actions-connector-id",
"parameters": [
{
"description": "The version of the API to use",
Expand Down Expand Up @@ -1257,7 +1257,7 @@
"/api/actions/connector/{id}/_execute": {
"post": {
"description": "You can use this API to test an action that involves interaction with Kibana services or integrations with third-party systems.",
"operationId": "%2Fapi%2Factions%2Fconnector%2F%7Bid%7D%2F_execute#0",
"operationId": "post-actions-connector-id-execute",
"parameters": [
{
"description": "The version of the API to use",
Expand Down Expand Up @@ -1374,7 +1374,7 @@
"/api/actions/connector_types": {
"get": {
"description": "You do not need any Kibana feature privileges to run this API.",
"operationId": "%2Fapi%2Factions%2Fconnector_types#0",
"operationId": "get-actions-connector-types",
"parameters": [
{
"description": "The version of the API to use",
Expand Down Expand Up @@ -1407,7 +1407,7 @@
},
"/api/actions/connectors": {
"get": {
"operationId": "%2Fapi%2Factions%2Fconnectors#0",
"operationId": "get-actions-connectors",
"parameters": [
{
"description": "The version of the API to use",
Expand All @@ -1432,7 +1432,7 @@
"/api/actions/list_action_types": {
"get": {
"deprecated": true,
"operationId": "%2Fapi%2Factions%2Flist_action_types#0",
"operationId": "get-actions-list-action-types",
"parameters": [
{
"description": "The version of the API to use",
Expand All @@ -1456,7 +1456,7 @@
},
"/api/alerting/rule/{id}": {
"delete": {
"operationId": "%2Fapi%2Falerting%2Frule%2F%7Bid%7D#2",
"operationId": "delete-alerting-rule-id",
"parameters": [
{
"description": "The version of the API to use",
Expand Down Expand Up @@ -1510,7 +1510,7 @@
]
},
"get": {
"operationId": "%2Fapi%2Falerting%2Frule%2F%7Bid%7D#0",
"operationId": "get-alerting-rule-id",
"parameters": [
{
"description": "The version of the API to use",
Expand Down Expand Up @@ -2446,7 +2446,7 @@
]
},
"post": {
"operationId": "%2Fapi%2Falerting%2Frule%2F%7Bid%3F%7D#0",
"operationId": "post-alerting-rule-id",
"parameters": [
{
"description": "The version of the API to use",
Expand Down Expand Up @@ -3684,7 +3684,7 @@
]
},
"put": {
"operationId": "%2Fapi%2Falerting%2Frule%2F%7Bid%7D#1",
"operationId": "put-alerting-rule-id",
"parameters": [
{
"description": "The version of the API to use",
Expand Down Expand Up @@ -4910,7 +4910,7 @@
},
"/api/alerting/rule/{id}/_disable": {
"post": {
"operationId": "%2Fapi%2Falerting%2Frule%2F%7Bid%7D%2F_disable#0",
"operationId": "post-alerting-rule-id-disable",
"parameters": [
{
"description": "The version of the API to use",
Expand Down Expand Up @@ -4984,7 +4984,7 @@
},
"/api/alerting/rule/{id}/_enable": {
"post": {
"operationId": "%2Fapi%2Falerting%2Frule%2F%7Bid%7D%2F_enable#0",
"operationId": "post-alerting-rule-id-enable",
"parameters": [
{
"description": "The version of the API to use",
Expand Down Expand Up @@ -5040,7 +5040,7 @@
},
"/api/alerting/rule/{id}/_mute_all": {
"post": {
"operationId": "%2Fapi%2Falerting%2Frule%2F%7Bid%7D%2F_mute_all#0",
"operationId": "post-alerting-rule-id-mute-all",
"parameters": [
{
"description": "The version of the API to use",
Expand Down Expand Up @@ -5096,7 +5096,7 @@
},
"/api/alerting/rule/{id}/_unmute_all": {
"post": {
"operationId": "%2Fapi%2Falerting%2Frule%2F%7Bid%7D%2F_unmute_all#0",
"operationId": "post-alerting-rule-id-unmute-all",
"parameters": [
{
"description": "The version of the API to use",
Expand Down Expand Up @@ -5152,7 +5152,7 @@
},
"/api/alerting/rule/{id}/_update_api_key": {
"post": {
"operationId": "%2Fapi%2Falerting%2Frule%2F%7Bid%7D%2F_update_api_key#0",
"operationId": "post-alerting-rule-id-update-api-key",
"parameters": [
{
"description": "The version of the API to use",
Expand Down Expand Up @@ -5211,7 +5211,7 @@
},
"/api/alerting/rule/{rule_id}/alert/{alert_id}/_mute": {
"post": {
"operationId": "%2Fapi%2Falerting%2Frule%2F%7Brule_id%7D%2Falert%2F%7Balert_id%7D%2F_mute#0",
"operationId": "post-alerting-rule-rule-id-alert-alert-id-mute",
"parameters": [
{
"description": "The version of the API to use",
Expand Down Expand Up @@ -5276,7 +5276,7 @@
},
"/api/alerting/rule/{rule_id}/alert/{alert_id}/_unmute": {
"post": {
"operationId": "%2Fapi%2Falerting%2Frule%2F%7Brule_id%7D%2Falert%2F%7Balert_id%7D%2F_unmute#0",
"operationId": "post-alerting-rule-rule-id-alert-alert-id-unmute",
"parameters": [
{
"description": "The version of the API to use",
Expand Down Expand Up @@ -5341,7 +5341,7 @@
},
"/api/alerting/rules/_find": {
"get": {
"operationId": "%2Fapi%2Falerting%2Frules%2F_find#0",
"operationId": "get-alerting-rules-find",
"parameters": [
{
"description": "The version of the API to use",
Expand Down Expand Up @@ -6409,7 +6409,7 @@
},
"/api/security/role": {
"get": {
"operationId": "%2Fapi%2Fsecurity%2Frole#0",
"operationId": "get-security-role",
"parameters": [
{
"description": "The version of the API to use",
Expand Down Expand Up @@ -6446,7 +6446,7 @@
},
"/api/security/role/{name}": {
"delete": {
"operationId": "%2Fapi%2Fsecurity%2Frole%2F%7Bname%7D#1",
"operationId": "delete-security-role-name",
"parameters": [
{
"description": "The version of the API to use",
Expand Down Expand Up @@ -6491,7 +6491,7 @@
]
},
"get": {
"operationId": "%2Fapi%2Fsecurity%2Frole%2F%7Bname%7D#0",
"operationId": "get-security-role-name",
"parameters": [
{
"description": "The version of the API to use",
Expand Down Expand Up @@ -6537,7 +6537,7 @@
},
"put": {
"description": "Create a new Kibana role or update the attributes of an existing role. Kibana roles are stored in the Elasticsearch native realm.",
"operationId": "%2Fapi%2Fsecurity%2Frole%2F%7Bname%7D#2",
"operationId": "put-security-role-name",
"parameters": [
{
"description": "The version of the API to use",
Expand Down Expand Up @@ -6856,7 +6856,7 @@
},
"/api/security/roles": {
"post": {
"operationId": "%2Fapi%2Fsecurity%2Froles#0",
"operationId": "post-security-roles",
"parameters": [
{
"description": "The version of the API to use",
Expand Down Expand Up @@ -7167,7 +7167,7 @@
"/api/spaces/_copy_saved_objects": {
"post": {
"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.",
"operationId": "%2Fapi%2Fspaces%2F_copy_saved_objects#0",
"operationId": "post-spaces-copy-saved-objects",
"parameters": [
{
"description": "The version of the API to use",
Expand Down Expand Up @@ -7265,7 +7265,7 @@
},
"/api/spaces/_disable_legacy_url_aliases": {
"post": {
"operationId": "%2Fapi%2Fspaces%2F_disable_legacy_url_aliases#0",
"operationId": "post-spaces-disable-legacy-url-aliases",
"parameters": [
{
"description": "The version of the API to use",
Expand Down Expand Up @@ -7341,7 +7341,7 @@
"/api/spaces/_get_shareable_references": {
"post": {
"description": "Collect references and space contexts for saved objects.",
"operationId": "%2Fapi%2Fspaces%2F_get_shareable_references#0",
"operationId": "post-spaces-get-shareable-references",
"parameters": [
{
"description": "The version of the API to use",
Expand Down Expand Up @@ -7410,7 +7410,7 @@
"/api/spaces/_resolve_copy_saved_objects_errors": {
"post": {
"description": "Overwrite saved objects that are returned as errors from the copy saved objects to space API.",
"operationId": "%2Fapi%2Fspaces%2F_resolve_copy_saved_objects_errors#0",
"operationId": "post-spaces-resolve-copy-saved-objects-errors",
"parameters": [
{
"description": "The version of the API to use",
Expand Down Expand Up @@ -7531,7 +7531,7 @@
"/api/spaces/_update_objects_spaces": {
"post": {
"description": "Update one or more saved objects to add or remove them from some spaces.",
"operationId": "%2Fapi%2Fspaces%2F_update_objects_spaces#0",
"operationId": "post-spaces-update-objects-spaces",
"parameters": [
{
"description": "The version of the API to use",
Expand Down Expand Up @@ -7617,7 +7617,7 @@
},
"/api/spaces/space": {
"get": {
"operationId": "%2Fapi%2Fspaces%2Fspace#0",
"operationId": "get-spaces-space",
"parameters": [
{
"description": "The version of the API to use",
Expand Down Expand Up @@ -7697,7 +7697,7 @@
]
},
"post": {
"operationId": "%2Fapi%2Fspaces%2Fspace#1",
"operationId": "post-spaces-space",
"parameters": [
{
"description": "The version of the API to use",
Expand Down Expand Up @@ -7798,7 +7798,7 @@
"/api/spaces/space/{id}": {
"delete": {
"description": "When you delete a space, all saved objects that belong to the space are automatically deleted, which is permanent and cannot be undone.",
"operationId": "%2Fapi%2Fspaces%2Fspace%2F%7Bid%7D#2",
"operationId": "delete-spaces-space-id",
"parameters": [
{
"description": "The version of the API to use",
Expand Down Expand Up @@ -7846,7 +7846,7 @@
]
},
"get": {
"operationId": "%2Fapi%2Fspaces%2Fspace%2F%7Bid%7D#0",
"operationId": "get-spaces-space-id",
"parameters": [
{
"description": "The version of the API to use",
Expand Down Expand Up @@ -7881,7 +7881,7 @@
]
},
"put": {
"operationId": "%2Fapi%2Fspaces%2Fspace%2F%7Bid%7D#1",
"operationId": "put-spaces-space-id",
"parameters": [
{
"description": "The version of the API to use",
Expand Down Expand Up @@ -7990,7 +7990,7 @@
},
"/api/status": {
"get": {
"operationId": "%2Fapi%2Fstatus#0",
"operationId": "get-status",
"parameters": [
{
"description": "The version of the API to use",
Expand Down
Loading