From 771e793c7bc4f9e28ca8542b14e9332681a9f740 Mon Sep 17 00:00:00 2001 From: lcawl Date: Thu, 6 Mar 2025 19:26:22 -0800 Subject: [PATCH 1/6] Remove first batch of overlays --- .../elasticsearch-openapi-overlays.yaml | 486 ------------------ 1 file changed, 486 deletions(-) diff --git a/docs/overlays/elasticsearch-openapi-overlays.yaml b/docs/overlays/elasticsearch-openapi-overlays.yaml index d83cc61e8b..787f657cec 100644 --- a/docs/overlays/elasticsearch-openapi-overlays.yaml +++ b/docs/overlays/elasticsearch-openapi-overlays.yaml @@ -62,472 +62,6 @@ actions: - basicAuth: [] - bearerAuth: [] # Examples that apply only to the Elasticsearch OpenAPI document -## Examples for autoscaling - - target: "$.paths['/_autoscaling/policy/{name}']['delete']" - description: "Add examples for delete autoscaling policy response" - update: - responses: - 200: - content: - application/json: - examples: - deleteAutoscalingPolicyResponseExample1: - $ref: "../../specification/autoscaling/delete_autoscaling_policy/examples/response/DeleteAutoscalingPolicyResponseExample1.yaml" - - target: "$.paths['/_autoscaling/capacity']['get']" - description: "Add examples for get autoscaling capacity response" - update: - responses: - 200: - content: - application/json: - examples: - getAutoscalingCapacityResponseExample1: - $ref: "../../specification/autoscaling/get_autoscaling_capacity/examples/200_response/GetAutoscalingCapacityResponseExample1.yaml" - - target: "$.paths['/_autoscaling/policy/{name}']['get']" - description: "Add examples for get autoscaling policy response" - update: - responses: - 200: - content: - application/json: - examples: - getAutoscalingPolicyResponseExample1: - $ref: "../../specification/autoscaling/get_autoscaling_policy/examples/200_response/GetAutoscalingPolicyResponseExample1.yaml" - - target: "$.paths['/_autoscaling/policy/{name}']['put']" - description: "Add examples for create autoscaling policy operation" - update: - requestBody: - content: - application/json: - examples: - createAutoscalingPolicyRequestExample1: - $ref: "../../specification/autoscaling/put_autoscaling_policy/examples/request/PutAutoscalingPolicyRequestExample1.yaml" - createAutoscalingPolicyRequestExample2: - $ref: "../../specification/autoscaling/put_autoscaling_policy/examples/request/PutAutoscalingPolicyRequestExample2.yaml" - responses: - 200: - content: - application/json: - examples: - createAutoscalingPolicyResponseExample1: - $ref: "../../specification/autoscaling/put_autoscaling_policy/examples/200_response/PutAutoscalingPolicyResponseExample1.yaml" -## Examples for behavioral analytics - - target: "$.paths['/_application/analytics/{collection_name}/event/{event_type}']['post']" - description: "Add examples for post analytics collection event operation" - update: - requestBody: - content: - application/json: - examples: - postBehavioralAnalyticsEventRequestExample1: - $ref: "../../specification/search_application/post_behavioral_analytics_event/examples/request/BehavioralAnalyticsEventPostRequestExample1.yaml" -## Examples for cat - - target: "$.components['responses']['cat.thread_pool#200']" - description: "Add example for cat thread pool response" - update: - content: - text/plain: - schema: - type: string - examples: - catThreadPoolResponseExample1: - $ref: "../../specification/cat/thread_pool/examples/200_response/CatThreadPoolResponseExample1.yaml" - catThreadPoolResponseExample2: - $ref: "../../specification/cat/thread_pool/examples/200_response/CatThreadPoolResponseExample2.yaml" -## Examples for ccr - - target: "$.paths['/{index}/_ccr/follow']['put']" - description: "Add examples for create follower operation" - update: - requestBody: - content: - application/json: - examples: - createFollowIndexRequestExample1: - $ref: "../../specification/ccr/follow/examples/request/CreateFollowIndexRequestExample1.yaml" - responses: - 200: - content: - application/json: - examples: - createFollowIndexResponseExample1: - $ref: "../../specification/ccr/follow/examples/response/CreateFollowIndexResponseExample1.yaml" - - target: "$.paths['/{index}/_ccr/forget_follower']['post']" - description: "Add examples for forget follower operation" - update: - requestBody: - content: - application/json: - examples: - forgetFollowerRequestExample1: - $ref: "../../specification/ccr/forget_follower/examples/request/ForgetFollowerIndexRequestExample1.yaml" - responses: - 200: - content: - application/json: - examples: - forgetFollowerResponseExample1: - $ref: "../../specification/ccr/forget_follower/examples/response/ForgetFollowerIndexResponseExample1.yaml" - - target: "$.paths['/_ccr/auto_follow/{name}']['put']" - description: "Add examples for create auto-follow pattern operation" - update: - requestBody: - content: - application/json: - examples: - putAutoFollowPatternRequestExample1: - $ref: "../../specification/ccr/put_auto_follow_pattern/examples/request/PutAutoFollowPatternRequestExample1.yaml" - responses: - 200: - content: - application/json: - examples: - putAutoFollowPatternResponseExample1: - $ref: "../../specification/ccr/put_auto_follow_pattern/examples/response/PutAutoFollowPatternResponseExample1.yaml" - - target: "$.paths['/{index}/_ccr/resume_follow']['post']" - description: "Add examples for resume a follower operation" - update: - requestBody: - content: - application/json: - examples: - resumeFollowIndexRequestExample1: - $ref: "../../specification/ccr/resume_follow/examples/request/ResumeFollowIndexRequestExample1.yaml" - responses: - 200: - content: - application/json: - examples: - resumeFollowIndexResponseExample1: - $ref: "../../specification/ccr/resume_follow/examples/response/ResumeFollowIndexResponseExample1.yaml" - - target: "$.paths['/{index}/_ccr/unfollow']['post']" - description: "Add examples for unfollow an index" - update: - responses: - 200: - content: - application/json: - examples: - ccrUnfollowIndexResponseExample1: - $ref: "../../specification/ccr/unfollow/examples/response/UnfollowIndexResponseExample1.yaml" - - target: "$.paths['/_ccr/stats']['get']" - description: "Add examples for get ccr stats" - update: - responses: - 200: - content: - application/json: - examples: - ccrStatsResponseExample1: - $ref: "../../specification/ccr/stats/examples/response/CcrStatsResponseExample1.yaml" - - target: "$.paths['/_ccr/auto_follow/{name}/resume']['post']" - description: "Add examples for resume auto-follow pattern" - update: - responses: - 200: - content: - application/json: - examples: - ccrResumeAutoFollowResponseExample1: - $ref: "../../specification/ccr/resume_auto_follow_pattern/examples/response/ResumeAutoFollowPatternResponseExample1.yaml" - - target: "$.paths['/{index}/_ccr/pause_follow']['post']" - description: "Add examples for resume auto-follow pattern" - update: - responses: - 200: - content: - application/json: - examples: - ccrPauseFollowResponseExample1: - $ref: "../../specification/ccr/pause_follow/examples/response/PauseFollowIndexResponseExample1.yaml" - - target: "$.paths['/_ccr/auto_follow/{name}/pause']['post']" - description: "Add examples for pause auto-follow pattern" - update: - responses: - 200: - content: - application/json: - examples: - ccrPauseAutoFollowPatternResponseExample1: - $ref: "../../specification/ccr/pause_auto_follow_pattern/examples/response/PauseAutoFollowPatternResponseExample1.yaml" - - target: "$.components['responses']['ccr.get_auto_follow_pattern#200']" - description: "Add examples for get auto-follow pattern" - update: - content: - application/json: - examples: - ccrPauseAutoFollowPatternResponseExample1: - $ref: "../../specification/ccr/get_auto_follow_pattern/examples/response/GetAutoFollowPatternResponseExample1.yaml" - - target: "$.paths['/{index}/_ccr/stats']['get']" - description: "Add examples for get follower stats" - update: - responses: - 200: - content: - application/json: - examples: - ccrFollowerStatsResponseExample1: - $ref: "../../specification/ccr/follow_stats/examples/response/FollowIndexStatsResponseExample1.yaml" - - target: "$.paths['/{index}/_ccr/info']['get']" - description: "Add examples for get follower info" - update: - responses: - 200: - content: - application/json: - examples: - ccrFollowerInfoResponseExample1: - $ref: "../../specification/ccr/follow_info/examples/response/FollowInfoResponseExample1.yaml" - ccrFollowerInfoResponseExample2: - $ref: "../../specification/ccr/follow_info/examples/response/FollowInfoResponseExample2.yaml" - - target: "$.paths['/_ccr/auto_follow/{name}']['delete']" - description: "Add examples for delete auto follow pattern" - update: - responses: - 200: - content: - application/json: - examples: - ccrAutoFollowPatternDeleteResponseExample1: - $ref: "../../specification/ccr/delete_auto_follow_pattern/examples/response/DeleteAutoFollowPatternResponseExample1.yaml" -## Examples for cluster - - target: "$.components['requestBodies']['cluster.allocation_explain']" - description: "Add examples for cluster allocation explain operation" - update: - content: - application/json: - examples: - clusterAllocationExplainRequestExample1: - $ref: "../../specification/cluster/allocation_explain/examples/request/clusterAllocationExplainRequestExample1.yaml" - - target: "$.components['responses']['cluster.health#200']" - description: "Add examples for cluster health operation" - update: - content: - application/json: - examples: - clusterHealthResponseExample1: - $ref: "../../specification/cluster/health/examples/response/clusterHealthResponseExample1.yaml" - - target: "$.paths['/_cluster/settings']['put']" - description: "Add examples for cluster update settings operation" - update: - requestBody: - content: - application/json: - examples: - clusterPutSettingsRequestExample1: - $ref: "../../specification/cluster/put_settings/examples/request/ClusterPutSettingsRequestExample1.yaml" - clusterPutSettingsRequestExample2: - $ref: "../../specification/cluster/put_settings/examples/request/ClusterPutSettingsRequestExample2.yaml" - - target: "$.paths['/_cluster/reroute']['post']" - description: "Add examples for cluster reroute operation" - update: - requestBody: - content: - application/json: - examples: - clusterRerouteRequestExample1: - $ref: "../../specification/cluster/reroute/examples/request/ClusterRerouteRequestExample1.yaml" - - target: "$.components['requestBodies']['nodes.reload_secure_settings']" - description: "Add examples for nodes reload secure settings operation" - update: - content: - application/json: - examples: - clusterNodesReloadSecureSettingsRequestExample1: - $ref: "../../specification/nodes/reload_secure_settings/examples/request/ReloadSecureSettingsRequestExample1.yaml" - - target: "$.components['responses']['nodes.reload_secure_settings#200']" - description: "Add response examples for nodes reload secure settings operation" - update: - content: - application/json: - examples: - clusterNodesReloadSecureSettingsResponseExample1: - $ref: "../../specification/nodes/reload_secure_settings/examples/response/ReloadSecureSettingsResponseExample1.yaml" - - target: "$.components['responses']['nodes.info#200']" - description: "Add response examples for nodes info" - update: - content: - application/json: - examples: - nodesInfoResponseExample1: - $ref: "../../specification/nodes/info/examples/200_response/nodesInfoResponseExample1.yaml" -## Examples for connectors - - target: "$.paths['/_connector/_sync_job/{connector_sync_job_id}/_error']['put']" - description: "Add examples for connector job sync error operation" - update: - requestBody: - content: - application/json: - examples: - syncJobErrorRequestExample1: - $ref: "../../specification/connector/sync_job_error/examples/request/SyncJobErrorRequestExample1.yaml" - - target: "$.paths['/_connector/{connector_id}/_features']['put']" - description: "Add examples for update connector features" - update: - requestBody: - content: - application/json: - examples: - connectorUpdateFeaturesRequestExample1: - $ref: "../../specification/connector/update_features/examples/request/ConnectorUpdateFeaturesRequestExample1.yaml" - connectorUpdateFeaturesRequestExample2: - $ref: "../../specification/connector/update_features/examples/request/ConnectorUpdateFeaturesRequestExample2.yaml" - responses: - 200: - content: - application/json: - examples: - connectorUpdateFeaturesResponseExample1: - $ref: "../../specification/connector/update_features/examples/response/ConnectorUpdateFeaturesResponseExample1.yaml" -## Examples for esql - - target: "$.paths['/_query/async']['post']" - description: "Add examples for async esql query operation" - update: - requestBody: - content: - application/json: - examples: - esqlAsyncQueryRequestExample1: - $ref: "../../specification/esql/async_query/examples/request/AsyncQueryRequestExample1.yaml" -## Examples for features - - target: "$.paths['/_features']['get']" - description: "Add examples for get features operation" - update: - responses: - 200: - content: - application/json: - examples: - getFeaturesResponseExample1: - $ref: "../../specification/features/get_features/examples/response/GetFeaturesResponseExample1.yaml" - - target: "$.paths['/_features/_reset']['post']" - description: "Add examples for reset features operation" - update: - responses: - 200: - content: - application/json: - examples: - resetFeaturesResponseExample1: - $ref: "../../specification/features/reset_features/examples/response/ResetFeaturesResponseExample1.yaml" -## Examples for ilm - - target: "$.paths['/_ilm/policy/{policy}']['delete']" - description: "Add examples for delete lifecycle policy operation" - update: - responses: - 200: - content: - application/json: - examples: - deleteLifecycleResponseExample1: - $ref: "../../specification/ilm/delete_lifecycle/examples/response/DeleteLifecycleResponseExample1.yaml" - - target: "$.paths['/_ilm/policy/{policy}']['put']" - description: "Add examples for create a lifecycle operation" - update: - requestBody: - content: - application/json: - examples: - putLifecycleRequestExample1: - $ref: "../../specification/ilm/put_lifecycle/examples/request/PutLifecycleRequestExample1.yaml" - responses: - 200: - content: - application/json: - examples: - putLifecycleResponseExample1: - $ref: "../../specification/ilm/put_lifecycle/examples/response/PutLifecycleResponseExample1.yaml" - - target: "$.components['responses']['ilm.get_lifecycle#200']" - description: "Add examples for get lifecycle policy operation" - update: - content: - application/json: - examples: - getLifecycleResponseExample1: - $ref: "../../specification/ilm/get_lifecycle/examples/response/GetLifecycleResponseExample1.yaml" - - target: "$.paths['/_ilm/migrate_to_data_tiers']['post']" - description: "Add examples for migrate to data tiers routing operation" - update: - requestBody: - content: - application/json: - examples: - migrateToDataTiersRequestExample1: - $ref: "../../specification/ilm/migrate_to_data_tiers/examples/request/RequestExample1.yaml" - responses: - 200: - content: - application/json: - examples: - migrateToDataTiersResponseExample1: - $ref: "../../specification/ilm/migrate_to_data_tiers/examples/response/ResponseExample1.yaml" - - target: "$.paths['/_ilm/move/{index}']['post']" - description: "Add examples for move to lifecycle step operation" - update: - requestBody: - content: - application/json: - examples: - moveToStepRequestExample1: - $ref: "../../specification/ilm/move_to_step/examples/request/MoveToStepRequestExample1.yaml" - moveToStepRequestExample2: - $ref: "../../specification/ilm/move_to_step/examples/request/MoveToStepRequestExample2.yaml" - responses: - 200: - content: - application/json: - examples: - moveToStepResponseExample1: - $ref: "../../specification/ilm/move_to_step/examples/response/MoveToStepResponseExample1.yaml" - - target: "$.paths['/_ilm/start']['post']" - description: "Add examples for start index lifecycle management operation" - update: - responses: - 200: - content: - application/json: - examples: - startILMResponseExample1: - $ref: "../../specification/ilm/start/examples/response/StartILMResponseExample1.yaml" - - target: "$.paths['/_ilm/stop']['post']" - description: "Add examples for stop index lifecycle management operation" - update: - responses: - 200: - content: - application/json: - examples: - stopILMResponseExample1: - $ref: "../../specification/ilm/stop/examples/response/StopILMResponseExample1.yaml" - - target: "$.paths['/_ilm/status']['get']" - description: "Add examples for get index lifecycle management status operation" - update: - responses: - 200: - content: - application/json: - examples: - getILMStatusResponseExample1: - $ref: "../../specification/ilm/get_status/examples/response/GetILMStatusResponseExample1.yaml" - - target: "$.paths['/{index}/_ilm/explain']['get']" - description: "Add examples for explain lifecycle operation" - update: - responses: - 200: - content: - application/json: - examples: - explainLifecycleResponseExample1: - $ref: "../../specification/ilm/explain_lifecycle/examples/response/ExplainLifecycleResponseExample1.yaml" - - target: "$.paths['/{index}/_ilm/remove']['post']" - description: "Add examples for remove policy from index operation" - update: - responses: - 200: - content: - application/json: - examples: - removePolicyResponseExample1: - $ref: "../../specification/ilm/remove_policy/examples/response/RemovePolicyResponseExample1.yaml" ## Examples for indices - target: "$.paths['/_lifecycle/stats']['get']" description: "Add examples for get lifecycle stats operation" @@ -831,24 +365,4 @@ actions: examples: transformUpgradeResponseExample1: $ref: "../../specification/transform/upgrade_transforms/examples/response/UpgradeTransformResponseExample1.yaml" -## Examples for watcher - - target: "$.paths['/_watcher/settings']['put']" - description: "Add request example for update watcher settings" - update: - requestBody: - content: - application/json: - examples: - updateWatcherSettingsRequestExample1: - $ref: "../../specification/watcher/update_settings/examples/request/WatcherUpdateSettingsRequestExample1.yaml" - - target: "$.paths['/_watcher/settings']['get']" - description: "Add response example for get watcher settings" - update: - responses: - 200: - content: - application/json: - examples: - updateWatcherSettingsRequestExample1: - $ref: "../../specification/watcher/get_settings/examples/200_response/WatcherGetSettingsResponseExample1.yaml" From 17d2cd50bf4ddb9a1bb298b9ffe344a122ca3b72 Mon Sep 17 00:00:00 2001 From: lcawl Date: Thu, 6 Mar 2025 19:37:13 -0800 Subject: [PATCH 2/6] Change example files to unique names --- .../examples/request/RequestExample1.yaml | 11 ------ .../examples/response/ResponseExample1.yaml | 15 -------- .../examples/request/RequestExample1.yaml | 6 ---- .../examples/response/ResponseExample1.yaml | 21 ----------- .../examples/request/RequestExample1.yaml | 11 ------ .../examples/response/ResponseExample1.yaml | 25 ------------- .../examples/response/ResponseExample1.yaml | 12 ------- .../examples/response/ResponseExample1.yaml | 15 -------- .../examples/response/ResponseExample1.yaml | 33 ----------------- .../examples/response/ResponseExample2.yaml | 36 ------------------- .../examples/response/ResponseExample3.yaml | 18 ---------- .../examples/request/RequestExample1.yaml | 33 ----------------- .../examples/response/ResponseExample1.yaml | 18 ---------- .../examples/request/RequestExample1.yaml | 13 ------- .../examples/response/ResponseExample1.yaml | 13 ------- .../examples/request/RequestExample1.yaml | 9 ----- .../examples/response/ResponseExample1.yaml | 8 ----- .../examples/request/RequestExample1.yaml | 9 ----- .../examples/request/RequestExample2.yaml | 11 ------ .../examples/request/RequestExample3.yaml | 11 ------ .../examples/response/ResponseExample1.yaml | 13 ------- .../examples/request/RequestExample1.yaml | 10 ------ .../examples/response/ResponseExample1.yaml | 12 ------- .../examples/request/RequestExample1.yaml | 11 ------ .../examples/request/RequestExample2.yaml | 11 ------ .../examples/request/RequestExample1.yaml | 10 ------ .../examples/response/ResponseExample1.yaml | 10 ------ .../examples/request/RequestExample1.yaml | 10 ------ .../examples/response/ResponseExample1.yaml | 8 ----- .../examples/request/RequestExample1.yaml | 9 ----- .../examples/request/RequestExample2.yaml | 9 ----- .../examples/response/ResponseExample1.yaml | 10 ------ .../examples/response/ResponseExample1.yaml | 9 ----- .../examples/request/RequestExample1.yaml | 20 ----------- .../examples/response/ResponseExample1.yaml | 10 ------ .../examples/request/RequestExample1.yaml | 25 ------------- .../examples/request/RequestExample2.yaml | 10 ------ .../examples/response/ResponseExample1.yaml | 10 ------ .../examples/request/RequestExample1.yaml | 16 --------- .../examples/response/ResponseExample1.yaml | 9 ----- 40 files changed, 560 deletions(-) delete mode 100644 specification/ilm/migrate_to_data_tiers/examples/request/RequestExample1.yaml delete mode 100644 specification/ilm/migrate_to_data_tiers/examples/response/ResponseExample1.yaml delete mode 100644 specification/indices/downsample/examples/request/RequestExample1.yaml delete mode 100644 specification/searchable_snapshots/cache_stats/examples/response/ResponseExample1.yaml delete mode 100644 specification/security/activate_user_profile/examples/request/RequestExample1.yaml delete mode 100644 specification/security/activate_user_profile/examples/response/ResponseExample1.yaml delete mode 100644 specification/security/enroll_kibana/examples/response/ResponseExample1.yaml delete mode 100644 specification/security/enroll_node/examples/response/ResponseExample1.yaml delete mode 100644 specification/security/get_user_profile/examples/response/ResponseExample1.yaml delete mode 100644 specification/security/get_user_profile/examples/response/ResponseExample2.yaml delete mode 100644 specification/security/get_user_profile/examples/response/ResponseExample3.yaml delete mode 100644 specification/security/has_privileges_user_profile/examples/request/RequestExample1.yaml delete mode 100644 specification/security/has_privileges_user_profile/examples/response/ResponseExample1.yaml delete mode 100644 specification/security/oidc_authenticate/examples/request/RequestExample1.yaml delete mode 100644 specification/security/oidc_authenticate/examples/response/ResponseExample1.yaml delete mode 100644 specification/security/oidc_logout/examples/request/RequestExample1.yaml delete mode 100644 specification/security/oidc_logout/examples/response/ResponseExample1.yaml delete mode 100644 specification/security/oidc_prepare_authentication/examples/request/RequestExample1.yaml delete mode 100644 specification/security/oidc_prepare_authentication/examples/request/RequestExample2.yaml delete mode 100644 specification/security/oidc_prepare_authentication/examples/request/RequestExample3.yaml delete mode 100644 specification/security/oidc_prepare_authentication/examples/response/ResponseExample1.yaml delete mode 100644 specification/security/saml_authenticate/examples/request/RequestExample1.yaml delete mode 100644 specification/security/saml_authenticate/examples/response/ResponseExample1.yaml delete mode 100644 specification/security/saml_complete_logout/examples/request/RequestExample1.yaml delete mode 100644 specification/security/saml_complete_logout/examples/request/RequestExample2.yaml delete mode 100644 specification/security/saml_invalidate/examples/request/RequestExample1.yaml delete mode 100644 specification/security/saml_invalidate/examples/response/ResponseExample1.yaml delete mode 100644 specification/security/saml_logout/examples/request/RequestExample1.yaml delete mode 100644 specification/security/saml_logout/examples/response/ResponseExample1.yaml delete mode 100644 specification/security/saml_prepare_authentication/examples/request/RequestExample1.yaml delete mode 100644 specification/security/saml_prepare_authentication/examples/request/RequestExample2.yaml delete mode 100644 specification/security/saml_prepare_authentication/examples/response/ResponseExample1.yaml delete mode 100644 specification/security/saml_service_provider_metadata/examples/response/ResponseExample1.yaml delete mode 100644 specification/security/suggest_user_profiles/examples/request/RequestExample1.yaml delete mode 100644 specification/security/suggest_user_profiles/examples/response/ResponseExample1.yaml delete mode 100644 specification/security/update_api_key/examples/request/RequestExample1.yaml delete mode 100644 specification/security/update_api_key/examples/request/RequestExample2.yaml delete mode 100644 specification/security/update_api_key/examples/response/ResponseExample1.yaml delete mode 100644 specification/security/update_user_profile_data/examples/request/RequestExample1.yaml delete mode 100644 specification/security/update_user_profile_data/examples/response/ResponseExample1.yaml diff --git a/specification/ilm/migrate_to_data_tiers/examples/request/RequestExample1.yaml b/specification/ilm/migrate_to_data_tiers/examples/request/RequestExample1.yaml deleted file mode 100644 index bba220818a..0000000000 --- a/specification/ilm/migrate_to_data_tiers/examples/request/RequestExample1.yaml +++ /dev/null @@ -1,11 +0,0 @@ -# summary: 'Migrates indices, ILM policies, and templates from using custom node attributes to using data tiers.' -# method_request: POST /_ilm/migrate_to_data_tiers -description: > - Run `POST /_ilm/migrate_to_data_tiers` to migrate the indices, ILM policies, legacy templates, composable, and component templates away from defining custom allocation filtering using the `custom_attribute_name` node attribute. - It also deletes the legacy template with name `global-template` if it exists in the system. -# type: request -value: |- - { - "legacy_template_to_delete": "global-template", - "node_attribute": "custom_attribute_name" - } diff --git a/specification/ilm/migrate_to_data_tiers/examples/response/ResponseExample1.yaml b/specification/ilm/migrate_to_data_tiers/examples/response/ResponseExample1.yaml deleted file mode 100644 index 97f3c6acdc..0000000000 --- a/specification/ilm/migrate_to_data_tiers/examples/response/ResponseExample1.yaml +++ /dev/null @@ -1,15 +0,0 @@ -# summary: -description: > - A successful response when migrating indices, ILMs, and templates from custom node attributes to data tiers. -# type: response -# response_code: 200 -value: |- - { - "dry_run": false, - "removed_legacy_template":"global-template", - "migrated_ilm_policies":["policy_with_allocate_action"], - "migrated_indices":["warm-index-to-migrate-000001"], - "migrated_legacy_templates":["a-legacy-template"], - "migrated_composable_templates":["a-composable-template"], - "migrated_component_templates":["a-component-template"] - } diff --git a/specification/indices/downsample/examples/request/RequestExample1.yaml b/specification/indices/downsample/examples/request/RequestExample1.yaml deleted file mode 100644 index 9fb58afbac..0000000000 --- a/specification/indices/downsample/examples/request/RequestExample1.yaml +++ /dev/null @@ -1,6 +0,0 @@ -# summary: -# method_request: POST /my-time-series-index/_downsample/my-downsampled-time-series-index -# description: '' -# type: request -value: - fixed_interval: 1d diff --git a/specification/searchable_snapshots/cache_stats/examples/response/ResponseExample1.yaml b/specification/searchable_snapshots/cache_stats/examples/response/ResponseExample1.yaml deleted file mode 100644 index fac5613207..0000000000 --- a/specification/searchable_snapshots/cache_stats/examples/response/ResponseExample1.yaml +++ /dev/null @@ -1,21 +0,0 @@ -# summary: -description: A successful response from `GET /_searchable_snapshots/cache/stats`. -# type: response -# response_code: 200 -value: |- - { - "nodes" : { - "eerrtBMtQEisohZzxBLUSw" : { - "shared_cache" : { - "reads" : 6051, - "bytes_read_in_bytes" : 5448829, - "writes" : 37, - "bytes_written_in_bytes" : 1208320, - "evictions" : 5, - "num_regions" : 65536, - "size_in_bytes" : 1099511627776, - "region_size_in_bytes" : 16777216 - } - } - } - } diff --git a/specification/security/activate_user_profile/examples/request/RequestExample1.yaml b/specification/security/activate_user_profile/examples/request/RequestExample1.yaml deleted file mode 100644 index c7a0baf0af..0000000000 --- a/specification/security/activate_user_profile/examples/request/RequestExample1.yaml +++ /dev/null @@ -1,11 +0,0 @@ -# summary: -# method_request: POST /_security/profile/_activate -description: > - Run `POST /_security/profile/_activate` to activate a user profile. -# type: request -value: |- - { - "grant_type": "password", - "username" : "jacknich", - "password" : "l0ng-r4nd0m-p@ssw0rd" - } diff --git a/specification/security/activate_user_profile/examples/response/ResponseExample1.yaml b/specification/security/activate_user_profile/examples/response/ResponseExample1.yaml deleted file mode 100644 index f2d0e5b456..0000000000 --- a/specification/security/activate_user_profile/examples/response/ResponseExample1.yaml +++ /dev/null @@ -1,25 +0,0 @@ -# summary: -description: A successful response from `POST /_security/profile/_activate`. -# type: response -# response_code: -value: |- - { - "uid": "u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0", - "enabled": true, - "last_synchronized": 1642650651037, - "user": { - "username": "jacknich", - "roles": [ - "admin", "other_role1" - ], - "realm_name": "native", - "full_name": "Jack Nicholson", - "email": "jacknich@example.com" - }, - "labels": {}, - "data": {}, - "_doc": { - "_primary_term": 88, - "_seq_no": 66 - } - } diff --git a/specification/security/enroll_kibana/examples/response/ResponseExample1.yaml b/specification/security/enroll_kibana/examples/response/ResponseExample1.yaml deleted file mode 100644 index db74d609c4..0000000000 --- a/specification/security/enroll_kibana/examples/response/ResponseExample1.yaml +++ /dev/null @@ -1,12 +0,0 @@ -# summary: -description: A successful response from `GET /_security/enroll/kibana`. -# type: response -# response_code: -value: |- - { - "token" : { - "name" : "enroll-process-token-1629123923000", - "value": "AAEAAWVsYXN0aWM...vZmxlZXQtc2VydmVyL3Rva2VuMTo3TFdaSDZ" - }, - "http_ca" : "MIIJlAIBAzVoGCSqGSIb3...vsDfsA3UZBAjEPfhubpQysAICAA=", - } diff --git a/specification/security/enroll_node/examples/response/ResponseExample1.yaml b/specification/security/enroll_node/examples/response/ResponseExample1.yaml deleted file mode 100644 index 081db7c106..0000000000 --- a/specification/security/enroll_node/examples/response/ResponseExample1.yaml +++ /dev/null @@ -1,15 +0,0 @@ -# summary: -description: A successful response from `PGET /security/enroll/node`. -# type: response -# response_code: -value: |- - { - "http_ca_key" : "MIIJlAIBAzCCCVoGCSqGSIb3DQEHAaCCCUsEgglHMIIJQzCCA98GCSqGSIb3DQ....vsDfsA3UZBAjEPfhubpQysAICCAA=", - "http_ca_cert" : "MIIJlAIBAzCCCVoGCSqGSIb3DQEHAaCCCUsEgglHMIIJQzCCA98GCSqGSIb3DQ....vsDfsA3UZBAjEPfhubpQysAICCAA=", - "transport_ca_cert" : "MIIJlAIBAzCCCVoGCSqGSIb3DQEHAaCCCUsEgglHMIIJQzCCA98GCSqG....vsDfsA3UZBAjEPfhubpQysAICCAA=", - "transport_key" : "MIIEJgIBAzCCA98GCSqGSIb3DQEHAaCCA9AEggPMMIIDyDCCA8QGCSqGSIb3....YuEiOXvqZ6jxuVSQ0CAwGGoA==", - "transport_cert" : "MIIEJgIBAzCCA98GCSqGSIb3DQEHAaCCA9AEggPMMIIDyDCCA8QGCSqGSIb3....YuEiOXvqZ6jxuVSQ0CAwGGoA==", - "nodes_addresses" : [ - "192.168.1.2:9300" - ] - } diff --git a/specification/security/get_user_profile/examples/response/ResponseExample1.yaml b/specification/security/get_user_profile/examples/response/ResponseExample1.yaml deleted file mode 100644 index 842575afb4..0000000000 --- a/specification/security/get_user_profile/examples/response/ResponseExample1.yaml +++ /dev/null @@ -1,33 +0,0 @@ -summary: Profile details for a UUID -description: > - A successful response from `GET /_security/profile/u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0`. - By default, no content is returned in the `data` field. -# type: response -# response_code: -value: |- - { - "profiles": [ - { - "uid": "u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0", - "enabled": true, - "last_synchronized": 1642650651037, - "user": { - "username": "jacknich", - "roles": [ - "admin", "other_role1" - ], - "realm_name": "native", - "full_name": "Jack Nicholson", - "email": "jacknich@example.com" - }, - "labels": { - "direction": "north" - }, - "data": {}, - "_doc": { - "_primary_term": 88, - "_seq_no": 66 - } - } - ] - } diff --git a/specification/security/get_user_profile/examples/response/ResponseExample2.yaml b/specification/security/get_user_profile/examples/response/ResponseExample2.yaml deleted file mode 100644 index 55c31797c4..0000000000 --- a/specification/security/get_user_profile/examples/response/ResponseExample2.yaml +++ /dev/null @@ -1,36 +0,0 @@ -summary: Profile details for a UUID and data key -description: > - A successful response from `GET /_security/profile/u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0?data=app1.key1`. -# type: response -# response_code: -value: |- - { - "profiles": [ - { - "uid": "u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0", - "enabled": true, - "last_synchronized": 1642650651037, - "user": { - "username": "jacknich", - "roles": [ - "admin", "other_role1" - ], - "realm_name": "native", - "full_name": "Jack Nicholson", - "email": "jacknich@example.com" - }, - "labels": { - "direction": "north" - }, - "data": { - "app1": { - "key1": "value1" - } - }, - "_doc": { - "_primary_term": 88, - "_seq_no": 66 - } - } - ] - } diff --git a/specification/security/get_user_profile/examples/response/ResponseExample3.yaml b/specification/security/get_user_profile/examples/response/ResponseExample3.yaml deleted file mode 100644 index e263a8476c..0000000000 --- a/specification/security/get_user_profile/examples/response/ResponseExample3.yaml +++ /dev/null @@ -1,18 +0,0 @@ -summary: Profile details with errors -description: > - A response that contains errors that occurred while retrieving user profiles. -# type: response -# response_code: -value: |- - { - "profiles": [], - "errors": { - "count": 1, - "details": { - "u_FmxQt3gr1BBH5wpnz9HkouPj3Q710XkOgg1PWkwLPBW_5": { - "type": "resource_not_found_exception", - "reason": "profile document not found" - } - } - } - } diff --git a/specification/security/has_privileges_user_profile/examples/request/RequestExample1.yaml b/specification/security/has_privileges_user_profile/examples/request/RequestExample1.yaml deleted file mode 100644 index aed6d5b4dc..0000000000 --- a/specification/security/has_privileges_user_profile/examples/request/RequestExample1.yaml +++ /dev/null @@ -1,33 +0,0 @@ -# summary: -# method_request: POST /_security/profile/_has_privileges -description: > - Run `POST /_security/profile/_has_privileges` to check whether the two users associated with the specified profiles have all the requested set of cluster, index, and application privileges. -# type: request -value: |- - { - "uids": [ - "u_LQPnxDxEjIH0GOUoFkZr5Y57YUwSkL9Joiq-g4OCbPc_0", - "u_rzRnxDgEHIH0GOUoFkZr5Y27YUwSk19Joiq=g4OCxxB_1", - "u_does-not-exist_0" - ], - "privileges": { - "cluster": [ "monitor", "create_snapshot", "manage_ml" ], - "index" : [ - { - "names": [ "suppliers", "products" ], - "privileges": [ "create_doc"] - }, - { - "names": [ "inventory" ], - "privileges" : [ "read", "write" ] - } - ], - "application": [ - { - "application": "inventory_manager", - "privileges" : [ "read", "data:write/inventory" ], - "resources" : [ "product/1852563" ] - } - ] - } - } diff --git a/specification/security/has_privileges_user_profile/examples/response/ResponseExample1.yaml b/specification/security/has_privileges_user_profile/examples/response/ResponseExample1.yaml deleted file mode 100644 index 1d8a647fbd..0000000000 --- a/specification/security/has_privileges_user_profile/examples/response/ResponseExample1.yaml +++ /dev/null @@ -1,18 +0,0 @@ -# summary: -description: > - A response from `POST /_security/profile/_has_privileges` that indicates only one of the three users has all the privileges and one of them is not found. -# type: response -# response_code: -value: |- - { - "has_privilege_uids": ["u_rzRnxDgEHIH0GOUoFkZr5Y27YUwSk19Joiq=g4OCxxB_1"], - "errors": { - "count": 1, - "details": { - "u_does-not-exist_0": { - "type": "resource_not_found_exception", - "reason": "profile document not found" - } - } - } - } diff --git a/specification/security/oidc_authenticate/examples/request/RequestExample1.yaml b/specification/security/oidc_authenticate/examples/request/RequestExample1.yaml deleted file mode 100644 index a7c3169c96..0000000000 --- a/specification/security/oidc_authenticate/examples/request/RequestExample1.yaml +++ /dev/null @@ -1,13 +0,0 @@ -# summary: -# method_request: POST /_security/oidc/authenticate -description: > - Run `POST /_security/oidc/authenticate` to exchange the response that was returned from the OpenID Connect Provider after a successful authentication for an Elasticsearch access token and refresh token. - This example is from an authentication that uses the authorization code grant flow. -# type: request -value: |- - { - "redirect_uri" : "https://oidc-kibana.elastic.co:5603/api/security/oidc/callback?code=jtI3Ntt8v3_XvcLzCFGq&state=4dbrihtIAt3wBTwo6DxK-vdk-sSyDBV8Yf0AjdkdT5I", - "state" : "4dbrihtIAt3wBTwo6DxK-vdk-sSyDBV8Yf0AjdkdT5I", - "nonce" : "WaBPH0KqPVdG5HHdSxPRjfoZbXMCicm5v1OiAj0DUFM", - "realm" : "oidc1" - } diff --git a/specification/security/oidc_authenticate/examples/response/ResponseExample1.yaml b/specification/security/oidc_authenticate/examples/response/ResponseExample1.yaml deleted file mode 100644 index 03f05a48e6..0000000000 --- a/specification/security/oidc_authenticate/examples/response/ResponseExample1.yaml +++ /dev/null @@ -1,13 +0,0 @@ -# summary: -description: > - A successful response from `POST /_security/oidc/authenticate`. - It contains the access and refresh tokens that were generated, the token duration (in seconds), and the type. -# type: response -# response_code: -value: |- - { - "access_token" : "dGhpcyBpcyBub3QgYSByZWFsIHRva2VuIGJ1dCBpdCBpcyBvbmx5IHRlc3QgZGF0YS4gZG8gbm90IHRyeSB0byByZWFkIHRva2VuIQ==", - "type" : "Bearer", - "expires_in" : 1200, - "refresh_token": "vLBPvmAB6KvwvJZr27cS" - } diff --git a/specification/security/oidc_logout/examples/request/RequestExample1.yaml b/specification/security/oidc_logout/examples/request/RequestExample1.yaml deleted file mode 100644 index 1e6dcd7a27..0000000000 --- a/specification/security/oidc_logout/examples/request/RequestExample1.yaml +++ /dev/null @@ -1,9 +0,0 @@ -# summary: -# method_request: POST /_security/oidc/logout -description: Run `POST /_security/oidc/logout` to perform the logout. -# type: request -value: |- - { - "token" : "dGhpcyBpcyBub3QgYSByZWFsIHRva2VuIGJ1dCBpdCBpcyBvbmx5IHRlc3QgZGF0YS4gZG8gbm90IHRyeSB0byByZWFkIHRva2VuIQ==", - "refresh_token": "vLBPvmAB6KvwvJZr27cS" - } diff --git a/specification/security/oidc_logout/examples/response/ResponseExample1.yaml b/specification/security/oidc_logout/examples/response/ResponseExample1.yaml deleted file mode 100644 index 763a5d32b0..0000000000 --- a/specification/security/oidc_logout/examples/response/ResponseExample1.yaml +++ /dev/null @@ -1,8 +0,0 @@ -# summary: -description: A successful response from `POST /_security/oidc/logout`, which contains the URI pointing to the End Session Endpoint of the OpenID Connect Provider with all the parameters of the Logout Request as HTTP GET parameters. -# type: response -# response_code: -value: |- - { - "redirect" : "https://op-provider.org/logout?id_token_hint=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c&post_logout_redirect_uri=http%3A%2F%2Foidc-kibana.elastic.co%2Floggedout&state=lGYK0EcSLjqH6pkT5EVZjC6eIW5YCGgywj2sxROO" - } diff --git a/specification/security/oidc_prepare_authentication/examples/request/RequestExample1.yaml b/specification/security/oidc_prepare_authentication/examples/request/RequestExample1.yaml deleted file mode 100644 index d3e5f77a2e..0000000000 --- a/specification/security/oidc_prepare_authentication/examples/request/RequestExample1.yaml +++ /dev/null @@ -1,9 +0,0 @@ -summary: Prepare with realm -# method_request: POST /_security/oidc/prepare -description: > - Run `POST /_security/oidc/prepare` to generate an authentication request for the OpenID Connect Realm `oidc1`. -# type: request -value: |- - { - "realm" : "oidc1" - } diff --git a/specification/security/oidc_prepare_authentication/examples/request/RequestExample2.yaml b/specification/security/oidc_prepare_authentication/examples/request/RequestExample2.yaml deleted file mode 100644 index 864c364f12..0000000000 --- a/specification/security/oidc_prepare_authentication/examples/request/RequestExample2.yaml +++ /dev/null @@ -1,11 +0,0 @@ -summary: Prepare with realm, state, and nonce -# method_request: POST /_security/oidc/prepare -description: > - Run `POST /_security/oidc/prepare` to generate an authentication request for the OpenID Connect Realm `oidc1`, where the values for the `state` and the `nonce` have been generated by the client. -# type: request -value: |- - { - "realm" : "oidc1", - "state" : "lGYK0EcSLjqH6pkT5EVZjC6eIW5YCGgywj2sxROO", - "nonce" : "zOBXLJGUooRrbLbQk5YCcyC8AXw3iloynvluYhZ5" - } diff --git a/specification/security/oidc_prepare_authentication/examples/request/RequestExample3.yaml b/specification/security/oidc_prepare_authentication/examples/request/RequestExample3.yaml deleted file mode 100644 index e035d15357..0000000000 --- a/specification/security/oidc_prepare_authentication/examples/request/RequestExample3.yaml +++ /dev/null @@ -1,11 +0,0 @@ -summary: Prepare by realm -# method_request: POST /_security/oidc/prepare -description: > - Run `POST /_security/oidc/prepare` to generate an authentication request for a third party initiated single sign on. - Specify the issuer that should be used for matching the appropriate OpenID Connect Authentication realm. -# type: request -value: |- - { - "iss" : "http://127.0.0.1:8080", - "login_hint": "this_is_an_opaque_string" - } diff --git a/specification/security/oidc_prepare_authentication/examples/response/ResponseExample1.yaml b/specification/security/oidc_prepare_authentication/examples/response/ResponseExample1.yaml deleted file mode 100644 index d45d2faba5..0000000000 --- a/specification/security/oidc_prepare_authentication/examples/response/ResponseExample1.yaml +++ /dev/null @@ -1,13 +0,0 @@ -# summary: -description: > - A successful response from `POST /_security/oidc/prepare`. - It contains the URI pointing to the Authorization Endpoint of the OpenID Connect Provider with all the parameters of the Authentication Request as HTTP GET parameters. -# type: response -# response_code: -value: |- - { - "redirect" : "http://127.0.0.1:8080/c2id-login?scope=openid&response_type=id_token&redirect_uri=https%3A%2F%2Fmy.fantastic.rp%2Fcb&state=4dbrihtIAt3wBTwo6DxK-vdk-sSyDBV8Yf0AjdkdT5I&nonce=WaBPH0KqPVdG5HHdSxPRjfoZbXMCicm5v1OiAj0DUFM&client_id=elasticsearch-rp", - "state" : "4dbrihtIAt3wBTwo6DxK-vdk-sSyDBV8Yf0AjdkdT5I", - "nonce" : "WaBPH0KqPVdG5HHdSxPRjfoZbXMCicm5v1OiAj0DUFM", - "realm" : "oidc1" - } diff --git a/specification/security/saml_authenticate/examples/request/RequestExample1.yaml b/specification/security/saml_authenticate/examples/request/RequestExample1.yaml deleted file mode 100644 index ef77f13e2f..0000000000 --- a/specification/security/saml_authenticate/examples/request/RequestExample1.yaml +++ /dev/null @@ -1,10 +0,0 @@ -# summary: -# method_request: POST /_security/saml/authenticate -description: > - Run `POST /_security/saml/authenticate` to exchange a SAML Response indicating a successful authentication at the SAML IdP for an Elasticsearch access token and refresh token to be used in subsequent requests. -# type: request -value: |- - { - "content" : "PHNhbWxwOlJlc3BvbnNlIHhtbG5zOnNhbWxwPSJ1cm46b2FzaXM6bmFtZXM6dGM6U0FNTDoyLjA6cHJvdG9jb2wiIHhtbG5zOnNhbWw9InVybjpvYXNpczpuYW1lczp0YzpTQU1MOjIuMD.....", - "ids" : ["4fee3b046395c4e751011e97f8900b5273d56685"] - } diff --git a/specification/security/saml_authenticate/examples/response/ResponseExample1.yaml b/specification/security/saml_authenticate/examples/response/ResponseExample1.yaml deleted file mode 100644 index 3ae3fd4e7b..0000000000 --- a/specification/security/saml_authenticate/examples/response/ResponseExample1.yaml +++ /dev/null @@ -1,12 +0,0 @@ -# summary: -description: A successful response from `POST /_security/saml/authenticate`. -# type: response -# response_code: -value: |- - { - "access_token" : "46ToAxZVaXVVZTVKOVF5YU04ZFJVUDVSZlV3", - "username" : "Bearer", - "expires_in" : 1200, - "refresh_token": "mJdXLtmvTUSpoLwMvdBt_w", - "realm": "saml1" - } diff --git a/specification/security/saml_complete_logout/examples/request/RequestExample1.yaml b/specification/security/saml_complete_logout/examples/request/RequestExample1.yaml deleted file mode 100644 index 53e8a46361..0000000000 --- a/specification/security/saml_complete_logout/examples/request/RequestExample1.yaml +++ /dev/null @@ -1,11 +0,0 @@ -summary: HTTP-Redirect binding -# method_request: POST /_security/saml/complete_logout -description: > - Run `POST /_security/saml/complete_logout` to verify the logout response sent by the SAML IdP using the HTTP-Redirect binding. -# type: request -value: |- - { - "realm": "saml1", - "ids": [ "_1c368075e0b3..." ], - "query_string": "SAMLResponse=fZHLasMwEEVbfb1bf...&SigAlg=http%3A%2F%2Fwww.w3.org%2F2000%2F09%2Fxmldsig%23rsa-sha1&Signature=CuCmFn%2BLqnaZGZJqK..." - } diff --git a/specification/security/saml_complete_logout/examples/request/RequestExample2.yaml b/specification/security/saml_complete_logout/examples/request/RequestExample2.yaml deleted file mode 100644 index 85f97bba29..0000000000 --- a/specification/security/saml_complete_logout/examples/request/RequestExample2.yaml +++ /dev/null @@ -1,11 +0,0 @@ -summary: HTTP-Post binding -# method_request: POST /_security/saml/complete_logout -description: > - Run `POST /_security/saml/complete_logout` to verify the logout response sent by the SAML IdP using the HTTP-Post binding. -# type: request -value: |- - { - "realm": "saml1", - "ids": [ "_1c368075e0b3..." ], - "content": "PHNhbWxwOkxvZ291dFJlc3BvbnNlIHhtbG5zOnNhbWxwPSJ1cm46..." - } diff --git a/specification/security/saml_invalidate/examples/request/RequestExample1.yaml b/specification/security/saml_invalidate/examples/request/RequestExample1.yaml deleted file mode 100644 index d756bef664..0000000000 --- a/specification/security/saml_invalidate/examples/request/RequestExample1.yaml +++ /dev/null @@ -1,10 +0,0 @@ -# summary: -# method_request: POST /_security/saml/invalidate -description: > - Run `POST /_security/saml/invalidate` to invalidate all the tokens for realm `saml1` pertaining to the user that is identified in the SAML Logout Request. -# type: request -value: |- - { - "query_string" : "SAMLRequest=nZFda4MwFIb%2FiuS%2BmviRpqFaClKQdbvo2g12M2KMraCJ9cRR9utnW4Wyi13sMie873MeznJ1aWrnS3VQGR0j4mLkKC1NUeljjA77zYyhVbIE0dR%2By7fmaHq7U%2BdegXWGpAZ%2B%2F4pR32luBFTAtWgUcCv56%2Fp5y30X87Yz1khTIycdgpUW9kY7WdsC9zxoXTvMvWuVV98YyMnSGH2SYE5pwALBIr9QKiwDGpW0oGVUznGeMyJZKFkQ4jBf5HnhUymjIhzCAL3KNFihbYx8TBYzzGaY7EnIyZwHzCWMfiDnbRIftkSjJr%2BFu0e9v%2B0EgOquRiiZjKpiVFp6j50T4WXoyNJ%2FEWC9fdqc1t%2F1%2B2F3aUpjzhPiXpqMz1%2FHSn4A&SigAlg=http%3A%2F%2Fwww.w3.org%2F2001%2F04%2Fxmldsig-more%23rsa-sha256&Signature=MsAYz2NFdovMG2mXf6TSpu5vlQQyEJAg%2B4KCwBqJTmrb3yGXKUtIgvjqf88eCAK32v3eN8vupjPC8LglYmke1ZnjK0%2FKxzkvSjTVA7mMQe2AQdKbkyC038zzRq%2FYHcjFDE%2Bz0qISwSHZY2NyLePmwU7SexEXnIz37jKC6NMEhus%3D", - "realm" : "saml1" - } diff --git a/specification/security/saml_invalidate/examples/response/ResponseExample1.yaml b/specification/security/saml_invalidate/examples/response/ResponseExample1.yaml deleted file mode 100644 index 2899590d6d..0000000000 --- a/specification/security/saml_invalidate/examples/response/ResponseExample1.yaml +++ /dev/null @@ -1,10 +0,0 @@ -# summary: -description: A successful response from `POST /_security/saml/invalidate`. -# type: response -# response_code: -value: |- - { - "redirect" : "https://my-idp.org/logout/SAMLResponse=....", - "invalidated" : 2, - "realm" : "saml1" - } diff --git a/specification/security/saml_logout/examples/request/RequestExample1.yaml b/specification/security/saml_logout/examples/request/RequestExample1.yaml deleted file mode 100644 index 0ded95d5bb..0000000000 --- a/specification/security/saml_logout/examples/request/RequestExample1.yaml +++ /dev/null @@ -1,10 +0,0 @@ -# summary: -# method_request: POST /_security/saml/logout -description: > - Run `POST /_security/saml/logout` to invalidate the pair of tokens that were generated by calling the SAML authenticate API with a successful SAML response. -# type: request -value: |- - { - "token" : "46ToAxZVaXVVZTVKOVF5YU04ZFJVUDVSZlV3", - "refresh_token" : "mJdXLtmvTUSpoLwMvdBt_w" - } diff --git a/specification/security/saml_logout/examples/response/ResponseExample1.yaml b/specification/security/saml_logout/examples/response/ResponseExample1.yaml deleted file mode 100644 index aeb66c7ff5..0000000000 --- a/specification/security/saml_logout/examples/response/ResponseExample1.yaml +++ /dev/null @@ -1,8 +0,0 @@ -# summary: -description: A successful response from `POST /_security/saml/logout`. -# type: response -# response_code: -value: |- - { - "redirect" : "https://my-idp.org/logout/SAMLRequest=...." - } diff --git a/specification/security/saml_prepare_authentication/examples/request/RequestExample1.yaml b/specification/security/saml_prepare_authentication/examples/request/RequestExample1.yaml deleted file mode 100644 index fbefdaf862..0000000000 --- a/specification/security/saml_prepare_authentication/examples/request/RequestExample1.yaml +++ /dev/null @@ -1,9 +0,0 @@ -summary: Prepare with a realm -# method_request: POST /_security/saml/prepare -description: > - Run `POST /_security/saml/prepare` to generate a SAML authentication request for the SAML realm named `saml1`. -# type: request -value: |- - { - "realm" : "saml1" - } diff --git a/specification/security/saml_prepare_authentication/examples/request/RequestExample2.yaml b/specification/security/saml_prepare_authentication/examples/request/RequestExample2.yaml deleted file mode 100644 index 2ca6dfe1bb..0000000000 --- a/specification/security/saml_prepare_authentication/examples/request/RequestExample2.yaml +++ /dev/null @@ -1,9 +0,0 @@ -summary: Prepare with an ACS -# method_request: POST /_security/saml/prepare -description: > - Run `POST /_security/saml/prepare` to generate a SAML authentication request for the SAML realm with an Assertion Consuming Service (ACS) URL. -# type: request -value: |- - { - "acs" : "https://kibana.org/api/security/saml/callback" - } diff --git a/specification/security/saml_prepare_authentication/examples/response/ResponseExample1.yaml b/specification/security/saml_prepare_authentication/examples/response/ResponseExample1.yaml deleted file mode 100644 index 9350f0da91..0000000000 --- a/specification/security/saml_prepare_authentication/examples/response/ResponseExample1.yaml +++ /dev/null @@ -1,10 +0,0 @@ -# summary: -description: A successful response from `POST /_security/saml/prepare`. -# type: response -# response_code: -value: |- - { - "redirect": "https://my-idp.org/login?SAMLRequest=fVJdc6IwFP0rmbwDgUKLGbFDtc462%2B06FX3Yl50rBJsKCZsbrPbXL6J22hdfk%2FNx7zl3eL%2BvK7ITBqVWCfVdRolQuS6k2iR0mU2dmN6Phgh1FTQ8be2rehH%2FWoGWdESF%2FPST0NYorgElcgW1QG5zvkh%2FPfHAZbwx2upcV5SkiMLYzmqsFba1MAthdjIXy5enhL5a23DPOyo6W7kGBa7cwhZ2gO7G8OiW%2BR400kORt0bag7fzezAlk24eqcD2OxxlsNN5O3MdsW9c6CZnbq7rntF4d3s0D7BaHTZhIWN52P%2BcjiuGRbDU6cdj%2BEjJbJLQv4N4ADdhxBiEZbQuWclY4Q8iABbCXczCdSiKMAC%2FgyO2YqbQgrIJDZg%2FcFjsMD%2Fzb3gUcBa5sR%2F9oWR%2BzuJBqlPG14Jbn0DIf2TZ3Jn%2FXmSUrC5ddQB6bob37uZrJdeF4dIDHV3iuhb70Ptq83kOz53ubDLXlcwPJK0q%2FT42AqxIaAkVCkqm2tRgr49yfJGFU%2FZQ3hy3QyuUpd7obPv97kb%2FAQ%3D%3D"}", - "realm": "saml1", - "id": "_989a34500a4f5bf0f00d195aa04a7804b4ed42a1" - } diff --git a/specification/security/saml_service_provider_metadata/examples/response/ResponseExample1.yaml b/specification/security/saml_service_provider_metadata/examples/response/ResponseExample1.yaml deleted file mode 100644 index d95c6487f9..0000000000 --- a/specification/security/saml_service_provider_metadata/examples/response/ResponseExample1.yaml +++ /dev/null @@ -1,9 +0,0 @@ -# summary: -description: > - A successful response from `POST /_security/profile/u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0/_data`, which indicates that the request is acknowledged. -# type: response -# response_code: -value: |- - { - "acknowledged": true - } diff --git a/specification/security/suggest_user_profiles/examples/request/RequestExample1.yaml b/specification/security/suggest_user_profiles/examples/request/RequestExample1.yaml deleted file mode 100644 index cf6d017092..0000000000 --- a/specification/security/suggest_user_profiles/examples/request/RequestExample1.yaml +++ /dev/null @@ -1,20 +0,0 @@ -# summary: -# method_request: POST /_security/profile/_suggest -description: > - Run `POST /_security/profile/_suggest` to get suggestions for profile documents with name-related fields matching `jack`. - It specifies both `uids` and `labels` hints for better relevance. - The `labels` hint ranks profiles higher if their `direction` label matches either `north` or `east`. -# type: request -value: |- - { - "name": "jack", - "hint": { - "uids": [ - "u_8RKO7AKfEbSiIHZkZZ2LJy2MUSDPWDr3tMI_CkIGApU_0", - "u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0" - ], - "labels": { - "direction": ["north", "east"] - } - } - } diff --git a/specification/security/suggest_user_profiles/examples/response/ResponseExample1.yaml b/specification/security/suggest_user_profiles/examples/response/ResponseExample1.yaml deleted file mode 100644 index d46fa54586..0000000000 --- a/specification/security/suggest_user_profiles/examples/response/ResponseExample1.yaml +++ /dev/null @@ -1,10 +0,0 @@ -# summary: -description: > - A successful response from `GET /_security/saml/metadata/saml1`. - It contains the SAML metadata that was generated for the SAML realm as an XML string. -# type: response -# response_code: -value: |- - { - "metadata" : "" - } diff --git a/specification/security/update_api_key/examples/request/RequestExample1.yaml b/specification/security/update_api_key/examples/request/RequestExample1.yaml deleted file mode 100644 index 36fbbdf51b..0000000000 --- a/specification/security/update_api_key/examples/request/RequestExample1.yaml +++ /dev/null @@ -1,25 +0,0 @@ -summary: Update role and metadata -# method_request: PUT /_security/api_key/VuaCfGcBCdbkQm-e5aOx -description: > - Run `PUT /_security/api_key/VuaCfGcBCdbkQm-e5aOx` to assign new role descriptors and metadata to an API key. -# type: request -value: |- - { - "role_descriptors": { - "role-a": { - "indices": [ - { - "names": ["*"], - "privileges": ["write"] - } - ] - } - }, - "metadata": { - "environment": { - "level": 2, - "trusted": true, - "tags": ["production"] - } - } - } diff --git a/specification/security/update_api_key/examples/request/RequestExample2.yaml b/specification/security/update_api_key/examples/request/RequestExample2.yaml deleted file mode 100644 index cceb7734a0..0000000000 --- a/specification/security/update_api_key/examples/request/RequestExample2.yaml +++ /dev/null @@ -1,10 +0,0 @@ -summary: Remove permissions -# method_request: PUT /_security/api_key/VuaCfGcBCdbkQm-e5aOx -description: > - Run `PUT /_security/api_key/VuaCfGcBCdbkQm-e5aOx` to remove the API key's previously assigned permissions. - It will inherit the owner user's full permissions. -# type: request -value: |- - { - "role_descriptors": {} - } diff --git a/specification/security/update_api_key/examples/response/ResponseExample1.yaml b/specification/security/update_api_key/examples/response/ResponseExample1.yaml deleted file mode 100644 index d003ec1af4..0000000000 --- a/specification/security/update_api_key/examples/response/ResponseExample1.yaml +++ /dev/null @@ -1,10 +0,0 @@ -summary: Update role and metadata -description: > - A successful response from `PUT /_security/api_key/VuaCfGcBCdbkQm-e5aOx`. - The API key's effective permissions after the update will be the intersection of the supplied role descriptors and the owner user's permissions. -# type: response -# response_code: -value: |- - { - "updated": true - } diff --git a/specification/security/update_user_profile_data/examples/request/RequestExample1.yaml b/specification/security/update_user_profile_data/examples/request/RequestExample1.yaml deleted file mode 100644 index ff7cc28f7c..0000000000 --- a/specification/security/update_user_profile_data/examples/request/RequestExample1.yaml +++ /dev/null @@ -1,16 +0,0 @@ -# summary: -# method_request: POST /_security/profile/u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0/_data -description: > - Run `POST /_security/profile/u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0/_data` to update a profile document for the `u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0` user profile. -# type: request -value: |- - { - "labels": { - "direction": "east" - }, - "data": { - "app1": { - "theme": "default" - } - } - } diff --git a/specification/security/update_user_profile_data/examples/response/ResponseExample1.yaml b/specification/security/update_user_profile_data/examples/response/ResponseExample1.yaml deleted file mode 100644 index d95c6487f9..0000000000 --- a/specification/security/update_user_profile_data/examples/response/ResponseExample1.yaml +++ /dev/null @@ -1,9 +0,0 @@ -# summary: -description: > - A successful response from `POST /_security/profile/u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0/_data`, which indicates that the request is acknowledged. -# type: response -# response_code: -value: |- - { - "acknowledged": true - } From a22f345f0c9693f9ccaf54545a789e582bd320be Mon Sep 17 00:00:00 2001 From: lcawl Date: Thu, 6 Mar 2025 19:37:30 -0800 Subject: [PATCH 3/6] Change example files to unique names --- .../MigrateToDataTiersRequestExample1.yaml | 11 ++++++ .../MigrateToDataTiersResponseExample1.yaml | 15 ++++++++ .../request/DownsampleRequestExample1.yaml | 6 ++++ .../response/CacheStatsResponseExample1.yaml | 21 +++++++++++ .../ActivateUserProfileRequestExample1.yaml | 11 ++++++ .../ActivateUserProfileResponseExample1.yaml | 25 +++++++++++++ .../EnrollKibanaResponseExample1.yaml | 12 +++++++ .../response/EnrollNodeResponseExample1.yaml | 15 ++++++++ .../GetUserProfileResponseExample1.yaml | 33 +++++++++++++++++ .../GetUserProfileResponseExample2.yaml | 36 +++++++++++++++++++ .../GetUserProfileResponseExample3.yaml | 18 ++++++++++ ...sPrivilegesUserProfileRequestExample1.yaml | 33 +++++++++++++++++ ...PrivilegesUserProfileResponseExample1.yaml | 18 ++++++++++ .../OidcAuthenticateRequestExample1.yaml | 13 +++++++ .../OidcAuthenticateResponseExample1.yaml | 13 +++++++ .../request/OidcLogoutRequestExample1.yaml | 9 +++++ .../response/OidcLogoutResponseExample1.yaml | 8 +++++ ...cPrepareAuthenticationRequestExample1.yaml | 9 +++++ ...cPrepareAuthenticationRequestExample2.yaml | 11 ++++++ ...cPrepareAuthenticationRequestExample3.yaml | 11 ++++++ ...PrepareAuthenticationResponseExample1.yaml | 13 +++++++ .../SamlAuthenticateRequestExample1.yaml | 10 ++++++ .../SamlAuthenticateResponseExample1.yaml | 12 +++++++ .../SamlCompleteLogoutRequestExample1.yaml | 11 ++++++ .../SamlCompleteLogoutRequestExample2.yaml | 11 ++++++ .../SamlInvalidateRequestExample1.yaml | 10 ++++++ .../SamlInvalidateResponseExample1.yaml | 10 ++++++ .../request/SamlLogoutRequestExample1.yaml | 10 ++++++ .../response/SamlLogoutResponseExample1.yaml | 8 +++++ ...lPrepareAuthenticationRequestExample1.yaml | 9 +++++ ...lPrepareAuthenticationRequestExample2.yaml | 9 +++++ ...PrepareAuthenticationResponseExample1.yaml | 10 ++++++ ...rviceProviderMetadataResponseExample1.yaml | 9 +++++ .../SuggestUserProfilesRequestExample1.yaml | 20 +++++++++++ .../SuggestUserProfilesResponseExample1.yaml | 10 ++++++ .../request/UpdateApiKeyRequestExample1.yaml | 25 +++++++++++++ .../request/UpdateApiKeyRequestExample2.yaml | 10 ++++++ .../UpdateApiKeyResponseExample1.yaml | 10 ++++++ .../UpdateUserProfileDataRequestExample1.yaml | 16 +++++++++ ...UpdateUserProfileDataResponseExample1.yaml | 9 +++++ 40 files changed, 560 insertions(+) create mode 100644 specification/ilm/migrate_to_data_tiers/examples/request/MigrateToDataTiersRequestExample1.yaml create mode 100644 specification/ilm/migrate_to_data_tiers/examples/response/MigrateToDataTiersResponseExample1.yaml create mode 100644 specification/indices/downsample/examples/request/DownsampleRequestExample1.yaml create mode 100644 specification/searchable_snapshots/cache_stats/examples/response/CacheStatsResponseExample1.yaml create mode 100644 specification/security/activate_user_profile/examples/request/ActivateUserProfileRequestExample1.yaml create mode 100644 specification/security/activate_user_profile/examples/response/ActivateUserProfileResponseExample1.yaml create mode 100644 specification/security/enroll_kibana/examples/response/EnrollKibanaResponseExample1.yaml create mode 100644 specification/security/enroll_node/examples/response/EnrollNodeResponseExample1.yaml create mode 100644 specification/security/get_user_profile/examples/response/GetUserProfileResponseExample1.yaml create mode 100644 specification/security/get_user_profile/examples/response/GetUserProfileResponseExample2.yaml create mode 100644 specification/security/get_user_profile/examples/response/GetUserProfileResponseExample3.yaml create mode 100644 specification/security/has_privileges_user_profile/examples/request/HasPrivilegesUserProfileRequestExample1.yaml create mode 100644 specification/security/has_privileges_user_profile/examples/response/HasPrivilegesUserProfileResponseExample1.yaml create mode 100644 specification/security/oidc_authenticate/examples/request/OidcAuthenticateRequestExample1.yaml create mode 100644 specification/security/oidc_authenticate/examples/response/OidcAuthenticateResponseExample1.yaml create mode 100644 specification/security/oidc_logout/examples/request/OidcLogoutRequestExample1.yaml create mode 100644 specification/security/oidc_logout/examples/response/OidcLogoutResponseExample1.yaml create mode 100644 specification/security/oidc_prepare_authentication/examples/request/OidcPrepareAuthenticationRequestExample1.yaml create mode 100644 specification/security/oidc_prepare_authentication/examples/request/OidcPrepareAuthenticationRequestExample2.yaml create mode 100644 specification/security/oidc_prepare_authentication/examples/request/OidcPrepareAuthenticationRequestExample3.yaml create mode 100644 specification/security/oidc_prepare_authentication/examples/response/OidcPrepareAuthenticationResponseExample1.yaml create mode 100644 specification/security/saml_authenticate/examples/request/SamlAuthenticateRequestExample1.yaml create mode 100644 specification/security/saml_authenticate/examples/response/SamlAuthenticateResponseExample1.yaml create mode 100644 specification/security/saml_complete_logout/examples/request/SamlCompleteLogoutRequestExample1.yaml create mode 100644 specification/security/saml_complete_logout/examples/request/SamlCompleteLogoutRequestExample2.yaml create mode 100644 specification/security/saml_invalidate/examples/request/SamlInvalidateRequestExample1.yaml create mode 100644 specification/security/saml_invalidate/examples/response/SamlInvalidateResponseExample1.yaml create mode 100644 specification/security/saml_logout/examples/request/SamlLogoutRequestExample1.yaml create mode 100644 specification/security/saml_logout/examples/response/SamlLogoutResponseExample1.yaml create mode 100644 specification/security/saml_prepare_authentication/examples/request/SamlPrepareAuthenticationRequestExample1.yaml create mode 100644 specification/security/saml_prepare_authentication/examples/request/SamlPrepareAuthenticationRequestExample2.yaml create mode 100644 specification/security/saml_prepare_authentication/examples/response/SAmlPrepareAuthenticationResponseExample1.yaml create mode 100644 specification/security/saml_service_provider_metadata/examples/response/SamlServiceProviderMetadataResponseExample1.yaml create mode 100644 specification/security/suggest_user_profiles/examples/request/SuggestUserProfilesRequestExample1.yaml create mode 100644 specification/security/suggest_user_profiles/examples/response/SuggestUserProfilesResponseExample1.yaml create mode 100644 specification/security/update_api_key/examples/request/UpdateApiKeyRequestExample1.yaml create mode 100644 specification/security/update_api_key/examples/request/UpdateApiKeyRequestExample2.yaml create mode 100644 specification/security/update_api_key/examples/response/UpdateApiKeyResponseExample1.yaml create mode 100644 specification/security/update_user_profile_data/examples/request/UpdateUserProfileDataRequestExample1.yaml create mode 100644 specification/security/update_user_profile_data/examples/response/UpdateUserProfileDataResponseExample1.yaml diff --git a/specification/ilm/migrate_to_data_tiers/examples/request/MigrateToDataTiersRequestExample1.yaml b/specification/ilm/migrate_to_data_tiers/examples/request/MigrateToDataTiersRequestExample1.yaml new file mode 100644 index 0000000000..bba220818a --- /dev/null +++ b/specification/ilm/migrate_to_data_tiers/examples/request/MigrateToDataTiersRequestExample1.yaml @@ -0,0 +1,11 @@ +# summary: 'Migrates indices, ILM policies, and templates from using custom node attributes to using data tiers.' +# method_request: POST /_ilm/migrate_to_data_tiers +description: > + Run `POST /_ilm/migrate_to_data_tiers` to migrate the indices, ILM policies, legacy templates, composable, and component templates away from defining custom allocation filtering using the `custom_attribute_name` node attribute. + It also deletes the legacy template with name `global-template` if it exists in the system. +# type: request +value: |- + { + "legacy_template_to_delete": "global-template", + "node_attribute": "custom_attribute_name" + } diff --git a/specification/ilm/migrate_to_data_tiers/examples/response/MigrateToDataTiersResponseExample1.yaml b/specification/ilm/migrate_to_data_tiers/examples/response/MigrateToDataTiersResponseExample1.yaml new file mode 100644 index 0000000000..97f3c6acdc --- /dev/null +++ b/specification/ilm/migrate_to_data_tiers/examples/response/MigrateToDataTiersResponseExample1.yaml @@ -0,0 +1,15 @@ +# summary: +description: > + A successful response when migrating indices, ILMs, and templates from custom node attributes to data tiers. +# type: response +# response_code: 200 +value: |- + { + "dry_run": false, + "removed_legacy_template":"global-template", + "migrated_ilm_policies":["policy_with_allocate_action"], + "migrated_indices":["warm-index-to-migrate-000001"], + "migrated_legacy_templates":["a-legacy-template"], + "migrated_composable_templates":["a-composable-template"], + "migrated_component_templates":["a-component-template"] + } diff --git a/specification/indices/downsample/examples/request/DownsampleRequestExample1.yaml b/specification/indices/downsample/examples/request/DownsampleRequestExample1.yaml new file mode 100644 index 0000000000..9fb58afbac --- /dev/null +++ b/specification/indices/downsample/examples/request/DownsampleRequestExample1.yaml @@ -0,0 +1,6 @@ +# summary: +# method_request: POST /my-time-series-index/_downsample/my-downsampled-time-series-index +# description: '' +# type: request +value: + fixed_interval: 1d diff --git a/specification/searchable_snapshots/cache_stats/examples/response/CacheStatsResponseExample1.yaml b/specification/searchable_snapshots/cache_stats/examples/response/CacheStatsResponseExample1.yaml new file mode 100644 index 0000000000..fac5613207 --- /dev/null +++ b/specification/searchable_snapshots/cache_stats/examples/response/CacheStatsResponseExample1.yaml @@ -0,0 +1,21 @@ +# summary: +description: A successful response from `GET /_searchable_snapshots/cache/stats`. +# type: response +# response_code: 200 +value: |- + { + "nodes" : { + "eerrtBMtQEisohZzxBLUSw" : { + "shared_cache" : { + "reads" : 6051, + "bytes_read_in_bytes" : 5448829, + "writes" : 37, + "bytes_written_in_bytes" : 1208320, + "evictions" : 5, + "num_regions" : 65536, + "size_in_bytes" : 1099511627776, + "region_size_in_bytes" : 16777216 + } + } + } + } diff --git a/specification/security/activate_user_profile/examples/request/ActivateUserProfileRequestExample1.yaml b/specification/security/activate_user_profile/examples/request/ActivateUserProfileRequestExample1.yaml new file mode 100644 index 0000000000..c7a0baf0af --- /dev/null +++ b/specification/security/activate_user_profile/examples/request/ActivateUserProfileRequestExample1.yaml @@ -0,0 +1,11 @@ +# summary: +# method_request: POST /_security/profile/_activate +description: > + Run `POST /_security/profile/_activate` to activate a user profile. +# type: request +value: |- + { + "grant_type": "password", + "username" : "jacknich", + "password" : "l0ng-r4nd0m-p@ssw0rd" + } diff --git a/specification/security/activate_user_profile/examples/response/ActivateUserProfileResponseExample1.yaml b/specification/security/activate_user_profile/examples/response/ActivateUserProfileResponseExample1.yaml new file mode 100644 index 0000000000..f2d0e5b456 --- /dev/null +++ b/specification/security/activate_user_profile/examples/response/ActivateUserProfileResponseExample1.yaml @@ -0,0 +1,25 @@ +# summary: +description: A successful response from `POST /_security/profile/_activate`. +# type: response +# response_code: +value: |- + { + "uid": "u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0", + "enabled": true, + "last_synchronized": 1642650651037, + "user": { + "username": "jacknich", + "roles": [ + "admin", "other_role1" + ], + "realm_name": "native", + "full_name": "Jack Nicholson", + "email": "jacknich@example.com" + }, + "labels": {}, + "data": {}, + "_doc": { + "_primary_term": 88, + "_seq_no": 66 + } + } diff --git a/specification/security/enroll_kibana/examples/response/EnrollKibanaResponseExample1.yaml b/specification/security/enroll_kibana/examples/response/EnrollKibanaResponseExample1.yaml new file mode 100644 index 0000000000..db74d609c4 --- /dev/null +++ b/specification/security/enroll_kibana/examples/response/EnrollKibanaResponseExample1.yaml @@ -0,0 +1,12 @@ +# summary: +description: A successful response from `GET /_security/enroll/kibana`. +# type: response +# response_code: +value: |- + { + "token" : { + "name" : "enroll-process-token-1629123923000", + "value": "AAEAAWVsYXN0aWM...vZmxlZXQtc2VydmVyL3Rva2VuMTo3TFdaSDZ" + }, + "http_ca" : "MIIJlAIBAzVoGCSqGSIb3...vsDfsA3UZBAjEPfhubpQysAICAA=", + } diff --git a/specification/security/enroll_node/examples/response/EnrollNodeResponseExample1.yaml b/specification/security/enroll_node/examples/response/EnrollNodeResponseExample1.yaml new file mode 100644 index 0000000000..081db7c106 --- /dev/null +++ b/specification/security/enroll_node/examples/response/EnrollNodeResponseExample1.yaml @@ -0,0 +1,15 @@ +# summary: +description: A successful response from `PGET /security/enroll/node`. +# type: response +# response_code: +value: |- + { + "http_ca_key" : "MIIJlAIBAzCCCVoGCSqGSIb3DQEHAaCCCUsEgglHMIIJQzCCA98GCSqGSIb3DQ....vsDfsA3UZBAjEPfhubpQysAICCAA=", + "http_ca_cert" : "MIIJlAIBAzCCCVoGCSqGSIb3DQEHAaCCCUsEgglHMIIJQzCCA98GCSqGSIb3DQ....vsDfsA3UZBAjEPfhubpQysAICCAA=", + "transport_ca_cert" : "MIIJlAIBAzCCCVoGCSqGSIb3DQEHAaCCCUsEgglHMIIJQzCCA98GCSqG....vsDfsA3UZBAjEPfhubpQysAICCAA=", + "transport_key" : "MIIEJgIBAzCCA98GCSqGSIb3DQEHAaCCA9AEggPMMIIDyDCCA8QGCSqGSIb3....YuEiOXvqZ6jxuVSQ0CAwGGoA==", + "transport_cert" : "MIIEJgIBAzCCA98GCSqGSIb3DQEHAaCCA9AEggPMMIIDyDCCA8QGCSqGSIb3....YuEiOXvqZ6jxuVSQ0CAwGGoA==", + "nodes_addresses" : [ + "192.168.1.2:9300" + ] + } diff --git a/specification/security/get_user_profile/examples/response/GetUserProfileResponseExample1.yaml b/specification/security/get_user_profile/examples/response/GetUserProfileResponseExample1.yaml new file mode 100644 index 0000000000..842575afb4 --- /dev/null +++ b/specification/security/get_user_profile/examples/response/GetUserProfileResponseExample1.yaml @@ -0,0 +1,33 @@ +summary: Profile details for a UUID +description: > + A successful response from `GET /_security/profile/u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0`. + By default, no content is returned in the `data` field. +# type: response +# response_code: +value: |- + { + "profiles": [ + { + "uid": "u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0", + "enabled": true, + "last_synchronized": 1642650651037, + "user": { + "username": "jacknich", + "roles": [ + "admin", "other_role1" + ], + "realm_name": "native", + "full_name": "Jack Nicholson", + "email": "jacknich@example.com" + }, + "labels": { + "direction": "north" + }, + "data": {}, + "_doc": { + "_primary_term": 88, + "_seq_no": 66 + } + } + ] + } diff --git a/specification/security/get_user_profile/examples/response/GetUserProfileResponseExample2.yaml b/specification/security/get_user_profile/examples/response/GetUserProfileResponseExample2.yaml new file mode 100644 index 0000000000..55c31797c4 --- /dev/null +++ b/specification/security/get_user_profile/examples/response/GetUserProfileResponseExample2.yaml @@ -0,0 +1,36 @@ +summary: Profile details for a UUID and data key +description: > + A successful response from `GET /_security/profile/u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0?data=app1.key1`. +# type: response +# response_code: +value: |- + { + "profiles": [ + { + "uid": "u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0", + "enabled": true, + "last_synchronized": 1642650651037, + "user": { + "username": "jacknich", + "roles": [ + "admin", "other_role1" + ], + "realm_name": "native", + "full_name": "Jack Nicholson", + "email": "jacknich@example.com" + }, + "labels": { + "direction": "north" + }, + "data": { + "app1": { + "key1": "value1" + } + }, + "_doc": { + "_primary_term": 88, + "_seq_no": 66 + } + } + ] + } diff --git a/specification/security/get_user_profile/examples/response/GetUserProfileResponseExample3.yaml b/specification/security/get_user_profile/examples/response/GetUserProfileResponseExample3.yaml new file mode 100644 index 0000000000..e263a8476c --- /dev/null +++ b/specification/security/get_user_profile/examples/response/GetUserProfileResponseExample3.yaml @@ -0,0 +1,18 @@ +summary: Profile details with errors +description: > + A response that contains errors that occurred while retrieving user profiles. +# type: response +# response_code: +value: |- + { + "profiles": [], + "errors": { + "count": 1, + "details": { + "u_FmxQt3gr1BBH5wpnz9HkouPj3Q710XkOgg1PWkwLPBW_5": { + "type": "resource_not_found_exception", + "reason": "profile document not found" + } + } + } + } diff --git a/specification/security/has_privileges_user_profile/examples/request/HasPrivilegesUserProfileRequestExample1.yaml b/specification/security/has_privileges_user_profile/examples/request/HasPrivilegesUserProfileRequestExample1.yaml new file mode 100644 index 0000000000..aed6d5b4dc --- /dev/null +++ b/specification/security/has_privileges_user_profile/examples/request/HasPrivilegesUserProfileRequestExample1.yaml @@ -0,0 +1,33 @@ +# summary: +# method_request: POST /_security/profile/_has_privileges +description: > + Run `POST /_security/profile/_has_privileges` to check whether the two users associated with the specified profiles have all the requested set of cluster, index, and application privileges. +# type: request +value: |- + { + "uids": [ + "u_LQPnxDxEjIH0GOUoFkZr5Y57YUwSkL9Joiq-g4OCbPc_0", + "u_rzRnxDgEHIH0GOUoFkZr5Y27YUwSk19Joiq=g4OCxxB_1", + "u_does-not-exist_0" + ], + "privileges": { + "cluster": [ "monitor", "create_snapshot", "manage_ml" ], + "index" : [ + { + "names": [ "suppliers", "products" ], + "privileges": [ "create_doc"] + }, + { + "names": [ "inventory" ], + "privileges" : [ "read", "write" ] + } + ], + "application": [ + { + "application": "inventory_manager", + "privileges" : [ "read", "data:write/inventory" ], + "resources" : [ "product/1852563" ] + } + ] + } + } diff --git a/specification/security/has_privileges_user_profile/examples/response/HasPrivilegesUserProfileResponseExample1.yaml b/specification/security/has_privileges_user_profile/examples/response/HasPrivilegesUserProfileResponseExample1.yaml new file mode 100644 index 0000000000..1d8a647fbd --- /dev/null +++ b/specification/security/has_privileges_user_profile/examples/response/HasPrivilegesUserProfileResponseExample1.yaml @@ -0,0 +1,18 @@ +# summary: +description: > + A response from `POST /_security/profile/_has_privileges` that indicates only one of the three users has all the privileges and one of them is not found. +# type: response +# response_code: +value: |- + { + "has_privilege_uids": ["u_rzRnxDgEHIH0GOUoFkZr5Y27YUwSk19Joiq=g4OCxxB_1"], + "errors": { + "count": 1, + "details": { + "u_does-not-exist_0": { + "type": "resource_not_found_exception", + "reason": "profile document not found" + } + } + } + } diff --git a/specification/security/oidc_authenticate/examples/request/OidcAuthenticateRequestExample1.yaml b/specification/security/oidc_authenticate/examples/request/OidcAuthenticateRequestExample1.yaml new file mode 100644 index 0000000000..a7c3169c96 --- /dev/null +++ b/specification/security/oidc_authenticate/examples/request/OidcAuthenticateRequestExample1.yaml @@ -0,0 +1,13 @@ +# summary: +# method_request: POST /_security/oidc/authenticate +description: > + Run `POST /_security/oidc/authenticate` to exchange the response that was returned from the OpenID Connect Provider after a successful authentication for an Elasticsearch access token and refresh token. + This example is from an authentication that uses the authorization code grant flow. +# type: request +value: |- + { + "redirect_uri" : "https://oidc-kibana.elastic.co:5603/api/security/oidc/callback?code=jtI3Ntt8v3_XvcLzCFGq&state=4dbrihtIAt3wBTwo6DxK-vdk-sSyDBV8Yf0AjdkdT5I", + "state" : "4dbrihtIAt3wBTwo6DxK-vdk-sSyDBV8Yf0AjdkdT5I", + "nonce" : "WaBPH0KqPVdG5HHdSxPRjfoZbXMCicm5v1OiAj0DUFM", + "realm" : "oidc1" + } diff --git a/specification/security/oidc_authenticate/examples/response/OidcAuthenticateResponseExample1.yaml b/specification/security/oidc_authenticate/examples/response/OidcAuthenticateResponseExample1.yaml new file mode 100644 index 0000000000..03f05a48e6 --- /dev/null +++ b/specification/security/oidc_authenticate/examples/response/OidcAuthenticateResponseExample1.yaml @@ -0,0 +1,13 @@ +# summary: +description: > + A successful response from `POST /_security/oidc/authenticate`. + It contains the access and refresh tokens that were generated, the token duration (in seconds), and the type. +# type: response +# response_code: +value: |- + { + "access_token" : "dGhpcyBpcyBub3QgYSByZWFsIHRva2VuIGJ1dCBpdCBpcyBvbmx5IHRlc3QgZGF0YS4gZG8gbm90IHRyeSB0byByZWFkIHRva2VuIQ==", + "type" : "Bearer", + "expires_in" : 1200, + "refresh_token": "vLBPvmAB6KvwvJZr27cS" + } diff --git a/specification/security/oidc_logout/examples/request/OidcLogoutRequestExample1.yaml b/specification/security/oidc_logout/examples/request/OidcLogoutRequestExample1.yaml new file mode 100644 index 0000000000..1e6dcd7a27 --- /dev/null +++ b/specification/security/oidc_logout/examples/request/OidcLogoutRequestExample1.yaml @@ -0,0 +1,9 @@ +# summary: +# method_request: POST /_security/oidc/logout +description: Run `POST /_security/oidc/logout` to perform the logout. +# type: request +value: |- + { + "token" : "dGhpcyBpcyBub3QgYSByZWFsIHRva2VuIGJ1dCBpdCBpcyBvbmx5IHRlc3QgZGF0YS4gZG8gbm90IHRyeSB0byByZWFkIHRva2VuIQ==", + "refresh_token": "vLBPvmAB6KvwvJZr27cS" + } diff --git a/specification/security/oidc_logout/examples/response/OidcLogoutResponseExample1.yaml b/specification/security/oidc_logout/examples/response/OidcLogoutResponseExample1.yaml new file mode 100644 index 0000000000..763a5d32b0 --- /dev/null +++ b/specification/security/oidc_logout/examples/response/OidcLogoutResponseExample1.yaml @@ -0,0 +1,8 @@ +# summary: +description: A successful response from `POST /_security/oidc/logout`, which contains the URI pointing to the End Session Endpoint of the OpenID Connect Provider with all the parameters of the Logout Request as HTTP GET parameters. +# type: response +# response_code: +value: |- + { + "redirect" : "https://op-provider.org/logout?id_token_hint=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c&post_logout_redirect_uri=http%3A%2F%2Foidc-kibana.elastic.co%2Floggedout&state=lGYK0EcSLjqH6pkT5EVZjC6eIW5YCGgywj2sxROO" + } diff --git a/specification/security/oidc_prepare_authentication/examples/request/OidcPrepareAuthenticationRequestExample1.yaml b/specification/security/oidc_prepare_authentication/examples/request/OidcPrepareAuthenticationRequestExample1.yaml new file mode 100644 index 0000000000..d3e5f77a2e --- /dev/null +++ b/specification/security/oidc_prepare_authentication/examples/request/OidcPrepareAuthenticationRequestExample1.yaml @@ -0,0 +1,9 @@ +summary: Prepare with realm +# method_request: POST /_security/oidc/prepare +description: > + Run `POST /_security/oidc/prepare` to generate an authentication request for the OpenID Connect Realm `oidc1`. +# type: request +value: |- + { + "realm" : "oidc1" + } diff --git a/specification/security/oidc_prepare_authentication/examples/request/OidcPrepareAuthenticationRequestExample2.yaml b/specification/security/oidc_prepare_authentication/examples/request/OidcPrepareAuthenticationRequestExample2.yaml new file mode 100644 index 0000000000..864c364f12 --- /dev/null +++ b/specification/security/oidc_prepare_authentication/examples/request/OidcPrepareAuthenticationRequestExample2.yaml @@ -0,0 +1,11 @@ +summary: Prepare with realm, state, and nonce +# method_request: POST /_security/oidc/prepare +description: > + Run `POST /_security/oidc/prepare` to generate an authentication request for the OpenID Connect Realm `oidc1`, where the values for the `state` and the `nonce` have been generated by the client. +# type: request +value: |- + { + "realm" : "oidc1", + "state" : "lGYK0EcSLjqH6pkT5EVZjC6eIW5YCGgywj2sxROO", + "nonce" : "zOBXLJGUooRrbLbQk5YCcyC8AXw3iloynvluYhZ5" + } diff --git a/specification/security/oidc_prepare_authentication/examples/request/OidcPrepareAuthenticationRequestExample3.yaml b/specification/security/oidc_prepare_authentication/examples/request/OidcPrepareAuthenticationRequestExample3.yaml new file mode 100644 index 0000000000..e035d15357 --- /dev/null +++ b/specification/security/oidc_prepare_authentication/examples/request/OidcPrepareAuthenticationRequestExample3.yaml @@ -0,0 +1,11 @@ +summary: Prepare by realm +# method_request: POST /_security/oidc/prepare +description: > + Run `POST /_security/oidc/prepare` to generate an authentication request for a third party initiated single sign on. + Specify the issuer that should be used for matching the appropriate OpenID Connect Authentication realm. +# type: request +value: |- + { + "iss" : "http://127.0.0.1:8080", + "login_hint": "this_is_an_opaque_string" + } diff --git a/specification/security/oidc_prepare_authentication/examples/response/OidcPrepareAuthenticationResponseExample1.yaml b/specification/security/oidc_prepare_authentication/examples/response/OidcPrepareAuthenticationResponseExample1.yaml new file mode 100644 index 0000000000..d45d2faba5 --- /dev/null +++ b/specification/security/oidc_prepare_authentication/examples/response/OidcPrepareAuthenticationResponseExample1.yaml @@ -0,0 +1,13 @@ +# summary: +description: > + A successful response from `POST /_security/oidc/prepare`. + It contains the URI pointing to the Authorization Endpoint of the OpenID Connect Provider with all the parameters of the Authentication Request as HTTP GET parameters. +# type: response +# response_code: +value: |- + { + "redirect" : "http://127.0.0.1:8080/c2id-login?scope=openid&response_type=id_token&redirect_uri=https%3A%2F%2Fmy.fantastic.rp%2Fcb&state=4dbrihtIAt3wBTwo6DxK-vdk-sSyDBV8Yf0AjdkdT5I&nonce=WaBPH0KqPVdG5HHdSxPRjfoZbXMCicm5v1OiAj0DUFM&client_id=elasticsearch-rp", + "state" : "4dbrihtIAt3wBTwo6DxK-vdk-sSyDBV8Yf0AjdkdT5I", + "nonce" : "WaBPH0KqPVdG5HHdSxPRjfoZbXMCicm5v1OiAj0DUFM", + "realm" : "oidc1" + } diff --git a/specification/security/saml_authenticate/examples/request/SamlAuthenticateRequestExample1.yaml b/specification/security/saml_authenticate/examples/request/SamlAuthenticateRequestExample1.yaml new file mode 100644 index 0000000000..ef77f13e2f --- /dev/null +++ b/specification/security/saml_authenticate/examples/request/SamlAuthenticateRequestExample1.yaml @@ -0,0 +1,10 @@ +# summary: +# method_request: POST /_security/saml/authenticate +description: > + Run `POST /_security/saml/authenticate` to exchange a SAML Response indicating a successful authentication at the SAML IdP for an Elasticsearch access token and refresh token to be used in subsequent requests. +# type: request +value: |- + { + "content" : "PHNhbWxwOlJlc3BvbnNlIHhtbG5zOnNhbWxwPSJ1cm46b2FzaXM6bmFtZXM6dGM6U0FNTDoyLjA6cHJvdG9jb2wiIHhtbG5zOnNhbWw9InVybjpvYXNpczpuYW1lczp0YzpTQU1MOjIuMD.....", + "ids" : ["4fee3b046395c4e751011e97f8900b5273d56685"] + } diff --git a/specification/security/saml_authenticate/examples/response/SamlAuthenticateResponseExample1.yaml b/specification/security/saml_authenticate/examples/response/SamlAuthenticateResponseExample1.yaml new file mode 100644 index 0000000000..3ae3fd4e7b --- /dev/null +++ b/specification/security/saml_authenticate/examples/response/SamlAuthenticateResponseExample1.yaml @@ -0,0 +1,12 @@ +# summary: +description: A successful response from `POST /_security/saml/authenticate`. +# type: response +# response_code: +value: |- + { + "access_token" : "46ToAxZVaXVVZTVKOVF5YU04ZFJVUDVSZlV3", + "username" : "Bearer", + "expires_in" : 1200, + "refresh_token": "mJdXLtmvTUSpoLwMvdBt_w", + "realm": "saml1" + } diff --git a/specification/security/saml_complete_logout/examples/request/SamlCompleteLogoutRequestExample1.yaml b/specification/security/saml_complete_logout/examples/request/SamlCompleteLogoutRequestExample1.yaml new file mode 100644 index 0000000000..53e8a46361 --- /dev/null +++ b/specification/security/saml_complete_logout/examples/request/SamlCompleteLogoutRequestExample1.yaml @@ -0,0 +1,11 @@ +summary: HTTP-Redirect binding +# method_request: POST /_security/saml/complete_logout +description: > + Run `POST /_security/saml/complete_logout` to verify the logout response sent by the SAML IdP using the HTTP-Redirect binding. +# type: request +value: |- + { + "realm": "saml1", + "ids": [ "_1c368075e0b3..." ], + "query_string": "SAMLResponse=fZHLasMwEEVbfb1bf...&SigAlg=http%3A%2F%2Fwww.w3.org%2F2000%2F09%2Fxmldsig%23rsa-sha1&Signature=CuCmFn%2BLqnaZGZJqK..." + } diff --git a/specification/security/saml_complete_logout/examples/request/SamlCompleteLogoutRequestExample2.yaml b/specification/security/saml_complete_logout/examples/request/SamlCompleteLogoutRequestExample2.yaml new file mode 100644 index 0000000000..85f97bba29 --- /dev/null +++ b/specification/security/saml_complete_logout/examples/request/SamlCompleteLogoutRequestExample2.yaml @@ -0,0 +1,11 @@ +summary: HTTP-Post binding +# method_request: POST /_security/saml/complete_logout +description: > + Run `POST /_security/saml/complete_logout` to verify the logout response sent by the SAML IdP using the HTTP-Post binding. +# type: request +value: |- + { + "realm": "saml1", + "ids": [ "_1c368075e0b3..." ], + "content": "PHNhbWxwOkxvZ291dFJlc3BvbnNlIHhtbG5zOnNhbWxwPSJ1cm46..." + } diff --git a/specification/security/saml_invalidate/examples/request/SamlInvalidateRequestExample1.yaml b/specification/security/saml_invalidate/examples/request/SamlInvalidateRequestExample1.yaml new file mode 100644 index 0000000000..d756bef664 --- /dev/null +++ b/specification/security/saml_invalidate/examples/request/SamlInvalidateRequestExample1.yaml @@ -0,0 +1,10 @@ +# summary: +# method_request: POST /_security/saml/invalidate +description: > + Run `POST /_security/saml/invalidate` to invalidate all the tokens for realm `saml1` pertaining to the user that is identified in the SAML Logout Request. +# type: request +value: |- + { + "query_string" : "SAMLRequest=nZFda4MwFIb%2FiuS%2BmviRpqFaClKQdbvo2g12M2KMraCJ9cRR9utnW4Wyi13sMie873MeznJ1aWrnS3VQGR0j4mLkKC1NUeljjA77zYyhVbIE0dR%2By7fmaHq7U%2BdegXWGpAZ%2B%2F4pR32luBFTAtWgUcCv56%2Fp5y30X87Yz1khTIycdgpUW9kY7WdsC9zxoXTvMvWuVV98YyMnSGH2SYE5pwALBIr9QKiwDGpW0oGVUznGeMyJZKFkQ4jBf5HnhUymjIhzCAL3KNFihbYx8TBYzzGaY7EnIyZwHzCWMfiDnbRIftkSjJr%2BFu0e9v%2B0EgOquRiiZjKpiVFp6j50T4WXoyNJ%2FEWC9fdqc1t%2F1%2B2F3aUpjzhPiXpqMz1%2FHSn4A&SigAlg=http%3A%2F%2Fwww.w3.org%2F2001%2F04%2Fxmldsig-more%23rsa-sha256&Signature=MsAYz2NFdovMG2mXf6TSpu5vlQQyEJAg%2B4KCwBqJTmrb3yGXKUtIgvjqf88eCAK32v3eN8vupjPC8LglYmke1ZnjK0%2FKxzkvSjTVA7mMQe2AQdKbkyC038zzRq%2FYHcjFDE%2Bz0qISwSHZY2NyLePmwU7SexEXnIz37jKC6NMEhus%3D", + "realm" : "saml1" + } diff --git a/specification/security/saml_invalidate/examples/response/SamlInvalidateResponseExample1.yaml b/specification/security/saml_invalidate/examples/response/SamlInvalidateResponseExample1.yaml new file mode 100644 index 0000000000..2899590d6d --- /dev/null +++ b/specification/security/saml_invalidate/examples/response/SamlInvalidateResponseExample1.yaml @@ -0,0 +1,10 @@ +# summary: +description: A successful response from `POST /_security/saml/invalidate`. +# type: response +# response_code: +value: |- + { + "redirect" : "https://my-idp.org/logout/SAMLResponse=....", + "invalidated" : 2, + "realm" : "saml1" + } diff --git a/specification/security/saml_logout/examples/request/SamlLogoutRequestExample1.yaml b/specification/security/saml_logout/examples/request/SamlLogoutRequestExample1.yaml new file mode 100644 index 0000000000..0ded95d5bb --- /dev/null +++ b/specification/security/saml_logout/examples/request/SamlLogoutRequestExample1.yaml @@ -0,0 +1,10 @@ +# summary: +# method_request: POST /_security/saml/logout +description: > + Run `POST /_security/saml/logout` to invalidate the pair of tokens that were generated by calling the SAML authenticate API with a successful SAML response. +# type: request +value: |- + { + "token" : "46ToAxZVaXVVZTVKOVF5YU04ZFJVUDVSZlV3", + "refresh_token" : "mJdXLtmvTUSpoLwMvdBt_w" + } diff --git a/specification/security/saml_logout/examples/response/SamlLogoutResponseExample1.yaml b/specification/security/saml_logout/examples/response/SamlLogoutResponseExample1.yaml new file mode 100644 index 0000000000..aeb66c7ff5 --- /dev/null +++ b/specification/security/saml_logout/examples/response/SamlLogoutResponseExample1.yaml @@ -0,0 +1,8 @@ +# summary: +description: A successful response from `POST /_security/saml/logout`. +# type: response +# response_code: +value: |- + { + "redirect" : "https://my-idp.org/logout/SAMLRequest=...." + } diff --git a/specification/security/saml_prepare_authentication/examples/request/SamlPrepareAuthenticationRequestExample1.yaml b/specification/security/saml_prepare_authentication/examples/request/SamlPrepareAuthenticationRequestExample1.yaml new file mode 100644 index 0000000000..fbefdaf862 --- /dev/null +++ b/specification/security/saml_prepare_authentication/examples/request/SamlPrepareAuthenticationRequestExample1.yaml @@ -0,0 +1,9 @@ +summary: Prepare with a realm +# method_request: POST /_security/saml/prepare +description: > + Run `POST /_security/saml/prepare` to generate a SAML authentication request for the SAML realm named `saml1`. +# type: request +value: |- + { + "realm" : "saml1" + } diff --git a/specification/security/saml_prepare_authentication/examples/request/SamlPrepareAuthenticationRequestExample2.yaml b/specification/security/saml_prepare_authentication/examples/request/SamlPrepareAuthenticationRequestExample2.yaml new file mode 100644 index 0000000000..2ca6dfe1bb --- /dev/null +++ b/specification/security/saml_prepare_authentication/examples/request/SamlPrepareAuthenticationRequestExample2.yaml @@ -0,0 +1,9 @@ +summary: Prepare with an ACS +# method_request: POST /_security/saml/prepare +description: > + Run `POST /_security/saml/prepare` to generate a SAML authentication request for the SAML realm with an Assertion Consuming Service (ACS) URL. +# type: request +value: |- + { + "acs" : "https://kibana.org/api/security/saml/callback" + } diff --git a/specification/security/saml_prepare_authentication/examples/response/SAmlPrepareAuthenticationResponseExample1.yaml b/specification/security/saml_prepare_authentication/examples/response/SAmlPrepareAuthenticationResponseExample1.yaml new file mode 100644 index 0000000000..9350f0da91 --- /dev/null +++ b/specification/security/saml_prepare_authentication/examples/response/SAmlPrepareAuthenticationResponseExample1.yaml @@ -0,0 +1,10 @@ +# summary: +description: A successful response from `POST /_security/saml/prepare`. +# type: response +# response_code: +value: |- + { + "redirect": "https://my-idp.org/login?SAMLRequest=fVJdc6IwFP0rmbwDgUKLGbFDtc462%2B06FX3Yl50rBJsKCZsbrPbXL6J22hdfk%2FNx7zl3eL%2BvK7ITBqVWCfVdRolQuS6k2iR0mU2dmN6Phgh1FTQ8be2rehH%2FWoGWdESF%2FPST0NYorgElcgW1QG5zvkh%2FPfHAZbwx2upcV5SkiMLYzmqsFba1MAthdjIXy5enhL5a23DPOyo6W7kGBa7cwhZ2gO7G8OiW%2BR400kORt0bag7fzezAlk24eqcD2OxxlsNN5O3MdsW9c6CZnbq7rntF4d3s0D7BaHTZhIWN52P%2BcjiuGRbDU6cdj%2BEjJbJLQv4N4ADdhxBiEZbQuWclY4Q8iABbCXczCdSiKMAC%2FgyO2YqbQgrIJDZg%2FcFjsMD%2Fzb3gUcBa5sR%2F9oWR%2BzuJBqlPG14Jbn0DIf2TZ3Jn%2FXmSUrC5ddQB6bob37uZrJdeF4dIDHV3iuhb70Ptq83kOz53ubDLXlcwPJK0q%2FT42AqxIaAkVCkqm2tRgr49yfJGFU%2FZQ3hy3QyuUpd7obPv97kb%2FAQ%3D%3D"}", + "realm": "saml1", + "id": "_989a34500a4f5bf0f00d195aa04a7804b4ed42a1" + } diff --git a/specification/security/saml_service_provider_metadata/examples/response/SamlServiceProviderMetadataResponseExample1.yaml b/specification/security/saml_service_provider_metadata/examples/response/SamlServiceProviderMetadataResponseExample1.yaml new file mode 100644 index 0000000000..d95c6487f9 --- /dev/null +++ b/specification/security/saml_service_provider_metadata/examples/response/SamlServiceProviderMetadataResponseExample1.yaml @@ -0,0 +1,9 @@ +# summary: +description: > + A successful response from `POST /_security/profile/u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0/_data`, which indicates that the request is acknowledged. +# type: response +# response_code: +value: |- + { + "acknowledged": true + } diff --git a/specification/security/suggest_user_profiles/examples/request/SuggestUserProfilesRequestExample1.yaml b/specification/security/suggest_user_profiles/examples/request/SuggestUserProfilesRequestExample1.yaml new file mode 100644 index 0000000000..cf6d017092 --- /dev/null +++ b/specification/security/suggest_user_profiles/examples/request/SuggestUserProfilesRequestExample1.yaml @@ -0,0 +1,20 @@ +# summary: +# method_request: POST /_security/profile/_suggest +description: > + Run `POST /_security/profile/_suggest` to get suggestions for profile documents with name-related fields matching `jack`. + It specifies both `uids` and `labels` hints for better relevance. + The `labels` hint ranks profiles higher if their `direction` label matches either `north` or `east`. +# type: request +value: |- + { + "name": "jack", + "hint": { + "uids": [ + "u_8RKO7AKfEbSiIHZkZZ2LJy2MUSDPWDr3tMI_CkIGApU_0", + "u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0" + ], + "labels": { + "direction": ["north", "east"] + } + } + } diff --git a/specification/security/suggest_user_profiles/examples/response/SuggestUserProfilesResponseExample1.yaml b/specification/security/suggest_user_profiles/examples/response/SuggestUserProfilesResponseExample1.yaml new file mode 100644 index 0000000000..d46fa54586 --- /dev/null +++ b/specification/security/suggest_user_profiles/examples/response/SuggestUserProfilesResponseExample1.yaml @@ -0,0 +1,10 @@ +# summary: +description: > + A successful response from `GET /_security/saml/metadata/saml1`. + It contains the SAML metadata that was generated for the SAML realm as an XML string. +# type: response +# response_code: +value: |- + { + "metadata" : "" + } diff --git a/specification/security/update_api_key/examples/request/UpdateApiKeyRequestExample1.yaml b/specification/security/update_api_key/examples/request/UpdateApiKeyRequestExample1.yaml new file mode 100644 index 0000000000..36fbbdf51b --- /dev/null +++ b/specification/security/update_api_key/examples/request/UpdateApiKeyRequestExample1.yaml @@ -0,0 +1,25 @@ +summary: Update role and metadata +# method_request: PUT /_security/api_key/VuaCfGcBCdbkQm-e5aOx +description: > + Run `PUT /_security/api_key/VuaCfGcBCdbkQm-e5aOx` to assign new role descriptors and metadata to an API key. +# type: request +value: |- + { + "role_descriptors": { + "role-a": { + "indices": [ + { + "names": ["*"], + "privileges": ["write"] + } + ] + } + }, + "metadata": { + "environment": { + "level": 2, + "trusted": true, + "tags": ["production"] + } + } + } diff --git a/specification/security/update_api_key/examples/request/UpdateApiKeyRequestExample2.yaml b/specification/security/update_api_key/examples/request/UpdateApiKeyRequestExample2.yaml new file mode 100644 index 0000000000..cceb7734a0 --- /dev/null +++ b/specification/security/update_api_key/examples/request/UpdateApiKeyRequestExample2.yaml @@ -0,0 +1,10 @@ +summary: Remove permissions +# method_request: PUT /_security/api_key/VuaCfGcBCdbkQm-e5aOx +description: > + Run `PUT /_security/api_key/VuaCfGcBCdbkQm-e5aOx` to remove the API key's previously assigned permissions. + It will inherit the owner user's full permissions. +# type: request +value: |- + { + "role_descriptors": {} + } diff --git a/specification/security/update_api_key/examples/response/UpdateApiKeyResponseExample1.yaml b/specification/security/update_api_key/examples/response/UpdateApiKeyResponseExample1.yaml new file mode 100644 index 0000000000..d003ec1af4 --- /dev/null +++ b/specification/security/update_api_key/examples/response/UpdateApiKeyResponseExample1.yaml @@ -0,0 +1,10 @@ +summary: Update role and metadata +description: > + A successful response from `PUT /_security/api_key/VuaCfGcBCdbkQm-e5aOx`. + The API key's effective permissions after the update will be the intersection of the supplied role descriptors and the owner user's permissions. +# type: response +# response_code: +value: |- + { + "updated": true + } diff --git a/specification/security/update_user_profile_data/examples/request/UpdateUserProfileDataRequestExample1.yaml b/specification/security/update_user_profile_data/examples/request/UpdateUserProfileDataRequestExample1.yaml new file mode 100644 index 0000000000..ff7cc28f7c --- /dev/null +++ b/specification/security/update_user_profile_data/examples/request/UpdateUserProfileDataRequestExample1.yaml @@ -0,0 +1,16 @@ +# summary: +# method_request: POST /_security/profile/u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0/_data +description: > + Run `POST /_security/profile/u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0/_data` to update a profile document for the `u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0` user profile. +# type: request +value: |- + { + "labels": { + "direction": "east" + }, + "data": { + "app1": { + "theme": "default" + } + } + } diff --git a/specification/security/update_user_profile_data/examples/response/UpdateUserProfileDataResponseExample1.yaml b/specification/security/update_user_profile_data/examples/response/UpdateUserProfileDataResponseExample1.yaml new file mode 100644 index 0000000000..d95c6487f9 --- /dev/null +++ b/specification/security/update_user_profile_data/examples/response/UpdateUserProfileDataResponseExample1.yaml @@ -0,0 +1,9 @@ +# summary: +description: > + A successful response from `POST /_security/profile/u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0/_data`, which indicates that the request is acknowledged. +# type: response +# response_code: +value: |- + { + "acknowledged": true + } From 1e6bfed2bdc6246878bfc74c8d739fb1cbf048a7 Mon Sep 17 00:00:00 2001 From: lcawl Date: Wed, 12 Mar 2025 13:02:54 -0700 Subject: [PATCH 4/6] Remove final overlays --- .../elasticsearch-openapi-overlays.yaml | 307 +--- .../elasticsearch-shared-overlays.yaml | 1577 ----------------- 2 files changed, 1 insertion(+), 1883 deletions(-) diff --git a/docs/overlays/elasticsearch-openapi-overlays.yaml b/docs/overlays/elasticsearch-openapi-overlays.yaml index 787f657cec..dae5ff67ce 100644 --- a/docs/overlays/elasticsearch-openapi-overlays.yaml +++ b/docs/overlays/elasticsearch-openapi-overlays.yaml @@ -60,309 +60,4 @@ actions: security: - apiKeyAuth: [] - basicAuth: [] - - bearerAuth: [] -# Examples that apply only to the Elasticsearch OpenAPI document -## Examples for indices - - target: "$.paths['/_lifecycle/stats']['get']" - description: "Add examples for get lifecycle stats operation" - update: - responses: - 200: - content: - application/json: - examples: - dataStreamLifecycleStatsResponseExample1: - $ref: "../../specification/indices/get_data_lifecycle_stats/examples/response/IndicesGetDataLifecycleStatsResponseExample1.yaml" - - target: "$.components['requestBodies']['indices.clone']" - description: "Add examples for clone index request" - update: - content: - application/json: - examples: - indicesCloneRequestExample1: - $ref: "../../specification/indices/clone/examples/request/indicesCloneRequestExample1.yaml" - - target: "$.paths['/{index}/_close']['post']" - description: "Add examples for close index response" - update: - responses: - 200: - content: - application/json: - examples: - indicesCloseResponseExample1: - $ref: "../../specification/indices/close/examples/response/CloseIndexResponseExample1.yaml" - - target: "$.components['responses']['indices.data_streams_stats#200']" - description: "Add example for data stream stats response" - update: - content: - application/json: - examples: - indicesDataStreamStatsResponseExample1: - $ref: "../../specification/indices/data_streams_stats/examples/200_response/indicesDataStreamStatsResponseExample1.yaml" - - target: "$.paths['/{index}/_open']['post']" - description: "Add examples for open index response" - update: - responses: - 200: - content: - application/json: - examples: - indicesOpenResponseExample1: - $ref: "../../specification/indices/open/examples/200_response/indicesOpenResponseExample1.yaml" - - target: "$.components['responses']['indices.recovery#200']" - description: "Add example for get index recovery response" - update: - content: - application/json: - examples: - getIndicesRecoveryResponseExample1: - $ref: "../../specification/indices/recovery/examples/200_response/indicesRecoveryResponseExample1.yaml" - - target: "$.components['responses']['indices.resolve_cluster#200']" - description: "Add examples for resolve cluster operation" - update: - content: - application/json: - examples: - resolveClusterResponseExample1: - $ref: "../../specification/indices/resolve_cluster/examples/200_response/ResolveClusterResponseExample1.yaml" - resolveClusterResponseExample2: - $ref: "../../specification/indices/resolve_cluster/examples/200_response/ResolveClusterResponseExample2.yaml" - - target: "$.components['requestBodies']['indices.shrink']" - description: "Add example for shrink index request" - update: - content: - application/json: - examples: - indicesShrinkRequestExample1: - $ref: "../../specification/indices/shrink/examples/request/indicesShrinkRequestExample1.yaml" - - target: "$.components['requestBodies']['indices.split']" - description: "Add example for split index request" - update: - content: - application/json: - examples: - indicesSplitRequestExample1: - $ref: "../../specification/indices/split/examples/request/indicesSplitRequestExample1.yaml" - - target: "$.components['requestBodies']['indices.put_template']" - description: "Add example for legacy create template request" - update: - content: - application/json: - examples: - indicesLegacyPutTemplateRequestExample1: - $ref: "../../specification/indices/put_template/examples/request/indicesPutTemplateRequestExample1.yaml" -## Examples for inference - - target: "$.paths['/_inference/chat_completion/{inference_id}/_stream']['post']" - description: "Add example for inference stream request" - update: - requestBody: - content: - application/json: - examples: - streamInferenceRequestExample1: - $ref: "../../specification/inference/stream_completion/examples/request/StreamInferenceRequestExample1.yaml" -## Examples for ingest - - target: "$.components['requestBodies']['simulate.ingest']" - description: "Add example for simulate ingest request" - update: - content: - application/json: - examples: - simulateIngestRequestExample1: - $ref: "../../specification/simulate/ingest/examples/request/SimulateIngestRequestExample1.yaml" - simulateIngestRequestExample2: - $ref: "../../specification/simulate/ingest/examples/request/SimulateIngestRequestExample2.yaml" - simulateIngestRequestExample3: - $ref: "../../specification/simulate/ingest/examples/request/SimulateIngestRequestExample3.yaml" - simulateIngestRequestExample4: - $ref: "../../specification/simulate/ingest/examples/request/SimulateIngestRequestExample4.yaml" - - target: "$.components['responses']['simulate.ingest#200']" - description: "Add example for simulate ingest response" - update: - content: - application/json: - examples: - simulateIngestResponseExample1: - $ref: "../../specification/simulate/ingest/examples/response/SimulateIngestResponseExample1.yaml" - simulateIngestResponseExample2: - $ref: "../../specification/simulate/ingest/examples/response/SimulateIngestResponseExample2.yaml" - simulateIngestResponseExample3: - $ref: "../../specification/simulate/ingest/examples/response/SimulateIngestResponseExample3.yaml" -## Examples for licensing - - target: "$.paths['/_license/basic_status']['get']" - description: "Add example for get basic status response" - update: - responses: - 200: - content: - application/json: - examples: - getBasicStatusResponseExample1: - $ref: "../../specification/license/get_basic_status/examples/200_response/GetBasicLicenseStatusResponseExample1.yaml" - - target: "$.paths['/_license/trial_status']['get']" - description: "Add example for get trial status response" - update: - responses: - 200: - content: - application/json: - examples: - getLicenseResponseExample1: - $ref: "../../specification/license/get_trial_status/examples/200_response/GetTrialLicenseStatusResponseExample1.yaml" - - target: "$.paths['/_license/start_basic']['post']" - description: "Add example for start basic response" - update: - responses: - 200: - content: - application/json: - examples: - startBasicLicenseResponseExample1: - $ref: "../../specification/license/post_start_basic/examples/200_response/StartBasicLicenseResponseExample1.yaml" - - target: "$.paths['/_license/start_trial']['post']" - description: "Add example for start trial response" - update: - responses: - 200: - content: - application/json: - examples: - startTrialLicenseResponseExample1: - $ref: "../../specification/license/post_start_trial/examples/200_response/StartTrialLicenseResponseExample1.yaml" - - target: "$.components['requestBodies']['license.post']" - description: "Add examples for update license request" - update: - content: - application/json: - examples: - updateLicenseRequestExample1: - $ref: "../../specification/license/post/examples/request/PostLicenseRequestExample1.yaml" - - target: "$.components['responses']['license.post#200']" - description: "Add examples for update license response" - update: - content: - application/json: - examples: - clusterHealthResponseExample1: - $ref: "../../specification/license/post/examples/200_response/PostLicenseResponseExample1.yaml" -## Examples for machine learning - - target: "$.components['requestBodies']['ml.explain_data_frame_analytics']" - description: "Add examples for explain dataframe analytics" - update: - content: - application/json: - examples: - mlDataFrameAnalyticsExplainRequestExample1: - $ref: "../../specification/ml/explain_data_frame_analytics/examples/request/MlExplainDataFrameAnalyticsRequestExample1.yaml" - - target: "$.components['responses']['ml.explain_data_frame_analytics#200']" - description: "Add examples for explain dataframe analytics response" - update: - content: - application/json: - examples: - mlDataFrameAnalyticsExplainResponseExample1: - $ref: "../../specification/ml/explain_data_frame_analytics/examples/response/MlExplainDataFrameAnalyticsResponseExample1.yaml" - - target: "$.paths['/_ml/trained_models/{model_id}/deployment/cache/_clear']['post']" - description: "Add examples for clear trained model cache" - update: - responses: - 200: - content: - application/json: - examples: - mlTrainedModelClearResponseExample1: - $ref: "../../specification/ml/clear_trained_model_deployment_cache/examples/response/MlClearTrainedModelDeploymentCacheResponseExample1.yaml" - - target: "$.paths['/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}']['delete']" - description: "Add examples for delete trained model snapshot" - update: - responses: - 200: - content: - application/json: - examples: - mlTrainedModelSnapshotDeleteResponseExample1: - $ref: "../../specification/ml/delete_model_snapshot/examples/response/MlDeleteModelSnapshotResponseExample1.yaml" - - target: "$.components['responses']['ml.delete_forecast#200']" - description: "Add examples for delete forecast" - update: - content: - application/json: - examples: - mlForecastDeleteResponseExample1: - $ref: "../../specification/ml/delete_forecast/examples/response/MlDeleteForecastResponseExample1.yaml" - - target: "$.components['responses']['ml.delete_expired_data#200']" - description: "Add examples for delete expired data" - update: - content: - application/json: - examples: - mlExpiredDataDeleteResponseExample1: - $ref: "../../specification/ml/delete_expired_data/examples/response/MlDeleteExpiredDataResponseExample1.yaml" -## Examples for search applications - - target: "$.paths['/_application/search_application/{name}/_render_query']['post']" - description: "Add examples for render search application query operation" - update: - requestBody: - content: - application/json: - examples: - renderSearchApplicationQueryRequestExample1: - $ref: "../../specification/search_application/render_query/examples/request/SearchApplicationsRenderQueryRequestExample1.yaml" -## Examples for security - - target: "$.paths['/_security/api_key/_bulk_update']['post']" - description: "Add examples for bulk update API keys operation" - update: - requestBody: - content: - application/json: - examples: - bulkUpdateApiKeysRequestExample1: - $ref: "../../specification/security/bulk_update_api_keys/examples/request/SecurityBulkUpdateApiKeysRequestExample1.yaml" - bulkUpdateApiKeysRequestExample2: - $ref: "../../specification/security/bulk_update_api_keys/examples/request/SecurityBulkUpdateApiKeysRequestExample2.yaml" - responses: - 200: - content: - application/json: - examples: - bulkUpdateApiKeysResponseExample1: - $ref: "../../specification/security/bulk_update_api_keys/examples/200_response/SecurityBulkUpdateApiKeysResponseExample1.yaml" - - target: "$.paths['/_security/delegate_pki']['post']" - description: "Add examples for delegate PKI operation" - update: - requestBody: - content: - application/json: - examples: - delegatePkiRequestExample1: - $ref: "../../specification/security/delegate_pki/examples/request/SecurityDelegatePkiRequestExample1.yaml" - responses: - 200: - content: - application/json: - examples: - delegatePkiResponseExample1: - $ref: "../../specification/security/delegate_pki/examples/200_response/SecurityDelegatePkiResponseExample1.yaml" -## Examples for tasks - - target: "$.paths['/_tasks']['get']" - description: "Add examples for task management operation" - update: - responses: - 200: - content: - application/json: - examples: - getTasksResponseExample1: - $ref: "../../specification/tasks/get/examples/200_response/GetTaskResponseExample1.yaml" -## Examples for transforms - - target: "$.paths['/_transform/_upgrade']['post']" - description: "Add examples for transform upgrade" - update: - responses: - 200: - content: - application/json: - examples: - transformUpgradeResponseExample1: - $ref: "../../specification/transform/upgrade_transforms/examples/response/UpgradeTransformResponseExample1.yaml" - + - bearerAuth: [] \ No newline at end of file diff --git a/docs/overlays/elasticsearch-shared-overlays.yaml b/docs/overlays/elasticsearch-shared-overlays.yaml index 76f6c71a76..47bd9db1ce 100644 --- a/docs/overlays/elasticsearch-shared-overlays.yaml +++ b/docs/overlays/elasticsearch-shared-overlays.yaml @@ -1072,1583 +1072,6 @@ actions: aggregations: x-model: true # Examples -## Examples for cat - - target: "$.components['responses']['cat.aliases#200']" - description: "Add example for cat aliases response" - update: - content: - text/plain: - schema: - type: string - examples: - catAliasesResponseExample1: - $ref: "../../specification/cat/aliases/examples/200_response/CatAliasesResponseExample1.yaml" - - target: "$.components['responses']['cat.allocation#200']" - description: "Add example for cat allocation response" - update: - content: - text/plain: - schema: - type: string - examples: - catAllocationResponseExample1: - $ref: "../../specification/cat/allocation/examples/200_response/CatAllocationResponseExample1.yaml" - - target: "$.components['responses']['cat.component_templates#200']" - description: "Add example for cat component templates response" - update: - content: - text/plain: - schema: - type: string - examples: - catComponentTemplatesResponseExample1: - $ref: "../../specification/cat/component_templates/examples/200_response/CatComponentTemplatesResponseExample1.yaml" - - target: "$.components['responses']['cat.count#200']" - description: "Add example for cat count response" - update: - content: - text/plain: - schema: - type: string - examples: - catCountResponseExample1: - $ref: "../../specification/cat/count/examples/200_response/CatCountResponseExample1.yaml" - catCountResponseExample2: - $ref: "../../specification/cat/count/examples/200_response/CatCountResponseExample2.yaml" - - target: "$.components['responses']['cat.fielddata#200']" - description: "Add example for cat fielddata response" - update: - content: - text/plain: - schema: - type: string - examples: - catFieldDataResponseExample1: - $ref: "../../specification/cat/fielddata/examples/200_response/CatFielddataResponseExample1.yaml" - catFieldDataResponseExample2: - $ref: "../../specification/cat/fielddata/examples/200_response/CatFielddataResponseExample2.yaml" - - target: "$.components['responses']['cat.indices#200']" - description: "Add example for cat indices response" - update: - content: - text/plain: - schema: - type: string - examples: - catIndicesResponseExample1: - $ref: "../../specification/cat/indices/examples/200_response/CatIndicesResponseExample1.yaml" - - target: "$.components['responses']['cat.ml_datafeeds#200']" - description: "Add example for cat datafeeds response" - update: - content: - text/plain: - schema: - type: string - examples: - catDatafeedsResponseExample1: - $ref: "../../specification/cat/ml_datafeeds/examples/200_response/CatDatafeedsResponseExample1.yaml" - - target: "$.components['responses']['cat.ml_data_frame_analytics#200']" - description: "Add example for cat data frame analytics response" - update: - content: - text/plain: - schema: - type: string - examples: - catDataFrameAnalyticsResponseExample1: - $ref: "../../specification/cat/ml_data_frame_analytics/examples/200_response/CatDataFrameAnalyticsResponseExample1.yaml" - - target: "$.components['responses']['cat.ml_jobs#200']" - description: "Add example for cat anomaly detectors response" - update: - content: - text/plain: - schema: - type: string - examples: - catAnomalyDetectorsResponseExample1: - $ref: "../../specification/cat/ml_jobs/examples/200_response/CatJobsResponseExample1.yaml" - - target: "$.components['responses']['cat.ml_trained_models#200']" - description: "Add example for cat trained models response" - update: - content: - text/plain: - schema: - type: string - examples: - catTrainedModelsResponseExample1: - $ref: "../../specification/cat/ml_trained_models/examples/200_response/CatTrainedModelsResponseExample1.yaml" - - target: "$.components['responses']['cat.recovery#200']" - description: "Add example for cat recovery response" - update: - content: - text/plain: - schema: - type: string - examples: - catRecoveryResponseExample1: - $ref: "../../specification/cat/recovery/examples/200_response/CatRecoveryResponseExample1.yaml" - catRecoveryResponseExample2: - $ref: "../../specification/cat/recovery/examples/200_response/CatRecoveryResponseExample2.yaml" - catRecoveryResponseExample3: - $ref: "../../specification/cat/recovery/examples/200_response/CatRecoveryResponseExample3.yaml" - - target: "$.components['responses']['cat.segments#200']" - description: "Add example for cat segments response" - update: - content: - text/plain: - schema: - type: string - examples: - catSegmentsResponseExample1: - $ref: "../../specification/cat/segments/examples/200_response/CatSegmentsResponseExample1.yaml" - - target: "$.components['responses']['cat.shards#200']" - description: "Add example for cat shards response" - update: - content: - text/plain: - schema: - type: string - examples: - catShardsResponseExample1: - $ref: "../../specification/cat/shards/examples/200_response/CatShardsResponseExample1.yaml" - catShardsResponseExample2: - $ref: "../../specification/cat/shards/examples/200_response/CatShardsResponseExample2.yaml" - catShardsResponseExample3: - $ref: "../../specification/cat/shards/examples/200_response/CatShardsResponseExample3.yaml" - catShardsResponseExample4: - $ref: "../../specification/cat/shards/examples/200_response/CatShardsResponseExample4.yaml" - catShardsResponseExample5: - $ref: "../../specification/cat/shards/examples/200_response/CatShardsResponseExample5.yaml" - - target: "$.components['responses']['cat.snapshots#200']" - description: "Add example for cat snapshot response" - update: - content: - text/plain: - schema: - type: string - examples: - catSnapshotsResponseExample1: - $ref: "../../specification/cat/snapshots/examples/200_response/CatSnapshotsResponseExample1.yaml" - - target: "$.components['responses']['cat.templates#200']" - description: "Add example for cat templates response" - update: - content: - text/plain: - schema: - type: string - examples: - catTemplatesResponseExample1: - $ref: "../../specification/cat/templates/examples/200_response/CatTemplatesResponseExample1.yaml" - - target: "$.components['responses']['cat.transforms#200']" - description: "Add example for cat transforms response" - update: - content: - application/json: - examples: - catTransformsResponseExample1: - $ref: "../../specification/cat/transforms/examples/200_response/CatTransformsResponseExample1.yaml" - - target: "$.paths['/_cat/health']['get']" - description: "Add examples for cat health operation" - update: - responses: - 200: - content: - text/plain: - schema: - type: string - examples: - catHealthResponseExample1: - $ref: "../../specification/cat/health/examples/200_response/CatHealthResponseExample1.yaml" - - target: "$.paths['/_cat/master']['get']" - description: "Add examples for cat master operation" - update: - responses: - 200: - content: - text/plain: - schema: - type: string - examples: - catMasterResponseExample1: - $ref: "../../specification/cat/master/examples/200_response/CatMasterResponseExample1.yaml" - - target: "$.paths['/_cat/nodeattrs']['get']" - description: "Add examples for cat node attributes operation" - update: - responses: - 200: - content: - text/plain: - schema: - type: string - examples: - catNodeAttributesResponseExample1: - $ref: "../../specification/cat/nodeattrs/examples/200_response/CatNodeAttributesResponseExample1.yaml" - catNodeAttributesResponseExample2: - $ref: "../../specification/cat/nodeattrs/examples/200_response/CatNodeAttributesResponseExample2.yaml" - - target: "$.paths['/_cat/nodes']['get']" - description: "Add examples for cat nodes operation" - update: - responses: - 200: - content: - text/plain: - schema: - type: string - examples: - catNodesResponseExample1: - $ref: "../../specification/cat/nodes/examples/200_response/CatNodesResponseExample1.yaml" - catNodesResponseExample2: - $ref: "../../specification/cat/nodes/examples/200_response/CatNodesResponseExample2.yaml" - - target: "$.paths['/_cat/pending_tasks']['get']" - description: "Add examples for cat pending tasks operation" - update: - responses: - 200: - content: - text/plain: - schema: - type: string - examples: - catPendingTasksResponseExample1: - $ref: "../../specification/cat/pending_tasks/examples/200_response/CatPendingTasksResponseExample1.yaml" - - target: "$.paths['/_cat/plugins']['get']" - description: "Add examples for cat plugins operation" - update: - responses: - 200: - content: - text/plain: - schema: - type: string - examples: - catPluginsResponseExample1: - $ref: "../../specification/cat/plugins/examples/200_response/CatPluginsResponseExample1.yaml" - - target: "$.paths['/_cat/repositories']['get']" - description: "Add examples for cat repositories operation" - update: - responses: - 200: - content: - text/plain: - schema: - type: string - examples: - catRepositoriesResponseExample1: - $ref: "../../specification/cat/repositories/examples/200_response/CatRepositoriesResponseExample1.yaml" - - target: "$.paths['/_cat/tasks']['get']" - description: "Add examples for cat tasks operation" - update: - responses: - 200: - content: - text/plain: - schema: - type: string - examples: - catTasksResponseExample1: - $ref: "../../specification/cat/tasks/examples/200_response/CatTasksResponseExample1.yaml" -## Examples for connectors - - target: "$.paths['/_connector/{connector_id}/_check_in']['put']" - description: "Add example for check in connector response" - update: - responses: - 200: - content: - application/json: - examples: - connectorCheckInResponseExample1: - $ref: "../../specification/connector/check_in/examples/response/ConnectorCheckInResponseExample1.yaml" - - target: "$.paths['/_connector/{connector_id}']['delete']" - description: "Add example for delete connector response" - update: - responses: - 200: - content: - application/json: - examples: - connectorDeleteResponseExample1: - $ref: "../../specification/connector/delete/examples/response/ConnectorDeleteResponseExample1.yaml" - - target: "$.components['requestBodies']['connector.put']" - description: "Add example for create connector request" - update: - content: - application/json: - examples: - connectorPutRequestExample1: - $ref: "../../specification/connector/put/examples/request/ConnectorPutRequestExample1.yaml" - connectorPutRequestExample2: - $ref: "../../specification/connector/put/examples/request/ConnectorPutRequestExample2.yaml" - - target: "$.components['responses']['connector.put#200']" - description: "Add example for create connector response" - update: - content: - application/json: - examples: - connectorPutResponseExample: - $ref: "../../specification/connector/put/examples/response/ConnectorPutResponseExample1.yaml" - - target: "$.paths['/_connector/_sync_job/{connector_sync_job_id}']['delete']" - description: "Add example for delete sync job response" - update: - responses: - 200: - content: - application/json: - examples: - syncJobDeleteResponseExample1: - $ref: "../../specification/connector/sync_job_delete/examples/response/SyncJobDeleteResponseExample1.yaml" - - target: "$.paths['/_connector/_sync_job']['post']" - description: "Add example for create sync job" - update: - requestBody: - content: - application/json: - examples: - syncJobPostRequestExample1: - $ref: "../../specification/connector/sync_job_post/examples/request/SyncJobPostRequestExample1.yaml" - - target: "$.paths['/_connector/{connector_id}/_api_key_id']['put']" - description: "Add examples for update connector API key ID" - update: - requestBody: - content: - application/json: - examples: - connectorUpdateApiKeyIdRequestExample1: - $ref: "../../specification/connector/update_api_key_id/examples/request/ConnectorUpdateApiKeyIDRequestExample1.yaml" - responses: - 200: - content: - application/json: - examples: - connectorUpdateApiKeyIdResponseExample1: - $ref: "../../specification/connector/update_api_key_id/examples/response/ConnectorUpdateApiKeyIDResponseExample1.yaml" - - target: "$.paths['/_connector/{connector_id}/_configuration']['put']" - description: "Add examples for update connector configuration" - update: - requestBody: - content: - application/json: - examples: - connectorUpdateConfigurationRequestExample1: - $ref: "../../specification/connector/update_configuration/examples/request/ConnectorUpdateConfigurationRequestExample1.yaml" - connectorUpdateConfigurationRequestExample2: - $ref: "../../specification/connector/update_configuration/examples/request/ConnectorUpdateConfigurationRequestExample2.yaml" - responses: - 200: - content: - application/json: - examples: - connectorUpdateConfigurationResponseExample1: - $ref: "../../specification/connector/update_configuration/examples/response/ConnectorUpdateConfigurationResponseExample1.yaml" - - target: "$.paths['/_connector/{connector_id}/_error']['put']" - description: "Add examples for update connector error field" - update: - requestBody: - content: - application/json: - examples: - connectorUpdateConfigurationRequestExample1: - $ref: "../../specification/connector/update_error/examples/request/ConnectorUpdateErrorRequestExample1.yaml" - responses: - 200: - content: - application/json: - examples: - connectorUpdateErrorResponseExample1: - $ref: "../../specification/connector/update_error/examples/response/ConnectorUpdateErrorResponseExample1.yaml" - - target: "$.paths['/_connector/{connector_id}/_filtering']['put']" - description: "Add examples for update connector filtering" - update: - requestBody: - content: - application/json: - examples: - connectorUpdateFilteringRequestExample1: - $ref: "../../specification/connector/update_filtering/examples/request/ConnectorUpdateFilteringRequestExample1.yaml" - connectorUpdateFilteringRequestExample2: - $ref: "../../specification/connector/update_filtering/examples/request/ConnectorUpdateFilteringRequestExample2.yaml" - responses: - 200: - content: - application/json: - examples: - connectorUpdateFilteringResponseExample1: - $ref: "../../specification/connector/update_filtering/examples/response/ConnectorUpdateFilteringResponseExample1.yaml" - - target: "$.paths['/_connector/{connector_id}/_index_name']['put']" - description: "Add examples for update connector index name" - update: - requestBody: - content: - application/json: - examples: - connectorUpdateIndexNameRequestExample1: - $ref: "../../specification/connector/update_index_name/examples/request/ConnectorUpdateIndexNameRequestExample1.yaml" - responses: - 200: - content: - application/json: - examples: - connectorUpdateIndexNameResponseExample1: - $ref: "../../specification/connector/update_index_name/examples/response/ConnectorUpdateIndexNameResponseExample1.yaml" - - target: "$.paths['/_connector/{connector_id}/_name']['put']" - description: "Add examples for update connector name" - update: - requestBody: - content: - application/json: - examples: - connectorUpdateNameRequestExample1: - $ref: "../../specification/connector/update_name/examples/request/ConnectorUpdateNameRequestExample1.yaml" - responses: - 200: - content: - application/json: - examples: - connectorUpdateNameResponseExample1: - $ref: "../../specification/connector/update_name/examples/response/ConnectorUpdateNameResponseExample1.yaml" - - target: "$.paths['/_connector/{connector_id}/_pipeline']['put']" - description: "Add examples for update connector pipeline" - update: - requestBody: - content: - application/json: - examples: - connectorUpdatePipelineRequestExample1: - $ref: "../../specification/connector/update_pipeline/examples/request/ConnectorUpdatePipelineRequestExample1.yaml" - responses: - 200: - content: - application/json: - examples: - connectorUpdatePipelineResponseExample1: - $ref: "../../specification/connector/update_pipeline/examples/response/ConnectorUpdatePipelineResponseExample1.yaml" - - target: "$.paths['/_connector/{connector_id}/_scheduling']['put']" - description: "Add examples for update connector scheduling" - update: - requestBody: - content: - application/json: - examples: - connectorUpdateSchedulingRequestExample1: - $ref: "../../specification/connector/update_scheduling/examples/request/ConnectorUpdateSchedulingRequestExample1.yaml" - connectorUpdateSchedulingRequestExample2: - $ref: "../../specification/connector/update_scheduling/examples/request/ConnectorUpdateSchedulingRequestExample2.yaml" - responses: - 200: - content: - application/json: - examples: - connectorUpdateSchedulingResponseExample1: - $ref: "../../specification/connector/update_scheduling/examples/response/ConnectorUpdateSchedulingResponseExample1.yaml" - - target: "$.paths['/_connector/{connector_id}/_service_type']['put']" - description: "Add examples for update connector service type" - update: - requestBody: - content: - application/json: - examples: - connectorUpdateServiceTypeRequestExample1: - $ref: "../../specification/connector/update_service_type/examples/request/ConnectorUpdateServiceTypeRequestExample1.yaml" - responses: - 200: - content: - application/json: - examples: - connectorUpdateServiceTypeResponseExample1: - $ref: "../../specification/connector/update_service_type/examples/response/ConnectorUpdateServiceTypeResponseExample1.yaml" - - target: "$.paths['/_connector/{connector_id}/_status']['put']" - description: "Add examples for update connector status" - update: - requestBody: - content: - application/json: - examples: - connectorUpdateStatusRequestExample1: - $ref: "../../specification/connector/update_status/examples/request/ConnectorUpdateStatusRequestExample1.yaml" - responses: - 200: - content: - application/json: - examples: - connectorUpdateStatusResponseExample1: - $ref: "../../specification/connector/update_status/examples/response/ConnectorUpdateStatusResponseExample1.yaml" -## Examples for data streams - - target: "$.paths['/_data_stream/{name}/_lifecycle']['delete']" - description: "Add example for delete data stream lifecycle response" - update: - responses: - 200: - content: - application/json: - examples: - indicesDeleteDataLifecycleResponseExample1: - $ref: "../../specification/indices/delete_data_lifecycle/examples/200_response/IndicesDeleteDataLifecycleResponseExample1.yaml" - - target: "$.paths['/_data_stream/{name}/_lifecycle']['get']" - description: "Add example for get data stream lifecycle response" - update: - responses: - 200: - content: - application/json: - examples: - indicesGetDataLifecycleResponseExample1: - $ref: "../../specification/indices/get_data_lifecycle/examples/response/IndicesGetDataLifecycleResponseExample1.yaml" - - target: "$.components['responses']['indices.get_data_stream#200']" - description: "Add example for get data stream response" - update: - content: - application/json: - examples: - indicesGetDataStreamResponseExample: - $ref: "../../specification/indices/get_data_stream/examples/200_response/indicesGetDataStreamResponseExample1.yaml" - - target: "$.paths['/_data_stream/{name}/_lifecycle']['put']" - description: "Add examples update data stream lifecycle request and response" - update: - requestBody: - content: - application/json: - examples: - indicesPutDataLifecycleRequestExample1: - $ref: "../../specification/indices/put_data_lifecycle/examples/request/IndicesPutDataLifecycleRequestExample1.yaml" - indicesPutLifecycleRequestExample2: - $ref: "../../specification/indices/put_data_lifecycle/examples/request/IndicesPutDataLifecycleRequestExample2.yaml" - responses: - 200: - content: - application/json: - examples: - indicesPutDataLifecycleResponseExample1: - $ref: "../../specification/indices/put_data_lifecycle/examples/200_response/IndicesPutDataLifecycleResponseExample1.yaml" - - target: "$.paths['/{index}/_lifecycle/explain']['get']" - description: "Add example for explain data stream lifecycle response" - update: - responses: - 200: - content: - application/json: - examples: - indicesExplainDataLifecycleResponseExample: - $ref: "../../specification/indices/explain_data_lifecycle/examples/response/IndicesExplainDataLifecycleResponseExample1.yaml" -## Examples for documents - - target: "$.components['requestBodies']['bulk']" - description: "Add example for bulk index or delete documents" - update: - content: - application/json: - examples: - bulkDocumentRequestExample1: - $ref: "../../specification/_global/bulk/examples/request/BulkRequestExample1.yaml" - bulkDocumentRequestExample2: - $ref: "../../specification/_global/bulk/examples/request/BulkRequestExample2.yaml" - bulkDocumentRequestExample3: - $ref: "../../specification/_global/bulk/examples/request/BulkRequestExample3.yaml" - bulkDocumentRequestExample4: - $ref: "../../specification/_global/bulk/examples/request/BulkRequestExample4.yaml" - - target: "$.components['responses']['bulk#200']" - description: "Add example for bulk indext or delete documents response" - update: - content: - application/json: - examples: - bulkDocumentResponseExample1: - $ref: "../../specification/_global/bulk/examples/response/BulkResponseExample1.yaml" - bulkDocumentResponseExample2: - $ref: "../../specification/_global/bulk/examples/response/BulkResponseExample2.yaml" - bulkDocumentResponseExample3: - $ref: "../../specification/_global/bulk/examples/response/BulkResponseExample3.yaml" - - target: "$.components['requestBodies']['create']" - description: "Add example for create documents" - update: - content: - application/json: - examples: - createDocumentRequestExample1: - $ref: "../../specification/_global/create/examples/request/CreateRequestExample1.yaml" - - target: "$.paths['/{index}/_doc/{id}']['delete']" - description: "Add examples for delete document operation" - update: - responses: - 200: - content: - application/json: - examples: - deleteDocumentResponseExample1: - $ref: "../../specification/_global/delete/examples/response/DeleteResponseExample1.yaml" - - target: "$.paths['/{index}/_delete_by_query']['post']" - description: "Add examples delete by query operation" - update: - requestBody: - content: - application/json: - examples: - deleteByQueryRequestExample1: - $ref: "../../specification/_global/delete_by_query/examples/request/DeleteByQueryRequestExample1.yaml" - deleteByQueryRequestExample2: - $ref: "../../specification/_global/delete_by_query/examples/request/DeleteByQueryRequestExample2.yaml" - deleteByQueryRequestExample3: - $ref: "../../specification/_global/delete_by_query/examples/request/DeleteByQueryRequestExample3.yaml" - deleteByQueryRequestExample4: - $ref: "../../specification/_global/delete_by_query/examples/request/DeleteByQueryRequestExample4.yaml" - responses: - 200: - content: - application/json: - examples: - deleteDocumentResponseExample1: - $ref: "../../specification/_global/delete_by_query/examples/response/DeleteByQueryResponseExample1.yaml" - - target: "$.paths['/{index}/_doc/{id}']['get']" - description: "Add examples for get document operation" - update: - responses: - 200: - content: - application/json: - examples: - getDocumentResponseExample1: - $ref: "../../specification/_global/get/examples/response/GetResponseExample1.yaml" - getDocumentResponseExample2: - $ref: "../../specification/_global/get/examples/response/GetResponseExample2.yaml" - getDocumentResponseExample3: - $ref: "../../specification/_global/get/examples/response/GetResponseExample3.yaml" - - target: "$.components['requestBodies']['index']" - description: "Add example for index request" - update: - content: - application/json: - examples: - indexRequestExample1: - $ref: "../../specification/_global/index/examples/request/IndexRequestExample1.yaml" - indexRequestExample2: - $ref: "../../specification/_global/index/examples/request/IndexRequestExample2.yaml" - - target: "$.components['responses']['index#200']" - description: "Add example for index response" - update: - content: - application/json: - examples: - indexResponseExample1: - $ref: "../../specification/_global/index/examples/response/IndexResponseExample1.yaml" - indexResponseExample2: - $ref: "../../specification/_global/index/examples/response/IndexResponseExample2.yaml" - - target: "$.components['requestBodies']['mget']" - description: "Add example for mget request" - update: - content: - application/json: - examples: - mgetRequestExample1: - $ref: "../../specification/_global/mget/examples/request/MultiGetRequestExample1.yaml" - mgetRequestExample2: - $ref: "../../specification/_global/mget/examples/request/MultiGetRequestExample2.yaml" - mgetRequestExample3: - $ref: "../../specification/_global/mget/examples/request/MultiGetRequestExample3.yaml" - mgetRequestExample4: - $ref: "../../specification/_global/mget/examples/request/MultiGetRequestExample4.yaml" - - target: "$.components['requestBodies']['mtermvectors']" - description: "Add example for multi term vectors request" - update: - content: - application/json: - examples: - multiTermVectorsRequestExample1: - $ref: "../../specification/_global/mtermvectors/examples/request/MultiTermVectorsRequestExample1.yaml" - multiTermVectorsRequestExample2: - $ref: "../../specification/_global/mtermvectors/examples/request/MultiTermVectorsRequestExample2.yaml" - multiTermVectorsRequestExample3: - $ref: "../../specification/_global/mtermvectors/examples/request/MultiTermVectorsRequestExample3.yaml" - - target: "$.paths['/_reindex']['post']" - description: "Add examples for reindex operation" - update: - requestBody: - content: - application/json: - examples: - reindexRequestExample1: - $ref: "../../specification/_global/reindex/examples/request/ReindexRequestExample1.yaml" - reindexRequestExample2: - $ref: "../../specification/_global/reindex/examples/request/ReindexRequestExample2.yaml" - reindexRequestExample3: - $ref: "../../specification/_global/reindex/examples/request/ReindexRequestExample3.yaml" - reindexRequestExample4: - $ref: "../../specification/_global/reindex/examples/request/ReindexRequestExample4.yaml" - reindexRequestExample5: - $ref: "../../specification/_global/reindex/examples/request/ReindexRequestExample5.yaml" - reindexRequestExample6: - $ref: "../../specification/_global/reindex/examples/request/ReindexRequestExample6.yaml" - reindexRequestExample7: - $ref: "../../specification/_global/reindex/examples/request/ReindexRequestExample7.yaml" - reindexRequestExample8: - $ref: "../../specification/_global/reindex/examples/request/ReindexRequestExample8.yaml" - reindexRequestExample9: - $ref: "../../specification/_global/reindex/examples/request/ReindexRequestExample9.yaml" - reindexRequestExample10: - $ref: "../../specification/_global/reindex/examples/request/ReindexRequestExample10.yaml" - reindexRequestExample11: - $ref: "../../specification/_global/reindex/examples/request/ReindexRequestExample11.yaml" - reindexRequestExample12: - $ref: "../../specification/_global/reindex/examples/request/ReindexRequestExample12.yaml" - - target: "$.paths['/{index}/_update/{id}']['post']" - description: "Add examples for update document operation" - update: - requestBody: - content: - application/json: - examples: - updateRequestExample1: - $ref: "../../specification/_global/update/examples/request/UpdateRequestExample1.yaml" - updateRequestExample2: - $ref: "../../specification/_global/update/examples/request/UpdateRequestExample2.yaml" - updateRequestExample3: - $ref: "../../specification/_global/update/examples/request/UpdateRequestExample3.yaml" - updateRequestExample4: - $ref: "../../specification/_global/update/examples/request/UpdateRequestExample4.yaml" - updateRequestExample5: - $ref: "../../specification/_global/update/examples/request/UpdateRequestExample5.yaml" - updateRequestExample6: - $ref: "../../specification/_global/update/examples/request/UpdateRequestExample6.yaml" - updateRequestExample7: - $ref: "../../specification/_global/update/examples/request/UpdateRequestExample7.yaml" - updateRequestExample8: - $ref: "../../specification/_global/update/examples/request/UpdateRequestExample8.yaml" - updateRequestExample9: - $ref: "../../specification/_global/update/examples/request/UpdateRequestExample9.yaml" - updateRequestExample10: - $ref: "../../specification/_global/update/examples/request/UpdateRequestExample10.yaml" - updateRequestExample11: - $ref: "../../specification/_global/update/examples/request/UpdateRequestExample11.yaml" - responses: - 200: - content: - application/json: - examples: - updateResponseExample1: - $ref: "../../specification/_global/update/examples/response/UpdateResponseExample1.yaml" - - target: "$.paths['/{index}/_update_by_query']['post']" - description: "Add examples for update by query operation" - update: - requestBody: - content: - application/json: - examples: - updateByQueryRequestExample1: - $ref: "../../specification/_global/update_by_query/examples/request/UpdateByQueryRequestExample1.yaml" - updateByQueryRequestExample2: - $ref: "../../specification/_global/update_by_query/examples/request/UpdateByQueryRequestExample2.yaml" - updateByQueryRequestExample3: - $ref: "../../specification/_global/update_by_query/examples/request/UpdateByQueryRequestExample3.yaml" - updateByQueryRequestExample4: - $ref: "../../specification/_global/update_by_query/examples/request/UpdateByQueryRequestExample4.yaml" -## Examples for EQL - - target: "$.paths['/_eql/search/status/{id}']['get']" - description: "Add examples for get async EQL status operation" - update: - responses: - 200: - content: - application/json: - examples: - eqlGetStatusResponseExample1: - $ref: "../../specification/eql/get_status/examples/response/EqlGetStatusResponseExample1.yaml" - - target: "$.components['requestBodies']['eql.search']" - description: "Add examples for EQL search operation" - update: - content: - application/json: - examples: - eqlSearchRequestExample1: - $ref: "../../specification/eql/search/examples/request/EqlSearchRequestExample1.yaml" - eqlSearchRequestExample2: - $ref: "../../specification/eql/search/examples/request/EqlSearchRequestExample2.yaml" - - target: "$.components['reponses']['eql.search#200']" - description: "Add examples for EQL search operation" - update: - content: - application/json: - examples: - eqlSearchResponseExample2: - $ref: "../../specification/eql/search/examples/response/EqlSearchResponseExample2.yaml" -## Examples for ESQL - - target: "$.paths['/_query']['post']" - description: "Add examples for ES|QL query operation" - update: - requestBody: - content: - application/json: - examples: - esqlQueryRequestExample1: - $ref: "../../specification/esql/query/examples/request/QueryRequestExample1.yaml" -## Examples for graph - - target: "$.components['requestBodies']['graph.explore']" - description: "Add example for graph explore request" - update: - content: - application/json: - examples: - graphExploreRequestExample1: - $ref: "../../specification/graph/explore/examples/request/GraphExploreRequestExample1.yaml" -## Examples for indices - - target: "$.components['requestBodies']['indices.put_index_template']" - description: "Add example for create index template request" - update: - content: - application/json: - examples: - indicesPutIndexTemplateRequestExample1: - $ref: "../../specification/indices/put_index_template/examples/request/indicesPutIndexTemplateRequestExample1.yaml" - - target: "$.components['requestBodies']['indices.put_mapping']" - description: "Add example for update mapping request" - update: - content: - application/json: - examples: - indicesPutSettingRequestExample1: - $ref: "../../specification/indices/put_mapping/examples/request/indicesPutMappingRequestExample1.yaml" - - target: "$.components['requestBodies']['indices.put_settings']" - description: "Add example for update index settings request" - update: - content: - application/json: - examples: - indicesPutSettingRequestExample1: - $ref: "../../specification/indices/put_settings/examples/request/IndicesPutSettingsRequestExample1.yaml" - - target: "$.paths['/_resolve/index/{name}']['get']" - description: "Add examples for resolve index operation" - update: - responses: - 200: - content: - application/json: - examples: - indicesResolveResponseExample1: - $ref: "../../specification/indices/resolve_index/examples/response/ResolveIndexResponseExample1.yaml" - - target: "$.components['requestBodies']['indices.rollover']" - description: "Add example for rollover index request" - update: - content: - application/json: - examples: - indicesRolloverRequestExample1: - $ref: "../../specification/indices/rollover/examples/request/indicesRolloverRequestExample1.yaml" - - target: "$.components['responses']['indices.rollover#200']" - description: "Add example for rollover index response" - update: - content: - application/json: - examples: - indicesRolloverResponseExample1: - $ref: "../../specification/indices/rollover/examples/200_response/indicesRolloverResponseExample1.yaml" - - target: "$.paths['/{index}/_block/{block}']['put']" - description: "Add examples for add index block operation" - update: - responses: - 200: - content: - application/json: - examples: - indicesAddBlockResponseExample1: - $ref: "../../specification/indices/add_block/examples/response/IndicesAddBlockResponseExample1.yaml" - - target: "$.components['requestBodies']['indices.analyze']" - description: "Add example for analyze API request" - update: - content: - application/json: - examples: - indicesAnalyzeRequestExample1: - $ref: "../../specification/indices/analyze/examples/request/indicesAnalyzeRequestExample1.yaml" - - target: "$.paths['/{index}']['put']" - description: "Add examples for create index request" - update: - requestBody: - content: - application/json: - examples: - indicesCreateRequestExample1: - $ref: "../../specification/indices/create/examples/request/indicesCreateRequestExample1.yaml" - indicesCreateRequestExample2: - $ref: "../../specification/indices/create/examples/request/indicesCreateRequestExample2.yaml" - - target: "$.components['requestBodies']['cluster.put_component_template']" - description: "Add example for put component template request" - update: - content: - application/json: - examples: - clusterPutComponentTemplateRequestExample1: - $ref: "../../specification/cluster/put_component_template/examples/request/ClusterPutComponentTemplateRequestExample1.yaml" - clusterPutComponentTemplateRequestExample2: - $ref: "../../specification/cluster/put_component_template/examples/request/ClusterPutComponentTemplateRequestExample2.yaml" -## Examples for info - - target: "$.paths['/']['get']" - description: "Add examples for cluster info" - update: - responses: - 200: - content: - application/json: - examples: - clusterInfoResponseExample1: - $ref: "../../specification/_global/info/examples/response/RootNodeInfoResponseExample1.yaml" -## Examples for ingest - - target: "$.components['responses']['ingest.get_pipeline#200']" - description: "Add example for get pipeline response" - update: - content: - application/json: - examples: - indicesGetDataStreamResponseExample: - $ref: "../../specification/ingest/get_pipeline/examples/200_response/GetPipelineResponseExample1.yaml" - - target: "$.paths['/_ingest/pipeline/{id}']['put']" - description: "Add examples for create pipeline" - update: - requestBody: - content: - application/json: - examples: - putPipelineRequestExample1: - $ref: "../../specification/ingest/put_pipeline/examples/request/PutPipelineRequestExample1.yaml" - putPipelineRequestExample2: - $ref: "../../specification/ingest/put_pipeline/examples/request/PutPipelineRequestExample2.yaml" - - target: "$.components['requestBodies']['ingest.simulate']" - description: "Add example for simulate pipeline request" - update: - content: - application/json: - examples: - simulatePipelineRequestExample1: - $ref: "../../specification/ingest/simulate/examples/request/SimulatePipelineRequestExample1.yaml" - - target: "$.components['responses']['ingest.simulate#200']" - description: "Add example for simulate pipeline response" - update: - content: - application/json: - examples: - simulatePipelineResponseExample1: - $ref: "../../specification/ingest/simulate/examples/response/SimulatePipelineResponseExample1.yaml"## Examples for behavioral analytics -## Examples for licensing - - target: "$.paths['/_license']['get']" - description: "Add example for get license response" - update: - responses: - 200: - content: - application/json: - examples: - getLicenseResponseExample1: - $ref: "../../specification/license/get/examples/response/GetLicenseResponseExample1.yaml" -## Examples for machine learning - - target: "$.paths['/_ml/data_frame/_evaluate']['post']" - description: "Add examples for evaluate data frame analytics" - update: - requestBody: - content: - application/json: - examples: - mlDataFrameAnalyticsEvaluateRequestExample1: - $ref: "../../specification/ml/evaluate_data_frame/examples/request/MlEvaluateDataFrameRequestExample1.yaml" - mlDataFrameAnalyticsEvaluateRequestExample2: - $ref: "../../specification/ml/evaluate_data_frame/examples/request/MlEvaluateDataFrameRequestExample2.yaml" - mlDataFrameAnalyticsEvaluateRequestExample3: - $ref: "../../specification/ml/evaluate_data_frame/examples/request/MlEvaluateDataFrameRequestExample3.yaml" - mlDataFrameAnalyticsEvaluateRequestExample4: - $ref: "../../specification/ml/evaluate_data_frame/examples/request/MlEvaluateDataFrameRequestExample4.yaml" - mlDataFrameAnalyticsEvaluateRequestExample5: - $ref: "../../specification/ml/evaluate_data_frame/examples/request/MlEvaluateDataFrameRequestExample5.yaml" - responses: - 200: - content: - application/json: - examples: - mlDataFrameAnalyticsEvaluateResponseExample1: - $ref: "../../specification/ml/evaluate_data_frame/examples/response/MlEvaluateDataFrameResponseExample1.yaml" - mlDataFrameAnalyticsEvaluateResponseExample2: - $ref: "../../specification/ml/evaluate_data_frame/examples/response/MlEvaluateDataFrameResponseExample2.yaml" - mlDataFrameAnalyticsEvaluateResponseExample3: - $ref: "../../specification/ml/evaluate_data_frame/examples/response/MlEvaluateDataFrameResponseExample3.yaml" - - target: "$.paths['/_ml/anomaly_detectors/_estimate_model_memory']['post']" - description: "Add examples for estimate anomaly job model memory" - update: - requestBody: - content: - application/json: - examples: - mlAnomalyJobEstimateRequestExample1: - $ref: "../../specification/ml/estimate_model_memory/examples/request/MlEstimatemodelMemoryRequestExample1.yaml" - responses: - 200: - content: - application/json: - examples: - mlAnomalyJobEstimateResponseExample1: - $ref: "../../specification/ml/estimate_model_memory/examples/response/MlEstimateModelMemoryResponseExample1.yaml" - - target: "$.paths['/_ml/anomaly_detectors/{job_id}']['put']" - description: "Add examples for create anomaly detection job" - update: - requestBody: - content: - application/json: - examples: - mlAnomalyJobCreateRequestExample1: - $ref: "../../specification/ml/put_job/examples/request/MlPutJobRequestExample1.yaml" - responses: - 200: - content: - application/json: - examples: - mlAnomalyJobCreateResponseExample1: - $ref: "../../specification/ml/put_job/examples/200_response/MlPutJobResponseExample1.yaml" - - target: "$.paths['/_ml/anomaly_detectors/{job_id}/_open']['post']" - description: "Add examples for open anomaly detection job" - update: - requestBody: - content: - application/json: - examples: - mlAnomalyJobOpenRequestExample1: - $ref: "../../specification/ml/open_job/examples/request/MlOpenJobRequestExample1.yaml" - responses: - 200: - content: - application/json: - examples: - mlAnomalyJobCreateResponseExample1: - $ref: "../../specification/ml/open_job/examples/200_response/MlOpenJobResponseExample1.yaml" - - target: "$.paths['/_ml/trained_models/{model_id}/model_aliases/{model_alias}']['delete']" - description: "Add examples for delete trained model alias" - update: - responses: - 200: - content: - application/json: - examples: - mlTrainedModelAliasDeleteResponseExample1: - $ref: "../../specification/ml/delete_trained_model_alias/examples/response/MlDeleteTrainedModelAliasResponseExample1.yaml" - - target: "$.paths['/_ml/trained_models/{model_id}']['delete']" - description: "Add examples for delete trained model" - update: - responses: - 200: - content: - application/json: - examples: - mlTrainedModelDeleteResponseExample1: - $ref: "../../specification/ml/delete_trained_model/examples/response/MlDeleteTrainedModelResponseExample1.yaml" - - target: "$.paths['/_ml/anomaly_detectors/{job_id}']['delete']" - description: "Add examples for delete anomaly detection job" - update: - responses: - 200: - content: - application/json: - examples: - mlAnomalyJobDeleteResponseExample1: - $ref: "../../specification/ml/delete_job/examples/response/MlDeleteJobResponseExample1.yaml" - mlAnomalyJobDeleteResponseExample2: - $ref: "../../specification/ml/delete_job/examples/response/MlDeleteJobResponseExample2.yaml" - - target: "$.paths['/_ml/filters/{filter_id}']['delete']" - description: "Add examples for delete filter" - update: - responses: - 200: - content: - application/json: - examples: - mlFilterDeleteResponseExample1: - $ref: "../../specification/ml/delete_filter/examples/response/MlDeleteFilterResponseExample1.yaml" - - target: "$.paths['/_ml/datafeeds/{datafeed_id}']['delete']" - description: "Add examples for delete data feed" - update: - responses: - 200: - content: - application/json: - examples: - mlDatafeedDeleteResponseExample1: - $ref: "../../specification/ml/delete_datafeed/examples/response/MlDeleteDatafeedResponseExample1.yaml" - - target: "$.paths['/_ml/data_frame/analytics/{id}']['delete']" - description: "Add examples for delete data frame analytics job" - update: - responses: - 200: - content: - application/json: - examples: - mlDataFrameAnalyticsDeleteResponseExample1: - $ref: "../../specification/ml/delete_data_frame_analytics/examples/response/MlDeleteDataFrameAnalyticsResponseExample1.yaml" - - target: "$.paths['/_ml/calendars/{calendar_id}/jobs/{job_id}']['delete']" - description: "Add examples for delete anomaly jobs from calendar" - update: - responses: - 200: - content: - application/json: - examples: - mlCalendarJobDeleteResponseExample1: - $ref: "../../specification/ml/delete_calendar_job/examples/response/MlDeleteCalendarJobResponseExample1.yaml" - - target: "$.paths['/_ml/calendars/{calendar_id}/events/{event_id}']['delete']" - description: "Add examples for delete event from calendar" - update: - responses: - 200: - content: - application/json: - examples: - mlCalendarEventDeleteResponseExample1: - $ref: "../../specification/ml/delete_calendar_event/examples/response/MlDeleteCalendarEventResponseExample1.yaml" - - target: "$.paths['/_ml/calendars/{calendar_id}']['delete']" - description: "Add examples for delete event from calendar" - update: - responses: - 200: - content: - application/json: - examples: - mlCalendarDeleteResponseExample1: - $ref: "../../specification/ml/delete_calendar/examples/response/MlDeleteCalendarResponseExample1.yaml" - - target: "$.paths['/_ml/anomaly_detectors/{job_id}/_close']['post']" - description: "Add examples for close anomaly job" - update: - responses: - 200: - content: - application/json: - examples: - mlAnomalyJobCloseResponseExample1: - $ref: "../../specification/ml/close_job/examples/response/MlCloseJobResponseExample1.yaml" -## Examples for script - - target: "$.components['requestBodies']['put_script']" - description: "Add example for create script request" - update: - content: - application/json: - examples: - putScriptRequestExample1: - $ref: "../../specification/_global/put_script/examples/request/PutScriptRequestExample1.yaml" - putScriptRequestExample2: - $ref: "../../specification/_global/put_script/examples/request/PutScriptRequestExample2.yaml" - - target: "$.components['requestBodies']['scripts_painless_execute']" - description: "Add example for run painless script request" - update: - content: - application/json: - examples: - runPainlessScriptRequestExample1: - $ref: "../../specification/_global/scripts_painless_execute/examples/request/ExecutePainlessScriptRequestExample1.yaml" - runPainlessScriptRequestExample2: - $ref: "../../specification/_global/scripts_painless_execute/examples/request/ExecutePainlessScriptRequestExample2.yaml" - runPainlessScriptRequestExample3: - $ref: "../../specification/_global/scripts_painless_execute/examples/request/ExecutePainlessScriptRequestExample3.yaml" - - target: "$.components['responses']['scripts_painless_execute#200']" - description: "Add example for run painless script response" - update: - content: - application/json: - examples: - runPainlessScriptResponseExample1: - $ref: "../../specification/_global/scripts_painless_execute/examples/response/ExecutePainlessScriptResponseExample1.yaml" - runPainlessScriptResponseExample2: - $ref: "../../specification/_global/scripts_painless_execute/examples/response/ExecutePainlessScriptResponseExample2.yaml" - runPainlessScriptResponseExample3: - $ref: "../../specification/_global/scripts_painless_execute/examples/response/ExecutePainlessScriptResponseExample3.yaml" -## Examples for search - - target: "$.components['requestBodies']['clear_scroll']" - description: "Add example for clear scroll request" - update: - content: - application/json: - examples: - clearScrollRequestExample1: - $ref: "../../specification/_global/clear_scroll/examples/request/ClearScrollRequestExample1.yaml" - - target: "$.paths['/_pit']['delete']" - description: "Add examples for close PIT operation" - update: - requestBody: - content: - application/json: - examples: - closePointInTimeRequestExample1: - $ref: "../../specification/_global/close_point_in_time/examples/request/ClosePointInTimeRequestExample1.yaml" - responses: - 200: - content: - application/json: - examples: - closePointInTimeResponseExample1: - $ref: "../../specification/_global/close_point_in_time/examples/200_response/ClosePointInTimeResponseExample1.yaml" - - target: "$.components['requestBodies']['count']" - description: "Add example for count request" - update: - content: - application/json: - examples: - countRequestExample1: - $ref: "../../specification/_global/count/examples/request/CountRequestExample1.yaml" - - target: "$.components['responses']['count#200']" - description: "Add example for count response" - update: - content: - application/json: - examples: - countResponseExample1: - $ref: "../../specification/_global/count/examples/200_response/CountResponseExample1.yaml" - - target: "$.components['requestBodies']['explain']" - description: "Add example for explain request" - update: - content: - application/json: - examples: - explainRequestExample1: - $ref: "../../specification/_global/explain/examples/request/ExplainRequestExample1.yaml" - - target: "$.components['responses']['explain#200']" - description: "Add example for explain response" - update: - content: - application/json: - examples: - explainResponseExample1: - $ref: "../../specification/_global/explain/examples/response/ExplainResponseExample1.yaml" - - target: "$.components['requestBodies']['field_caps']" - description: "Add example for field capabilities request" - update: - content: - application/json: - examples: - fieldCapabilitiesRequestExample1: - $ref: "../../specification/_global/field_caps/examples/request/FieldCapabilitiesRequestExample1.yaml" - - target: "$.components['responses']['field_caps#200']" - description: "Add example for field capabilities response" - update: - content: - application/json: - examples: - fieldCapabilitiesResponseExample1: - $ref: "../../specification/_global/field_caps/examples/response/FieldCapabilitiesResponseExample1.yaml" - fieldCapabilitiesResponseExample2: - $ref: "../../specification/_global/field_caps/examples/response/FieldCapabilitiesResponseExample2.yaml" - - target: "$.components['requestBodies']['msearch_template']" - description: "Add example for multi search template request" - update: - content: - application/json: - examples: - multiSearchTemplateRequestExample1: - $ref: "../../specification/_global/msearch_template/examples/request/MultiSearchTemplateRequestExample1.yaml" - - target: "$.paths['/{index}/_pit']['post']" - description: "Add examples for open PIT operation" - update: - responses: - 200: - content: - application/json: - examples: - openPointInTimeResponseExample1: - $ref: "../../specification/_global/open_point_in_time/examples/response/OpenPointInTimeResponseExample1.yaml" - - target: "$.components['requestBodies']['scroll']" - description: "Add example for scroll request" - update: - content: - application/json: - examples: - scrollRequestExample1: - $ref: "../../specification/_global/scroll/examples/request/ScrollRequestExample1.yaml" - - target: "$.components['requestBodies']['search']" - description: "Add example for search request" - update: - content: - application/json: - examples: - searchRequestExample1: - $ref: "../../specification/_global/search/examples/request/SearchRequestExample1.yaml" - searchRequestExample2: - $ref: "../../specification/_global/search/examples/request/SearchRequestExample2.yaml" - searchRequestExample3: - $ref: "../../specification/_global/search/examples/request/SearchRequestExample3.yaml" - - target: "$.components['responses']['search#200']" - description: "Add example for search response" - update: - content: - application/json: - examples: - searchResponseExample1: - $ref: "../../specification/_global/search/examples/200_response/SearchResponseExample1.yaml" - - target: "$.components['requestBodies']['search_mvt']" - description: "Add example for search MVT request" - update: - content: - application/json: - examples: - searchMvtRequestExample1: - $ref: "../../specification/_global/search_mvt/examples/request/SearchMvtRequestExample1.yaml" - - target: "$.components['responses']['search_mvt#200']" - description: "Add example for search MVT response" - update: - content: - application/json: - examples: - searchMvtResponseExample1: - $ref: "../../specification/_global/search_mvt/examples/response/SearchMvtResponseExample1.yaml" - - target: "$.components['responses']['search_shards#200']" - description: "Add example for search shards response" - update: - content: - application/json: - examples: - searchShardsResponseExample1: - $ref: "../../specification/_global/search_shards/examples/response/SearchShardsResponseExample1.yaml" - - target: "$.components['requestBodies']['search_template']" - description: "Add example for search template request" - update: - content: - application/json: - examples: - searchTemplateRequestExample1: - $ref: "../../specification/_global/search_template/examples/request/SearchTemplateRequestExample1.yaml" - - target: "$.components['requestBodies']['terms_enum']" - description: "Add example for terms enum request" - update: - content: - application/json: - examples: - termsEnumRequestExample1: - $ref: "../../specification/_global/terms_enum/examples/request/TermsEnumRequestExample1.yaml" - - target: "$.components['responses']['terms_enum#200']" - description: "Add example for terms enum response" - update: - content: - application/json: - examples: - termsEnumResponseExample1: - $ref: "../../specification/_global/terms_enum/examples/response/TermsEnumResponseExample1.yaml" - - target: "$.components['requestBodies']['termvectors']" - description: "Add example for term vectors request" - update: - content: - application/json: - examples: - termVectorsRequestExample1: - $ref: "../../specification/_global/termvectors/examples/request/TermVectorsRequestExample1.yaml" - termVectorsRequestExample2: - $ref: "../../specification/_global/termvectors/examples/request/TermVectorsRequestExample2.yaml" - termVectorsRequestExample3: - $ref: "../../specification/_global/termvectors/examples/request/TermVectorsRequestExample3.yaml" - termVectorsRequestExample4: - $ref: "../../specification/_global/termvectors/examples/request/TermVectorsRequestExample4.yaml" - termVectorsRequestExample5: - $ref: "../../specification/_global/termvectors/examples/request/TermVectorsRequestExample5.yaml" - - target: "$.components['responses']['termvectors#200']" - description: "Add example for term vectors response" - update: - content: - application/json: - examples: - termVectorsResponseExample1: - $ref: "../../specification/_global/termvectors/examples/response/TermVectorsResponseExample1.yaml" - termVectorsResponseExample2: - $ref: "../../specification/_global/termvectors/examples/response/TermVectorsResponseExample2.yaml" - termVectorsResponseExample3: - $ref: "../../specification/_global/termvectors/examples/response/TermVectorsResponseExample3.yaml" - - target: "$.components['requestBodies']['async_search.submit']" - description: "Add example for asynch search submit request" - update: - content: - application/json: - examples: - asyncSearchSubmitRequestExample1: - $ref: "../../specification/async_search/submit/examples/request/AsyncSearchSubmitRequestExample1.yaml" - - target: "$.components['responses']['async_search.submit#200']" - description: "Add example for asynch search submit response" - update: - content: - application/json: - examples: - asyncSearchSubmitResponseExample1: - $ref: "../../specification/async_search/submit/examples/response/AsyncSearchSubmitResponseExample1.yaml" - - target: "$.paths['/_async_search/status/{id}']['get']" - description: "Add examples for get async search status" - update: - responses: - 200: - content: - application/json: - examples: - asyncSearchStatusResponseExample1: - $ref: "../../specification/async_search/status/examples/response/AsyncSearchStatusResponseExample1.yaml" - asyncSearchStatusResponseExample2: - $ref: "../../specification/async_search/status/examples/response/AsyncSearchStatusResponseExample2.yaml" - asyncSearchStatusResponseExample3: - $ref: "../../specification/async_search/status/examples/response/AsyncSearchStatusResponseExample3.yaml" - - target: "$.paths['/_async_search/{id}']['get']" - description: "Add examples for get async search" - update: - responses: - 200: - content: - application/json: - examples: - asyncSearchResponseExample1: - $ref: "../../specification/async_search/get/examples/response/AsyncSearchGetResponseExample1.yaml" -## Examples for search applications - - target: "$.paths['/_application/search_application']['get']" - description: "Add examples for get search applications operation" - update: - responses: - 200: - content: - application/json: - examples: - getSearchApplicationsResponseExample1: - $ref: "../../specification/search_application/list/examples/200_response/SearchApplicationsListResponseExample1.yaml" - - target: "$.paths['/_application/search_application/{name}']['get']" - description: "Add examples for get search application details operation" - update: - responses: - 200: - content: - application/json: - examples: - getSearchApplicationResponseExample1: - $ref: "../../specification/search_application/get/examples/200_response/SearchApplicationGetResponseExample1.yaml" - - target: "$.paths['/_application/search_application/{name}']['put']" - description: "Add examples for create search application operation" - update: - requestBody: - content: - application/json: - examples: - putSearchApplicationRequestExample1: - $ref: "../../specification/search_application/put/examples/request/SearchApplicationPutRequestExample1.yaml" - - target: "$.components['requestBodies']['search_application.search']" - description: "Add example for search application search request" - update: - content: - application/json: - examples: - searchApplicationSearchRequestExample1: - $ref: "../../specification/search_application/search/examples/request/SearchApplicationsSearchRequestExample1.yaml" - - target: "$.components['responses']['search_application.get_behavioral_analytics#200']" - description: "Add example for get behavioral analytics collections response" - update: - content: - application/json: - examples: - getBehavioralAnalyticsCollectionsResponseExample1: - $ref: "../../specification/search_application/get_behavioral_analytics/examples/200_response/BehavioralAnalyticsGetResponseExample1.yaml" -## Examples for transforms - - target: "$.paths['/_transform/{transform_id}']['put']" - description: "Add examples for create transform operation" - update: - requestBody: - content: - application/json: - examples: - createTransformRequestExample1: - $ref: "../../specification/transform/put_transform/examples/request/PutTransformRequestExample1.yaml" - createTransformRequestExample2: - $ref: "../../specification/transform/put_transform/examples/request/PutTransformRequestExample2.yaml" - responses: - 200: - content: - application/json: - examples: - createTransformResponseExample1: - $ref: "../../specification/transform/put_transform/examples/response/PutTransformResponseExample1.yaml" - - target: "$.components['requestBodies']['transform.preview_transform']" - description: "Add examples for preview transform operation" - update: - content: - application/json: - examples: - previewTransformRequestExample1: - $ref: "../../specification/transform/preview_transform/examples/request/PreviewTransformRequestExample1.yaml" - - target: "$.components['responses']['transform.preview_transform#200']" - description: "Add examples for preview transform operation" - update: - content: - application/json: - examples: - previewTransformResponseExample1: - $ref: "../../specification/transform/preview_transform/examples/response/PreviewTransformResponseExample1.yaml" - - target: "$.paths['/_transform/{transform_id}/_update']['post']" - description: "Add examples for update transform operation" - update: - requestBody: - content: - application/json: - examples: - updateTransformRequestExample1: - $ref: "../../specification/transform/update_transform/examples/request/UpdateTransformRequestExample1.yaml" - responses: - 200: - content: - application/json: - examples: - updateTransformResponseExample1: - $ref: "../../specification/transform/update_transform/examples/response/UpdateTransformResponseExample1.yaml" - - target: "$.paths['/_transform/{transform_id}/_stop']['post']" - description: "Add examples for transform stop" - update: - responses: - 200: - content: - application/json: - examples: - transformStopResponseExample1: - $ref: "../../specification/transform/stop_transform/examples/response/StopTransformResponseExample1.yaml" - - target: "$.paths['/_transform/{transform_id}/_start']['post']" - description: "Add examples for transform start" - update: - responses: - 200: - content: - application/json: - examples: - transformStartResponseExample1: - $ref: "../../specification/transform/start_transform/examples/response/StartTransformResponseExample1.yaml" - - target: "$.paths['/_transform/{transform_id}/_schedule_now']['post']" - description: "Add examples for transform schedule now" - update: - responses: - 200: - content: - application/json: - examples: - transformScheduleNowResponseExample1: - $ref: "../../specification/transform/schedule_now_transform/examples/response/ScheduleNowTransformResponseExample1.yaml" - - target: "$.paths['/_transform/{transform_id}/_reset']['post']" - description: "Add examples for transform reset" - update: - responses: - 200: - content: - application/json: - examples: - transformResetResponseExample1: - $ref: "../../specification/transform/reset_transform/examples/response/ResetTransformResponseExample1.yaml" - - target: "$.paths['/_transform/{transform_id}/_stats']['get']" - description: "Add examples for transform get stats" - update: - responses: - 200: - content: - application/json: - examples: - transformGetStatsResponseExample1: - $ref: "../../specification/transform/get_transform_stats/examples/response/GetTransformStatsResponseExample1.yaml" - - target: "$.paths['/_transform/{transform_id}']['delete']" - description: "Add examples for transform delete" - update: - responses: - 200: - content: - application/json: - examples: - transformDeleteResponseExample1: - $ref: "../../specification/transform/delete_transform/examples/response/DeleteTransformResponseExample1.yaml" - - target: "$.components['transform.get_transform#200']" - description: "Add examples for transform get" - update: - content: - application/json: - examples: - transformGetResponseExample1: - $ref: "../../specification/transform/get_transform/examples/response/GetTransformResponseExample1.yaml" ## xCodeSamples - target: "$.paths['/{index}/_doc/{id}']['head']" description: "Add xCodeSamples for check document operation" From 92f8da000382ca34598127d7d3d10a07977f5449 Mon Sep 17 00:00:00 2001 From: lcawl Date: Wed, 12 Mar 2025 13:04:35 -0700 Subject: [PATCH 5/6] Regenerate output --- output/openapi/elasticsearch-openapi.json | 80 +++++++++---------- .../elasticsearch-serverless-openapi.json | 6 +- output/schema/schema.json | 80 +++++++++---------- 3 files changed, 83 insertions(+), 83 deletions(-) diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 0d3163c785..336cc66db0 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -11823,7 +11823,7 @@ } }, "examples": { - "RequestExample1": { + "MigrateToDataTiersRequestExample1": { "description": "Run `POST /_ilm/migrate_to_data_tiers` to migrate the indices, ILM policies, legacy templates, composable, and component templates away from defining custom allocation filtering using the `custom_attribute_name` node attribute. It also deletes the legacy template with name `global-template` if it exists in the system.\n", "value": "{\n \"legacy_template_to_delete\": \"global-template\",\n \"node_attribute\": \"custom_attribute_name\"\n}" } @@ -11889,7 +11889,7 @@ ] }, "examples": { - "ResponseExample1": { + "MigrateToDataTiersResponseExample1": { "description": "A successful response when migrating indices, ILMs, and templates from custom node attributes to data tiers.\n", "value": "{\n \"dry_run\": false,\n \"removed_legacy_template\":\"global-template\",\n \"migrated_ilm_policies\":[\"policy_with_allocate_action\"],\n \"migrated_indices\":[\"warm-index-to-migrate-000001\"],\n \"migrated_legacy_templates\":[\"a-legacy-template\"],\n \"migrated_composable_templates\":[\"a-composable-template\"],\n \"migrated_component_templates\":[\"a-component-template\"]\n}" } @@ -14428,7 +14428,7 @@ "$ref": "#/components/schemas/indices._types:DownsampleConfig" }, "examples": { - "RequestExample1": { + "DownsampleRequestExample1": { "value": "{\n \"fixed_interval\": \"1d\"\n}" } } @@ -31258,7 +31258,7 @@ ] }, "examples": { - "RequestExample1": { + "ActivateUserProfileRequestExample1": { "description": "Run `POST /_security/profile/_activate` to activate a user profile.\n", "value": "{\n \"grant_type\": \"password\",\n \"username\" : \"jacknich\",\n \"password\" : \"l0ng-r4nd0m-p@ssw0rd\"\n}" } @@ -31276,7 +31276,7 @@ "$ref": "#/components/schemas/security._types:UserProfileWithMetadata" }, "examples": { - "ResponseExample1": { + "ActivateUserProfileResponseExample1": { "description": "A successful response from `POST /_security/profile/_activate`.", "value": "{\n \"uid\": \"u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0\",\n \"enabled\": true,\n \"last_synchronized\": 1642650651037,\n \"user\": {\n \"username\": \"jacknich\",\n \"roles\": [\n \"admin\", \"other_role1\"\n ],\n \"realm_name\": \"native\",\n \"full_name\": \"Jack Nicholson\",\n \"email\": \"jacknich@example.com\"\n },\n \"labels\": {},\n \"data\": {},\n \"_doc\": {\n \"_primary_term\": 88,\n \"_seq_no\": 66\n }\n}" } @@ -33474,7 +33474,7 @@ ] }, "examples": { - "ResponseExample1": { + "EnrollKibanaResponseExample1": { "description": "A successful response from `GET /_security/enroll/kibana`.", "value": "{\n \"token\" : {\n \"name\" : \"enroll-process-token-1629123923000\", \n \"value\": \"AAEAAWVsYXN0aWM...vZmxlZXQtc2VydmVyL3Rva2VuMTo3TFdaSDZ\" \n },\n \"http_ca\" : \"MIIJlAIBAzVoGCSqGSIb3...vsDfsA3UZBAjEPfhubpQysAICAA=\", \n}" } @@ -33540,7 +33540,7 @@ ] }, "examples": { - "ResponseExample1": { + "EnrollNodeResponseExample1": { "description": "A successful response from `PGET /security/enroll/node`.", "value": "{\n \"http_ca_key\" : \"MIIJlAIBAzCCCVoGCSqGSIb3DQEHAaCCCUsEgglHMIIJQzCCA98GCSqGSIb3DQ....vsDfsA3UZBAjEPfhubpQysAICCAA=\", \n \"http_ca_cert\" : \"MIIJlAIBAzCCCVoGCSqGSIb3DQEHAaCCCUsEgglHMIIJQzCCA98GCSqGSIb3DQ....vsDfsA3UZBAjEPfhubpQysAICCAA=\", \n \"transport_ca_cert\" : \"MIIJlAIBAzCCCVoGCSqGSIb3DQEHAaCCCUsEgglHMIIJQzCCA98GCSqG....vsDfsA3UZBAjEPfhubpQysAICCAA=\", \n \"transport_key\" : \"MIIEJgIBAzCCA98GCSqGSIb3DQEHAaCCA9AEggPMMIIDyDCCA8QGCSqGSIb3....YuEiOXvqZ6jxuVSQ0CAwGGoA==\", \n \"transport_cert\" : \"MIIEJgIBAzCCA98GCSqGSIb3DQEHAaCCA9AEggPMMIIDyDCCA8QGCSqGSIb3....YuEiOXvqZ6jxuVSQ0CAwGGoA==\", \n \"nodes_addresses\" : [ \n \"192.168.1.2:9300\"\n ]\n}" } @@ -34432,17 +34432,17 @@ ] }, "examples": { - "ResponseExample1": { + "GetUserProfileResponseExample1": { "summary": "Profile details for a UUID", "description": "A successful response from `GET /_security/profile/u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0`. By default, no content is returned in the `data` field.\n", "value": "{\n \"profiles\": [\n {\n \"uid\": \"u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0\",\n \"enabled\": true,\n \"last_synchronized\": 1642650651037,\n \"user\": {\n \"username\": \"jacknich\",\n \"roles\": [\n \"admin\", \"other_role1\"\n ],\n \"realm_name\": \"native\",\n \"full_name\": \"Jack Nicholson\",\n \"email\": \"jacknich@example.com\"\n },\n \"labels\": {\n \"direction\": \"north\"\n },\n \"data\": {}, \n \"_doc\": {\n \"_primary_term\": 88,\n \"_seq_no\": 66\n }\n }\n ]\n}" }, - "ResponseExample2": { + "GetUserProfileResponseExample2": { "summary": "Profile details for a UUID and data key", "description": "A successful response from `GET /_security/profile/u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0?data=app1.key1`.\n", "value": "{\n \"profiles\": [\n {\n \"uid\": \"u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0\",\n \"enabled\": true,\n \"last_synchronized\": 1642650651037,\n \"user\": {\n \"username\": \"jacknich\",\n \"roles\": [\n \"admin\", \"other_role1\"\n ],\n \"realm_name\": \"native\",\n \"full_name\": \"Jack Nicholson\",\n \"email\": \"jacknich@example.com\"\n },\n \"labels\": {\n \"direction\": \"north\"\n },\n \"data\": {\n \"app1\": {\n \"key1\": \"value1\"\n }\n },\n \"_doc\": {\n \"_primary_term\": 88,\n \"_seq_no\": 66\n }\n }\n ]\n}" }, - "ResponseExample3": { + "GetUserProfileResponseExample3": { "summary": "Profile details with errors", "description": "A response that contains errors that occurred while retrieving user profiles.\n", "value": "{\n \"profiles\": [],\n \"errors\": {\n \"count\": 1,\n \"details\": {\n \"u_FmxQt3gr1BBH5wpnz9HkouPj3Q710XkOgg1PWkwLPBW_5\": {\n \"type\": \"resource_not_found_exception\",\n \"reason\": \"profile document not found\"\n }\n }\n }\n}" @@ -34722,7 +34722,7 @@ ] }, "examples": { - "RequestExample1": { + "OidcAuthenticateRequestExample1": { "description": "Run `POST /_security/oidc/authenticate` to exchange the response that was returned from the OpenID Connect Provider after a successful authentication for an Elasticsearch access token and refresh token. This example is from an authentication that uses the authorization code grant flow.\n", "value": "{\n \"redirect_uri\" : \"https://oidc-kibana.elastic.co:5603/api/security/oidc/callback?code=jtI3Ntt8v3_XvcLzCFGq&state=4dbrihtIAt3wBTwo6DxK-vdk-sSyDBV8Yf0AjdkdT5I\",\n \"state\" : \"4dbrihtIAt3wBTwo6DxK-vdk-sSyDBV8Yf0AjdkdT5I\",\n \"nonce\" : \"WaBPH0KqPVdG5HHdSxPRjfoZbXMCicm5v1OiAj0DUFM\",\n \"realm\" : \"oidc1\"\n}" } @@ -34764,7 +34764,7 @@ ] }, "examples": { - "ResponseExample1": { + "OidcAuthenticateResponseExample1": { "description": "A successful response from `POST /_security/oidc/authenticate`. It contains the access and refresh tokens that were generated, the token duration (in seconds), and the type.\n", "value": "{\n \"access_token\" : \"dGhpcyBpcyBub3QgYSByZWFsIHRva2VuIGJ1dCBpdCBpcyBvbmx5IHRlc3QgZGF0YS4gZG8gbm90IHRyeSB0byByZWFkIHRva2VuIQ==\",\n \"type\" : \"Bearer\",\n \"expires_in\" : 1200,\n \"refresh_token\": \"vLBPvmAB6KvwvJZr27cS\"\n}" } @@ -34803,7 +34803,7 @@ ] }, "examples": { - "RequestExample1": { + "OidcLogoutRequestExample1": { "description": "Run `POST /_security/oidc/logout` to perform the logout.", "value": "{\n \"token\" : \"dGhpcyBpcyBub3QgYSByZWFsIHRva2VuIGJ1dCBpdCBpcyBvbmx5IHRlc3QgZGF0YS4gZG8gbm90IHRyeSB0byByZWFkIHRva2VuIQ==\",\n \"refresh_token\": \"vLBPvmAB6KvwvJZr27cS\"\n}" } @@ -34830,7 +34830,7 @@ ] }, "examples": { - "ResponseExample1": { + "OidcLogoutResponseExample1": { "description": "A successful response from `POST /_security/oidc/logout`, which contains the URI pointing to the End Session Endpoint of the OpenID Connect Provider with all the parameters of the Logout Request as HTTP GET parameters.", "value": "{\n \"redirect\" : \"https://op-provider.org/logout?id_token_hint=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c&post_logout_redirect_uri=http%3A%2F%2Foidc-kibana.elastic.co%2Floggedout&state=lGYK0EcSLjqH6pkT5EVZjC6eIW5YCGgywj2sxROO\"\n}" } @@ -34878,17 +34878,17 @@ } }, "examples": { - "RequestExample1": { + "OidcPrepareAuthenticationRequestExample1": { "summary": "Prepare with realm", "description": "Run `POST /_security/oidc/prepare` to generate an authentication request for the OpenID Connect Realm `oidc1`.\n", "value": "{\n \"realm\" : \"oidc1\"\n}" }, - "RequestExample2": { + "OidcPrepareAuthenticationRequestExample2": { "summary": "Prepare with realm, state, and nonce", "description": "Run `POST /_security/oidc/prepare` to generate an authentication request for the OpenID Connect Realm `oidc1`, where the values for the `state` and the `nonce` have been generated by the client.\n", "value": "{\n \"realm\" : \"oidc1\",\n \"state\" : \"lGYK0EcSLjqH6pkT5EVZjC6eIW5YCGgywj2sxROO\",\n \"nonce\" : \"zOBXLJGUooRrbLbQk5YCcyC8AXw3iloynvluYhZ5\"\n}" }, - "RequestExample3": { + "OidcPrepareAuthenticationRequestExample3": { "summary": "Prepare by realm", "description": "Run `POST /_security/oidc/prepare` to generate an authentication request for a third party initiated single sign on. Specify the issuer that should be used for matching the appropriate OpenID Connect Authentication realm.\n", "value": "{\n \"iss\" : \"http://127.0.0.1:8080\",\n \"login_hint\": \"this_is_an_opaque_string\"\n}" @@ -34928,7 +34928,7 @@ ] }, "examples": { - "ResponseExample1": { + "OidcPrepareAuthenticationResponseExample1": { "description": "A successful response from `POST /_security/oidc/prepare`. It contains the URI pointing to the Authorization Endpoint of the OpenID Connect Provider with all the parameters of the Authentication Request as HTTP GET parameters.\n", "value": "{\n \"redirect\" : \"http://127.0.0.1:8080/c2id-login?scope=openid&response_type=id_token&redirect_uri=https%3A%2F%2Fmy.fantastic.rp%2Fcb&state=4dbrihtIAt3wBTwo6DxK-vdk-sSyDBV8Yf0AjdkdT5I&nonce=WaBPH0KqPVdG5HHdSxPRjfoZbXMCicm5v1OiAj0DUFM&client_id=elasticsearch-rp\",\n \"state\" : \"4dbrihtIAt3wBTwo6DxK-vdk-sSyDBV8Yf0AjdkdT5I\",\n \"nonce\" : \"WaBPH0KqPVdG5HHdSxPRjfoZbXMCicm5v1OiAj0DUFM\",\n \"realm\" : \"oidc1\"\n}" } @@ -35114,7 +35114,7 @@ ] }, "examples": { - "RequestExample1": { + "SamlAuthenticateRequestExample1": { "description": "Run `POST /_security/saml/authenticate` to exchange a SAML Response indicating a successful authentication at the SAML IdP for an Elasticsearch access token and refresh token to be used in subsequent requests.\n", "value": "{\n \"content\" : \"PHNhbWxwOlJlc3BvbnNlIHhtbG5zOnNhbWxwPSJ1cm46b2FzaXM6bmFtZXM6dGM6U0FNTDoyLjA6cHJvdG9jb2wiIHhtbG5zOnNhbWw9InVybjpvYXNpczpuYW1lczp0YzpTQU1MOjIuMD.....\",\n \"ids\" : [\"4fee3b046395c4e751011e97f8900b5273d56685\"]\n}" } @@ -35161,7 +35161,7 @@ ] }, "examples": { - "ResponseExample1": { + "SamlAuthenticateResponseExample1": { "description": "A successful response from `POST /_security/saml/authenticate`.", "value": "{\n \"access_token\" : \"46ToAxZVaXVVZTVKOVF5YU04ZFJVUDVSZlV3\",\n \"username\" : \"Bearer\",\n \"expires_in\" : 1200,\n \"refresh_token\": \"mJdXLtmvTUSpoLwMvdBt_w\",\n \"realm\": \"saml1\"\n}" } @@ -35212,12 +35212,12 @@ ] }, "examples": { - "RequestExample1": { + "SamlCompleteLogoutRequestExample1": { "summary": "HTTP-Redirect binding", "description": "Run `POST /_security/saml/complete_logout` to verify the logout response sent by the SAML IdP using the HTTP-Redirect binding.\n", "value": "{\n \"realm\": \"saml1\",\n \"ids\": [ \"_1c368075e0b3...\" ],\n \"query_string\": \"SAMLResponse=fZHLasMwEEVbfb1bf...&SigAlg=http%3A%2F%2Fwww.w3.org%2F2000%2F09%2Fxmldsig%23rsa-sha1&Signature=CuCmFn%2BLqnaZGZJqK...\"\n}" }, - "RequestExample2": { + "SamlCompleteLogoutRequestExample2": { "summary": "HTTP-Post binding", "description": "Run `POST /_security/saml/complete_logout` to verify the logout response sent by the SAML IdP using the HTTP-Post binding.\n", "value": "{\n \"realm\": \"saml1\",\n \"ids\": [ \"_1c368075e0b3...\" ],\n \"content\": \"PHNhbWxwOkxvZ291dFJlc3BvbnNlIHhtbG5zOnNhbWxwPSJ1cm46...\"\n}" @@ -35273,7 +35273,7 @@ ] }, "examples": { - "RequestExample1": { + "SamlInvalidateRequestExample1": { "description": "Run `POST /_security/saml/invalidate` to invalidate all the tokens for realm `saml1` pertaining to the user that is identified in the SAML Logout Request.\n", "value": "{\n \"query_string\" : \"SAMLRequest=nZFda4MwFIb%2FiuS%2BmviRpqFaClKQdbvo2g12M2KMraCJ9cRR9utnW4Wyi13sMie873MeznJ1aWrnS3VQGR0j4mLkKC1NUeljjA77zYyhVbIE0dR%2By7fmaHq7U%2BdegXWGpAZ%2B%2F4pR32luBFTAtWgUcCv56%2Fp5y30X87Yz1khTIycdgpUW9kY7WdsC9zxoXTvMvWuVV98YyMnSGH2SYE5pwALBIr9QKiwDGpW0oGVUznGeMyJZKFkQ4jBf5HnhUymjIhzCAL3KNFihbYx8TBYzzGaY7EnIyZwHzCWMfiDnbRIftkSjJr%2BFu0e9v%2B0EgOquRiiZjKpiVFp6j50T4WXoyNJ%2FEWC9fdqc1t%2F1%2B2F3aUpjzhPiXpqMz1%2FHSn4A&SigAlg=http%3A%2F%2Fwww.w3.org%2F2001%2F04%2Fxmldsig-more%23rsa-sha256&Signature=MsAYz2NFdovMG2mXf6TSpu5vlQQyEJAg%2B4KCwBqJTmrb3yGXKUtIgvjqf88eCAK32v3eN8vupjPC8LglYmke1ZnjK0%2FKxzkvSjTVA7mMQe2AQdKbkyC038zzRq%2FYHcjFDE%2Bz0qISwSHZY2NyLePmwU7SexEXnIz37jKC6NMEhus%3D\",\n \"realm\" : \"saml1\"\n}" } @@ -35310,7 +35310,7 @@ ] }, "examples": { - "ResponseExample1": { + "SamlInvalidateResponseExample1": { "description": "A successful response from `POST /_security/saml/invalidate`.", "value": "{\n \"redirect\" : \"https://my-idp.org/logout/SAMLResponse=....\",\n \"invalidated\" : 2,\n \"realm\" : \"saml1\"\n}" } @@ -35353,7 +35353,7 @@ ] }, "examples": { - "RequestExample1": { + "SamlLogoutRequestExample1": { "description": "Run `POST /_security/saml/logout` to invalidate the pair of tokens that were generated by calling the SAML authenticate API with a successful SAML response.\n", "value": "{\n \"token\" : \"46ToAxZVaXVVZTVKOVF5YU04ZFJVUDVSZlV3\",\n \"refresh_token\" : \"mJdXLtmvTUSpoLwMvdBt_w\"\n}" } @@ -35380,7 +35380,7 @@ ] }, "examples": { - "ResponseExample1": { + "SamlLogoutResponseExample1": { "description": "A successful response from `POST /_security/saml/logout`.", "value": "{\n \"redirect\" : \"https://my-idp.org/logout/SAMLRequest=....\"\n}" } @@ -35424,12 +35424,12 @@ } }, "examples": { - "RequestExample1": { + "SamlPrepareAuthenticationRequestExample1": { "summary": "Prepare with a realm", "description": "Run `POST /_security/saml/prepare` to generate a SAML authentication request for the SAML realm named `saml1`.\n", "value": "{\n \"realm\" : \"saml1\"\n}" }, - "RequestExample2": { + "SamlPrepareAuthenticationRequestExample2": { "summary": "Prepare with an ACS", "description": "Run `POST /_security/saml/prepare` to generate a SAML authentication request for the SAML realm with an Assertion Consuming Service (ACS) URL.\n", "value": "{\n \"acs\" : \"https://kibana.org/api/security/saml/callback\"\n}" @@ -35466,7 +35466,7 @@ ] }, "examples": { - "ResponseExample1": { + "SAmlPrepareAuthenticationResponseExample1": { "description": "A successful response from `POST /_security/saml/prepare`.", "value": "{\n \"redirect\": \"https://my-idp.org/login?SAMLRequest=fVJdc6IwFP0rmbwDgUKLGbFDtc462%2B06FX3Yl50rBJsKCZsbrPbXL6J22hdfk%2FNx7zl3eL%2BvK7ITBqVWCfVdRolQuS6k2iR0mU2dmN6Phgh1FTQ8be2rehH%2FWoGWdESF%2FPST0NYorgElcgW1QG5zvkh%2FPfHAZbwx2upcV5SkiMLYzmqsFba1MAthdjIXy5enhL5a23DPOyo6W7kGBa7cwhZ2gO7G8OiW%2BR400kORt0bag7fzezAlk24eqcD2OxxlsNN5O3MdsW9c6CZnbq7rntF4d3s0D7BaHTZhIWN52P%2BcjiuGRbDU6cdj%2BEjJbJLQv4N4ADdhxBiEZbQuWclY4Q8iABbCXczCdSiKMAC%2FgyO2YqbQgrIJDZg%2FcFjsMD%2Fzb3gUcBa5sR%2F9oWR%2BzuJBqlPG14Jbn0DIf2TZ3Jn%2FXmSUrC5ddQB6bob37uZrJdeF4dIDHV3iuhb70Ptq83kOz53ubDLXlcwPJK0q%2FT42AqxIaAkVCkqm2tRgr49yfJGFU%2FZQ3hy3QyuUpd7obPv97kb%2FAQ%3D%3D\"}\",\n \"realm\": \"saml1\",\n \"id\": \"_989a34500a4f5bf0f00d195aa04a7804b4ed42a1\"\n}" } @@ -35517,7 +35517,7 @@ ] }, "examples": { - "ResponseExample1": { + "SamlServiceProviderMetadataResponseExample1": { "description": "A successful response from `POST /_security/profile/u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0/_data`, which indicates that the request is acknowledged.\n", "value": "{\n \"acknowledged\": true\n}" } @@ -35618,12 +35618,12 @@ } }, "examples": { - "RequestExample1": { + "UpdateApiKeyRequestExample1": { "summary": "Update role and metadata", "description": "Run `PUT /_security/api_key/VuaCfGcBCdbkQm-e5aOx` to assign new role descriptors and metadata to an API key.\n", "value": "{\n \"role_descriptors\": {\n \"role-a\": {\n \"indices\": [\n {\n \"names\": [\"*\"],\n \"privileges\": [\"write\"]\n }\n ]\n }\n },\n \"metadata\": {\n \"environment\": {\n \"level\": 2,\n \"trusted\": true,\n \"tags\": [\"production\"]\n }\n }\n}" }, - "RequestExample2": { + "UpdateApiKeyRequestExample2": { "summary": "Remove permissions", "description": "Run `PUT /_security/api_key/VuaCfGcBCdbkQm-e5aOx` to remove the API key's previously assigned permissions. It will inherit the owner user's full permissions.\n", "value": "{\n \"role_descriptors\": {}\n}" @@ -35650,7 +35650,7 @@ ] }, "examples": { - "ResponseExample1": { + "UpdateApiKeyResponseExample1": { "summary": "Update role and metadata", "description": "A successful response from `PUT /_security/api_key/VuaCfGcBCdbkQm-e5aOx`. The API key's effective permissions after the update will be the intersection of the supplied role descriptors and the owner user's permissions.\n", "value": "{\n \"updated\": true\n}" @@ -100574,7 +100574,7 @@ ] }, "examples": { - "ResponseExample1": { + "CacheStatsResponseExample1": { "description": "A successful response from `GET /_searchable_snapshots/cache/stats`.", "value": "{\n \"nodes\" : {\n \"eerrtBMtQEisohZzxBLUSw\" : {\n \"shared_cache\" : {\n \"reads\" : 6051,\n \"bytes_read_in_bytes\" : 5448829,\n \"writes\" : 37,\n \"bytes_written_in_bytes\" : 1208320,\n \"evictions\" : 5,\n \"num_regions\" : 65536,\n \"size_in_bytes\" : 1099511627776,\n \"region_size_in_bytes\" : 16777216\n }\n }\n }\n}" } @@ -100901,7 +100901,7 @@ ] }, "examples": { - "ResponseExample1": { + "HasPrivilegesUserProfileResponseExample1": { "description": "A response from `POST /_security/profile/_has_privileges` that indicates only one of the three users has all the privileges and one of them is not found.\n", "value": "{\n \"has_privilege_uids\": [\"u_rzRnxDgEHIH0GOUoFkZr5Y27YUwSk19Joiq=g4OCxxB_1\"],\n \"errors\": {\n \"count\": 1,\n \"details\": {\n \"u_does-not-exist_0\": {\n \"type\": \"resource_not_found_exception\",\n \"reason\": \"profile document not found\"\n }\n }\n }\n}" } @@ -101189,7 +101189,7 @@ ] }, "examples": { - "ResponseExample1": { + "SuggestUserProfilesResponseExample1": { "description": "A successful response from `GET /_security/saml/metadata/saml1`. It contains the SAML metadata that was generated for the SAML realm as an XML string.\n", "value": "{\n \"metadata\" : \"\"\n}" } @@ -101205,7 +101205,7 @@ "$ref": "#/components/schemas/_types:AcknowledgedResponseBase" }, "examples": { - "ResponseExample1": { + "UpdateUserProfileDataResponseExample1": { "description": "A successful response from `POST /_security/profile/u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0/_data`, which indicates that the request is acknowledged.\n", "value": "{\n \"acknowledged\": true\n}" } @@ -114315,7 +114315,7 @@ ] }, "examples": { - "RequestExample1": { + "HasPrivilegesUserProfileRequestExample1": { "description": "Run `POST /_security/profile/_has_privileges` to check whether the two users associated with the specified profiles have all the requested set of cluster, index, and application privileges.\n", "value": "{\n \"uids\": [\n \"u_LQPnxDxEjIH0GOUoFkZr5Y57YUwSkL9Joiq-g4OCbPc_0\",\n \"u_rzRnxDgEHIH0GOUoFkZr5Y27YUwSk19Joiq=g4OCxxB_1\",\n \"u_does-not-exist_0\"\n ],\n \"privileges\": {\n \"cluster\": [ \"monitor\", \"create_snapshot\", \"manage_ml\" ],\n \"index\" : [\n {\n \"names\": [ \"suppliers\", \"products\" ],\n \"privileges\": [ \"create_doc\"]\n },\n {\n \"names\": [ \"inventory\" ],\n \"privileges\" : [ \"read\", \"write\" ]\n }\n ],\n \"application\": [\n {\n \"application\": \"inventory_manager\",\n \"privileges\" : [ \"read\", \"data:write/inventory\" ],\n \"resources\" : [ \"product/1852563\" ]\n }\n ]\n }\n}" } @@ -114771,7 +114771,7 @@ } }, "examples": { - "RequestExample1": { + "SuggestUserProfilesRequestExample1": { "description": "Run `POST /_security/profile/_suggest` to get suggestions for profile documents with name-related fields matching `jack`. It specifies both `uids` and `labels` hints for better relevance. The `labels` hint ranks profiles higher if their `direction` label matches either `north` or `east`.\n", "value": "{\n \"name\": \"jack\", \n \"hint\": {\n \"uids\": [ \n \"u_8RKO7AKfEbSiIHZkZZ2LJy2MUSDPWDr3tMI_CkIGApU_0\",\n \"u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0\"\n ],\n \"labels\": {\n \"direction\": [\"north\", \"east\"] \n }\n }\n}" } @@ -114802,7 +114802,7 @@ } }, "examples": { - "RequestExample1": { + "UpdateUserProfileDataRequestExample1": { "description": "Run `POST /_security/profile/u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0/_data` to update a profile document for the `u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0` user profile.\n", "value": "{\n \"labels\": {\n \"direction\": \"east\"\n },\n \"data\": {\n \"app1\": {\n \"theme\": \"default\"\n }\n }\n}" } diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index cbd32e82fe..1eb2cb0b98 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -19150,12 +19150,12 @@ } }, "examples": { - "RequestExample1": { + "UpdateApiKeyRequestExample1": { "summary": "Update role and metadata", "description": "Run `PUT /_security/api_key/VuaCfGcBCdbkQm-e5aOx` to assign new role descriptors and metadata to an API key.\n", "value": "{\n \"role_descriptors\": {\n \"role-a\": {\n \"indices\": [\n {\n \"names\": [\"*\"],\n \"privileges\": [\"write\"]\n }\n ]\n }\n },\n \"metadata\": {\n \"environment\": {\n \"level\": 2,\n \"trusted\": true,\n \"tags\": [\"production\"]\n }\n }\n}" }, - "RequestExample2": { + "UpdateApiKeyRequestExample2": { "summary": "Remove permissions", "description": "Run `PUT /_security/api_key/VuaCfGcBCdbkQm-e5aOx` to remove the API key's previously assigned permissions. It will inherit the owner user's full permissions.\n", "value": "{\n \"role_descriptors\": {}\n}" @@ -19182,7 +19182,7 @@ ] }, "examples": { - "ResponseExample1": { + "UpdateApiKeyResponseExample1": { "summary": "Update role and metadata", "description": "A successful response from `PUT /_security/api_key/VuaCfGcBCdbkQm-e5aOx`. The API key's effective permissions after the update will be the intersection of the supplied role descriptors and the owner user's permissions.\n", "value": "{\n \"updated\": true\n}" diff --git a/output/schema/schema.json b/output/schema/schema.json index 4edfaae67d..94d83cdd24 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -128813,7 +128813,7 @@ }, "description": "Migrate to data tiers routing.\nSwitch the indices, ILM policies, and legacy, composable, and component templates from using custom node attributes and attribute-based allocation filters to using data tiers.\nOptionally, delete one legacy index template.\nUsing node roles enables ILM to automatically move the indices between data tiers.\n\nMigrating away from custom node attributes routing can be manually performed.\nThis API provides an automated way of performing three out of the four manual steps listed in the migration guide:\n\n1. Stop setting the custom hot attribute on new indices.\n1. Remove custom allocation settings from existing ILM policies.\n1. Replace custom allocation settings from existing indices with the corresponding tier preference.\n\nILM must be stopped before performing the migration.\nUse the stop ILM and get ILM status APIs to wait until the reported operation mode is `STOPPED`.", "examples": { - "RequestExample1": { + "MigrateToDataTiersRequestExample1": { "description": "Run `POST /_ilm/migrate_to_data_tiers` to migrate the indices, ILM policies, legacy templates, composable, and component templates away from defining custom allocation filtering using the `custom_attribute_name` node attribute. It also deletes the legacy template with name `global-template` if it exists in the system.\n", "value": "{\n \"legacy_template_to_delete\": \"global-template\",\n \"node_attribute\": \"custom_attribute_name\"\n}" } @@ -128962,7 +128962,7 @@ ] }, "examples": { - "ResponseExample1": { + "MigrateToDataTiersResponseExample1": { "description": "A successful response when migrating indices, ILMs, and templates from custom node attributes to data tiers.\n", "value": "{\n \"dry_run\": false,\n \"removed_legacy_template\":\"global-template\",\n \"migrated_ilm_policies\":[\"policy_with_allocate_action\"],\n \"migrated_indices\":[\"warm-index-to-migrate-000001\"],\n \"migrated_legacy_templates\":[\"a-legacy-template\"],\n \"migrated_composable_templates\":[\"a-composable-template\"],\n \"migrated_component_templates\":[\"a-component-template\"]\n}" } @@ -136900,7 +136900,7 @@ }, "description": "Downsample an index.\nAggregate a time series (TSDS) index and store pre-computed statistical summaries (`min`, `max`, `sum`, `value_count` and `avg`) for each metric field grouped by a configured time interval.\nFor example, a TSDS index that contains metrics sampled every 10 seconds can be downsampled to an hourly index.\nAll documents within an hour interval are summarized and stored as a single document in the downsample index.\n\nNOTE: Only indices in a time series data stream are supported.\nNeither field nor document level security can be defined on the source index.\nThe source index must be read only (`index.blocks.write: true`).", "examples": { - "RequestExample1": { + "DownsampleRequestExample1": { "value": "{\n \"fixed_interval\": \"1d\"\n}" } }, @@ -198026,7 +198026,7 @@ ] }, "examples": { - "ResponseExample1": { + "CacheStatsResponseExample1": { "description": "A successful response from `GET /_searchable_snapshots/cache/stats`.", "value": "{\n \"nodes\" : {\n \"eerrtBMtQEisohZzxBLUSw\" : {\n \"shared_cache\" : {\n \"reads\" : 6051,\n \"bytes_read_in_bytes\" : 5448829,\n \"writes\" : 37,\n \"bytes_written_in_bytes\" : 1208320,\n \"evictions\" : 5,\n \"num_regions\" : 65536,\n \"size_in_bytes\" : 1099511627776,\n \"region_size_in_bytes\" : 16777216\n }\n }\n }\n}" } @@ -201452,7 +201452,7 @@ }, "description": "Activate a user profile.\n\nCreate or update a user profile on behalf of another user.\n\nNOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.\nIndividual users and external applications should not call this API directly.\nThe calling application must have either an `access_token` or a combination of `username` and `password` for the user that the profile document is intended for.\nElastic reserves the right to change or remove this feature in future releases without prior notice.\n\nThis API creates or updates a profile document for end users with information that is extracted from the user's authentication object including `username`, `full_name,` `roles`, and the authentication realm.\nFor example, in the JWT `access_token` case, the profile user's `username` is extracted from the JWT token claim pointed to by the `claims.principal` setting of the JWT realm that authenticated the token.\n\nWhen updating a profile document, the API enables the document if it was disabled.\nAny updates do not change existing content for either the `labels` or `data` fields.", "examples": { - "RequestExample1": { + "ActivateUserProfileRequestExample1": { "description": "Run `POST /_security/profile/_activate` to activate a user profile.\n", "value": "{\n \"grant_type\": \"password\",\n \"username\" : \"jacknich\",\n \"password\" : \"l0ng-r4nd0m-p@ssw0rd\"\n}" } @@ -201484,7 +201484,7 @@ } }, "examples": { - "ResponseExample1": { + "ActivateUserProfileResponseExample1": { "description": "A successful response from `POST /_security/profile/_activate`.", "value": "{\n \"uid\": \"u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0\",\n \"enabled\": true,\n \"last_synchronized\": 1642650651037,\n \"user\": {\n \"username\": \"jacknich\",\n \"roles\": [\n \"admin\", \"other_role1\"\n ],\n \"realm_name\": \"native\",\n \"full_name\": \"Jack Nicholson\",\n \"email\": \"jacknich@example.com\"\n },\n \"labels\": {},\n \"data\": {},\n \"_doc\": {\n \"_primary_term\": 88,\n \"_seq_no\": 66\n }\n}" } @@ -204451,7 +204451,7 @@ ] }, "examples": { - "ResponseExample1": { + "EnrollKibanaResponseExample1": { "description": "A successful response from `GET /_security/enroll/kibana`.", "value": "{\n \"token\" : {\n \"name\" : \"enroll-process-token-1629123923000\", \n \"value\": \"AAEAAWVsYXN0aWM...vZmxlZXQtc2VydmVyL3Rva2VuMTo3TFdaSDZ\" \n },\n \"http_ca\" : \"MIIJlAIBAzVoGCSqGSIb3...vsDfsA3UZBAjEPfhubpQysAICAA=\", \n}" } @@ -204602,7 +204602,7 @@ ] }, "examples": { - "ResponseExample1": { + "EnrollNodeResponseExample1": { "description": "A successful response from `PGET /security/enroll/node`.", "value": "{\n \"http_ca_key\" : \"MIIJlAIBAzCCCVoGCSqGSIb3DQEHAaCCCUsEgglHMIIJQzCCA98GCSqGSIb3DQ....vsDfsA3UZBAjEPfhubpQysAICCAA=\", \n \"http_ca_cert\" : \"MIIJlAIBAzCCCVoGCSqGSIb3DQEHAaCCCUsEgglHMIIJQzCCA98GCSqGSIb3DQ....vsDfsA3UZBAjEPfhubpQysAICCAA=\", \n \"transport_ca_cert\" : \"MIIJlAIBAzCCCVoGCSqGSIb3DQEHAaCCCUsEgglHMIIJQzCCA98GCSqG....vsDfsA3UZBAjEPfhubpQysAICCAA=\", \n \"transport_key\" : \"MIIEJgIBAzCCA98GCSqGSIb3DQEHAaCCA9AEggPMMIIDyDCCA8QGCSqGSIb3....YuEiOXvqZ6jxuVSQ0CAwGGoA==\", \n \"transport_cert\" : \"MIIEJgIBAzCCA98GCSqGSIb3DQEHAaCCA9AEggPMMIIDyDCCA8QGCSqGSIb3....YuEiOXvqZ6jxuVSQ0CAwGGoA==\", \n \"nodes_addresses\" : [ \n \"192.168.1.2:9300\"\n ]\n}" } @@ -206525,17 +206525,17 @@ ] }, "examples": { - "ResponseExample1": { + "GetUserProfileResponseExample1": { "description": "A successful response from `GET /_security/profile/u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0`. By default, no content is returned in the `data` field.\n", "summary": "Profile details for a UUID", "value": "{\n \"profiles\": [\n {\n \"uid\": \"u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0\",\n \"enabled\": true,\n \"last_synchronized\": 1642650651037,\n \"user\": {\n \"username\": \"jacknich\",\n \"roles\": [\n \"admin\", \"other_role1\"\n ],\n \"realm_name\": \"native\",\n \"full_name\": \"Jack Nicholson\",\n \"email\": \"jacknich@example.com\"\n },\n \"labels\": {\n \"direction\": \"north\"\n },\n \"data\": {}, \n \"_doc\": {\n \"_primary_term\": 88,\n \"_seq_no\": 66\n }\n }\n ]\n}" }, - "ResponseExample2": { + "GetUserProfileResponseExample2": { "description": "A successful response from `GET /_security/profile/u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0?data=app1.key1`.\n", "summary": "Profile details for a UUID and data key", "value": "{\n \"profiles\": [\n {\n \"uid\": \"u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0\",\n \"enabled\": true,\n \"last_synchronized\": 1642650651037,\n \"user\": {\n \"username\": \"jacknich\",\n \"roles\": [\n \"admin\", \"other_role1\"\n ],\n \"realm_name\": \"native\",\n \"full_name\": \"Jack Nicholson\",\n \"email\": \"jacknich@example.com\"\n },\n \"labels\": {\n \"direction\": \"north\"\n },\n \"data\": {\n \"app1\": {\n \"key1\": \"value1\"\n }\n },\n \"_doc\": {\n \"_primary_term\": 88,\n \"_seq_no\": 66\n }\n }\n ]\n}" }, - "ResponseExample3": { + "GetUserProfileResponseExample3": { "description": "A response that contains errors that occurred while retrieving user profiles.\n", "summary": "Profile details with errors", "value": "{\n \"profiles\": [],\n \"errors\": {\n \"count\": 1,\n \"details\": {\n \"u_FmxQt3gr1BBH5wpnz9HkouPj3Q710XkOgg1PWkwLPBW_5\": {\n \"type\": \"resource_not_found_exception\",\n \"reason\": \"profile document not found\"\n }\n }\n }\n}" @@ -207340,7 +207340,7 @@ }, "description": "Check user profile privileges.\n\nDetermine whether the users associated with the specified user profile IDs have all the requested privileges.\n\nNOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. Individual users and external applications should not call this API directly.\nElastic reserves the right to change or remove this feature in future releases without prior notice.", "examples": { - "RequestExample1": { + "HasPrivilegesUserProfileRequestExample1": { "description": "Run `POST /_security/profile/_has_privileges` to check whether the two users associated with the specified profiles have all the requested set of cluster, index, and application privileges.\n", "value": "{\n \"uids\": [\n \"u_LQPnxDxEjIH0GOUoFkZr5Y57YUwSkL9Joiq-g4OCbPc_0\",\n \"u_rzRnxDgEHIH0GOUoFkZr5Y27YUwSk19Joiq=g4OCxxB_1\",\n \"u_does-not-exist_0\"\n ],\n \"privileges\": {\n \"cluster\": [ \"monitor\", \"create_snapshot\", \"manage_ml\" ],\n \"index\" : [\n {\n \"names\": [ \"suppliers\", \"products\" ],\n \"privileges\": [ \"create_doc\"]\n },\n {\n \"names\": [ \"inventory\" ],\n \"privileges\" : [ \"read\", \"write\" ]\n }\n ],\n \"application\": [\n {\n \"application\": \"inventory_manager\",\n \"privileges\" : [ \"read\", \"data:write/inventory\" ],\n \"resources\" : [ \"product/1852563\" ]\n }\n ]\n }\n}" } @@ -207394,7 +207394,7 @@ ] }, "examples": { - "ResponseExample1": { + "HasPrivilegesUserProfileResponseExample1": { "description": "A response from `POST /_security/profile/_has_privileges` that indicates only one of the three users has all the privileges and one of them is not found.\n", "value": "{\n \"has_privilege_uids\": [\"u_rzRnxDgEHIH0GOUoFkZr5Y27YUwSk19Joiq=g4OCxxB_1\"],\n \"errors\": {\n \"count\": 1,\n \"details\": {\n \"u_does-not-exist_0\": {\n \"type\": \"resource_not_found_exception\",\n \"reason\": \"profile document not found\"\n }\n }\n }\n}" } @@ -207843,7 +207843,7 @@ }, "description": "Authenticate OpenID Connect.\n\nExchange an OpenID Connect authentication response message for an Elasticsearch internal access token and refresh token that can be subsequently used for authentication.\n\nElasticsearch exposes all the necessary OpenID Connect related functionality with the OpenID Connect APIs.\nThese APIs are used internally by Kibana in order to provide OpenID Connect based authentication, but can also be used by other, custom web applications or other clients.", "examples": { - "RequestExample1": { + "OidcAuthenticateRequestExample1": { "description": "Run `POST /_security/oidc/authenticate` to exchange the response that was returned from the OpenID Connect Provider after a successful authentication for an Elasticsearch access token and refresh token. This example is from an authentication that uses the authorization code grant flow.\n", "value": "{\n \"redirect_uri\" : \"https://oidc-kibana.elastic.co:5603/api/security/oidc/callback?code=jtI3Ntt8v3_XvcLzCFGq&state=4dbrihtIAt3wBTwo6DxK-vdk-sSyDBV8Yf0AjdkdT5I\",\n \"state\" : \"4dbrihtIAt3wBTwo6DxK-vdk-sSyDBV8Yf0AjdkdT5I\",\n \"nonce\" : \"WaBPH0KqPVdG5HHdSxPRjfoZbXMCicm5v1OiAj0DUFM\",\n \"realm\" : \"oidc1\"\n}" } @@ -207918,7 +207918,7 @@ ] }, "examples": { - "ResponseExample1": { + "OidcAuthenticateResponseExample1": { "description": "A successful response from `POST /_security/oidc/authenticate`. It contains the access and refresh tokens that were generated, the token duration (in seconds), and the type.\n", "value": "{\n \"access_token\" : \"dGhpcyBpcyBub3QgYSByZWFsIHRva2VuIGJ1dCBpdCBpcyBvbmx5IHRlc3QgZGF0YS4gZG8gbm90IHRyeSB0byByZWFkIHRva2VuIQ==\",\n \"type\" : \"Bearer\",\n \"expires_in\" : 1200,\n \"refresh_token\": \"vLBPvmAB6KvwvJZr27cS\"\n}" } @@ -207965,7 +207965,7 @@ }, "description": "Logout of OpenID Connect.\n\nInvalidate an access token and a refresh token that were generated as a response to the `/_security/oidc/authenticate` API.\n\nIf the OpenID Connect authentication realm in Elasticsearch is accordingly configured, the response to this call will contain a URI pointing to the end session endpoint of the OpenID Connect Provider in order to perform single logout.\n\nElasticsearch exposes all the necessary OpenID Connect related functionality with the OpenID Connect APIs.\nThese APIs are used internally by Kibana in order to provide OpenID Connect based authentication, but can also be used by other, custom web applications or other clients.", "examples": { - "RequestExample1": { + "OidcLogoutRequestExample1": { "description": "Run `POST /_security/oidc/logout` to perform the logout.", "value": "{\n \"token\" : \"dGhpcyBpcyBub3QgYSByZWFsIHRva2VuIGJ1dCBpdCBpcyBvbmx5IHRlc3QgZGF0YS4gZG8gbm90IHRyeSB0byByZWFkIHRva2VuIQ==\",\n \"refresh_token\": \"vLBPvmAB6KvwvJZr27cS\"\n}" } @@ -208004,7 +208004,7 @@ ] }, "examples": { - "ResponseExample1": { + "OidcLogoutResponseExample1": { "description": "A successful response from `POST /_security/oidc/logout`, which contains the URI pointing to the End Session Endpoint of the OpenID Connect Provider with all the parameters of the Logout Request as HTTP GET parameters.", "value": "{\n \"redirect\" : \"https://op-provider.org/logout?id_token_hint=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c&post_logout_redirect_uri=http%3A%2F%2Foidc-kibana.elastic.co%2Floggedout&state=lGYK0EcSLjqH6pkT5EVZjC6eIW5YCGgywj2sxROO\"\n}" } @@ -208087,17 +208087,17 @@ }, "description": "Prepare OpenID connect authentication.\n\nCreate an oAuth 2.0 authentication request as a URL string based on the configuration of the OpenID Connect authentication realm in Elasticsearch.\n\nThe response of this API is a URL pointing to the Authorization Endpoint of the configured OpenID Connect Provider, which can be used to redirect the browser of the user in order to continue the authentication process.\n\nElasticsearch exposes all the necessary OpenID Connect related functionality with the OpenID Connect APIs.\nThese APIs are used internally by Kibana in order to provide OpenID Connect based authentication, but can also be used by other, custom web applications or other clients.", "examples": { - "RequestExample1": { + "OidcPrepareAuthenticationRequestExample1": { "description": "Run `POST /_security/oidc/prepare` to generate an authentication request for the OpenID Connect Realm `oidc1`.\n", "summary": "Prepare with realm", "value": "{\n \"realm\" : \"oidc1\"\n}" }, - "RequestExample2": { + "OidcPrepareAuthenticationRequestExample2": { "description": "Run `POST /_security/oidc/prepare` to generate an authentication request for the OpenID Connect Realm `oidc1`, where the values for the `state` and the `nonce` have been generated by the client.\n", "summary": "Prepare with realm, state, and nonce", "value": "{\n \"realm\" : \"oidc1\",\n \"state\" : \"lGYK0EcSLjqH6pkT5EVZjC6eIW5YCGgywj2sxROO\",\n \"nonce\" : \"zOBXLJGUooRrbLbQk5YCcyC8AXw3iloynvluYhZ5\"\n}" }, - "RequestExample3": { + "OidcPrepareAuthenticationRequestExample3": { "description": "Run `POST /_security/oidc/prepare` to generate an authentication request for a third party initiated single sign on. Specify the issuer that should be used for matching the appropriate OpenID Connect Authentication realm.\n", "summary": "Prepare by realm", "value": "{\n \"iss\" : \"http://127.0.0.1:8080\",\n \"login_hint\": \"this_is_an_opaque_string\"\n}" @@ -208170,7 +208170,7 @@ ] }, "examples": { - "ResponseExample1": { + "OidcPrepareAuthenticationResponseExample1": { "description": "A successful response from `POST /_security/oidc/prepare`. It contains the URI pointing to the Authorization Endpoint of the OpenID Connect Provider with all the parameters of the Authentication Request as HTTP GET parameters.\n", "value": "{\n \"redirect\" : \"http://127.0.0.1:8080/c2id-login?scope=openid&response_type=id_token&redirect_uri=https%3A%2F%2Fmy.fantastic.rp%2Fcb&state=4dbrihtIAt3wBTwo6DxK-vdk-sSyDBV8Yf0AjdkdT5I&nonce=WaBPH0KqPVdG5HHdSxPRjfoZbXMCicm5v1OiAj0DUFM&client_id=elasticsearch-rp\",\n \"state\" : \"4dbrihtIAt3wBTwo6DxK-vdk-sSyDBV8Yf0AjdkdT5I\",\n \"nonce\" : \"WaBPH0KqPVdG5HHdSxPRjfoZbXMCicm5v1OiAj0DUFM\",\n \"realm\" : \"oidc1\"\n}" } @@ -210841,7 +210841,7 @@ }, "description": "Authenticate SAML.\n\nSubmit a SAML response message to Elasticsearch for consumption.\n\nNOTE: This API is intended for use by custom web applications other than Kibana.\nIf you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack.\n\nThe SAML message that is submitted can be:\n\n* A response to a SAML authentication request that was previously created using the SAML prepare authentication API.\n* An unsolicited SAML message in the case of an IdP-initiated single sign-on (SSO) flow.\n\nIn either case, the SAML message needs to be a base64 encoded XML document with a root element of ``.\n\nAfter successful validation, Elasticsearch responds with an Elasticsearch internal access token and refresh token that can be subsequently used for authentication.\nThis API endpoint essentially exchanges SAML responses that indicate successful authentication in the IdP for Elasticsearch access and refresh tokens, which can be used for authentication against Elasticsearch.", "examples": { - "RequestExample1": { + "SamlAuthenticateRequestExample1": { "description": "Run `POST /_security/saml/authenticate` to exchange a SAML Response indicating a successful authentication at the SAML IdP for an Elasticsearch access token and refresh token to be used in subsequent requests.\n", "value": "{\n \"content\" : \"PHNhbWxwOlJlc3BvbnNlIHhtbG5zOnNhbWxwPSJ1cm46b2FzaXM6bmFtZXM6dGM6U0FNTDoyLjA6cHJvdG9jb2wiIHhtbG5zOnNhbWw9InVybjpvYXNpczpuYW1lczp0YzpTQU1MOjIuMD.....\",\n \"ids\" : [\"4fee3b046395c4e751011e97f8900b5273d56685\"]\n}" } @@ -210928,7 +210928,7 @@ ] }, "examples": { - "ResponseExample1": { + "SamlAuthenticateResponseExample1": { "description": "A successful response from `POST /_security/saml/authenticate`.", "value": "{\n \"access_token\" : \"46ToAxZVaXVVZTVKOVF5YU04ZFJVUDVSZlV3\",\n \"username\" : \"Bearer\",\n \"expires_in\" : 1200,\n \"refresh_token\": \"mJdXLtmvTUSpoLwMvdBt_w\",\n \"realm\": \"saml1\"\n}" } @@ -210999,12 +210999,12 @@ }, "description": "Logout of SAML completely.\n\nVerifies the logout response sent from the SAML IdP.\n\nNOTE: This API is intended for use by custom web applications other than Kibana.\nIf you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack.\n\nThe SAML IdP may send a logout response back to the SP after handling the SP-initiated SAML Single Logout.\nThis API verifies the response by ensuring the content is relevant and validating its signature.\nAn empty response is returned if the verification process is successful.\nThe response can be sent by the IdP with either the HTTP-Redirect or the HTTP-Post binding.\nThe caller of this API must prepare the request accordingly so that this API can handle either of them.", "examples": { - "RequestExample1": { + "SamlCompleteLogoutRequestExample1": { "description": "Run `POST /_security/saml/complete_logout` to verify the logout response sent by the SAML IdP using the HTTP-Redirect binding.\n", "summary": "HTTP-Redirect binding", "value": "{\n \"realm\": \"saml1\",\n \"ids\": [ \"_1c368075e0b3...\" ],\n \"query_string\": \"SAMLResponse=fZHLasMwEEVbfb1bf...&SigAlg=http%3A%2F%2Fwww.w3.org%2F2000%2F09%2Fxmldsig%23rsa-sha1&Signature=CuCmFn%2BLqnaZGZJqK...\"\n}" }, - "RequestExample2": { + "SamlCompleteLogoutRequestExample2": { "description": "Run `POST /_security/saml/complete_logout` to verify the logout response sent by the SAML IdP using the HTTP-Post binding.\n", "summary": "HTTP-Post binding", "value": "{\n \"realm\": \"saml1\",\n \"ids\": [ \"_1c368075e0b3...\" ],\n \"content\": \"PHNhbWxwOkxvZ291dFJlc3BvbnNlIHhtbG5zOnNhbWxwPSJ1cm46...\"\n}" @@ -211083,7 +211083,7 @@ }, "description": "Invalidate SAML.\n\nSubmit a SAML LogoutRequest message to Elasticsearch for consumption.\n\nNOTE: This API is intended for use by custom web applications other than Kibana.\nIf you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack.\n\nThe logout request comes from the SAML IdP during an IdP initiated Single Logout.\nThe custom web application can use this API to have Elasticsearch process the `LogoutRequest`.\nAfter successful validation of the request, Elasticsearch invalidates the access token and refresh token that corresponds to that specific SAML principal and provides a URL that contains a SAML LogoutResponse message.\nThus the user can be redirected back to their IdP.", "examples": { - "RequestExample1": { + "SamlInvalidateRequestExample1": { "description": "Run `POST /_security/saml/invalidate` to invalidate all the tokens for realm `saml1` pertaining to the user that is identified in the SAML Logout Request.\n", "value": "{\n \"query_string\" : \"SAMLRequest=nZFda4MwFIb%2FiuS%2BmviRpqFaClKQdbvo2g12M2KMraCJ9cRR9utnW4Wyi13sMie873MeznJ1aWrnS3VQGR0j4mLkKC1NUeljjA77zYyhVbIE0dR%2By7fmaHq7U%2BdegXWGpAZ%2B%2F4pR32luBFTAtWgUcCv56%2Fp5y30X87Yz1khTIycdgpUW9kY7WdsC9zxoXTvMvWuVV98YyMnSGH2SYE5pwALBIr9QKiwDGpW0oGVUznGeMyJZKFkQ4jBf5HnhUymjIhzCAL3KNFihbYx8TBYzzGaY7EnIyZwHzCWMfiDnbRIftkSjJr%2BFu0e9v%2B0EgOquRiiZjKpiVFp6j50T4WXoyNJ%2FEWC9fdqc1t%2F1%2B2F3aUpjzhPiXpqMz1%2FHSn4A&SigAlg=http%3A%2F%2Fwww.w3.org%2F2001%2F04%2Fxmldsig-more%23rsa-sha256&Signature=MsAYz2NFdovMG2mXf6TSpu5vlQQyEJAg%2B4KCwBqJTmrb3yGXKUtIgvjqf88eCAK32v3eN8vupjPC8LglYmke1ZnjK0%2FKxzkvSjTVA7mMQe2AQdKbkyC038zzRq%2FYHcjFDE%2Bz0qISwSHZY2NyLePmwU7SexEXnIz37jKC6NMEhus%3D\",\n \"realm\" : \"saml1\"\n}" } @@ -211146,7 +211146,7 @@ ] }, "examples": { - "ResponseExample1": { + "SamlInvalidateResponseExample1": { "description": "A successful response from `POST /_security/saml/invalidate`.", "value": "{\n \"redirect\" : \"https://my-idp.org/logout/SAMLResponse=....\",\n \"invalidated\" : 2,\n \"realm\" : \"saml1\"\n}" } @@ -211193,7 +211193,7 @@ }, "description": "Logout of SAML.\n\nSubmits a request to invalidate an access token and refresh token.\n\nNOTE: This API is intended for use by custom web applications other than Kibana.\nIf you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack.\n\nThis API invalidates the tokens that were generated for a user by the SAML authenticate API.\nIf the SAML realm in Elasticsearch is configured accordingly and the SAML IdP supports this, the Elasticsearch response contains a URL to redirect the user to the IdP that contains a SAML logout request (starting an SP-initiated SAML Single Logout).", "examples": { - "RequestExample1": { + "SamlLogoutRequestExample1": { "description": "Run `POST /_security/saml/logout` to invalidate the pair of tokens that were generated by calling the SAML authenticate API with a successful SAML response.\n", "value": "{\n \"token\" : \"46ToAxZVaXVVZTVKOVF5YU04ZFJVUDVSZlV3\",\n \"refresh_token\" : \"mJdXLtmvTUSpoLwMvdBt_w\"\n}" } @@ -211232,7 +211232,7 @@ ] }, "examples": { - "ResponseExample1": { + "SamlLogoutResponseExample1": { "description": "A successful response from `POST /_security/saml/logout`.", "value": "{\n \"redirect\" : \"https://my-idp.org/logout/SAMLRequest=....\"\n}" } @@ -211291,12 +211291,12 @@ }, "description": "Prepare SAML authentication.\n\nCreate a SAML authentication request (``) as a URL string based on the configuration of the respective SAML realm in Elasticsearch.\n\nNOTE: This API is intended for use by custom web applications other than Kibana.\nIf you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack.\n\nThis API returns a URL pointing to the SAML Identity Provider.\nYou can use the URL to redirect the browser of the user in order to continue the authentication process.\nThe URL includes a single parameter named `SAMLRequest`, which contains a SAML Authentication request that is deflated and Base64 encoded.\nIf the configuration dictates that SAML authentication requests should be signed, the URL has two extra parameters named `SigAlg` and `Signature`.\nThese parameters contain the algorithm used for the signature and the signature value itself.\nIt also returns a random string that uniquely identifies this SAML Authentication request.\nThe caller of this API needs to store this identifier as it needs to be used in a following step of the authentication process.", "examples": { - "RequestExample1": { + "SamlPrepareAuthenticationRequestExample1": { "description": "Run `POST /_security/saml/prepare` to generate a SAML authentication request for the SAML realm named `saml1`.\n", "summary": "Prepare with a realm", "value": "{\n \"realm\" : \"saml1\"\n}" }, - "RequestExample2": { + "SamlPrepareAuthenticationRequestExample2": { "description": "Run `POST /_security/saml/prepare` to generate a SAML authentication request for the SAML realm with an Assertion Consuming Service (ACS) URL.\n", "summary": "Prepare with an ACS", "value": "{\n \"acs\" : \"https://kibana.org/api/security/saml/callback\"\n}" @@ -211360,7 +211360,7 @@ ] }, "examples": { - "ResponseExample1": { + "SAmlPrepareAuthenticationResponseExample1": { "description": "A successful response from `POST /_security/saml/prepare`.", "value": "{\n \"redirect\": \"https://my-idp.org/login?SAMLRequest=fVJdc6IwFP0rmbwDgUKLGbFDtc462%2B06FX3Yl50rBJsKCZsbrPbXL6J22hdfk%2FNx7zl3eL%2BvK7ITBqVWCfVdRolQuS6k2iR0mU2dmN6Phgh1FTQ8be2rehH%2FWoGWdESF%2FPST0NYorgElcgW1QG5zvkh%2FPfHAZbwx2upcV5SkiMLYzmqsFba1MAthdjIXy5enhL5a23DPOyo6W7kGBa7cwhZ2gO7G8OiW%2BR400kORt0bag7fzezAlk24eqcD2OxxlsNN5O3MdsW9c6CZnbq7rntF4d3s0D7BaHTZhIWN52P%2BcjiuGRbDU6cdj%2BEjJbJLQv4N4ADdhxBiEZbQuWclY4Q8iABbCXczCdSiKMAC%2FgyO2YqbQgrIJDZg%2FcFjsMD%2Fzb3gUcBa5sR%2F9oWR%2BzuJBqlPG14Jbn0DIf2TZ3Jn%2FXmSUrC5ddQB6bob37uZrJdeF4dIDHV3iuhb70Ptq83kOz53ubDLXlcwPJK0q%2FT42AqxIaAkVCkqm2tRgr49yfJGFU%2FZQ3hy3QyuUpd7obPv97kb%2FAQ%3D%3D\"}\",\n \"realm\": \"saml1\",\n \"id\": \"_989a34500a4f5bf0f00d195aa04a7804b4ed42a1\"\n}" } @@ -211427,7 +211427,7 @@ ] }, "examples": { - "ResponseExample1": { + "SamlServiceProviderMetadataResponseExample1": { "description": "A successful response from `POST /_security/profile/u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0/_data`, which indicates that the request is acknowledged.\n", "value": "{\n \"acknowledged\": true\n}" } @@ -211577,7 +211577,7 @@ }, "description": "Suggest a user profile.\n\nGet suggestions for user profiles that match specified search criteria.\n\nNOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.\nIndividual users and external applications should not call this API directly.\nElastic reserves the right to change or remove this feature in future releases without prior notice.", "examples": { - "RequestExample1": { + "SuggestUserProfilesRequestExample1": { "description": "Run `POST /_security/profile/_suggest` to get suggestions for profile documents with name-related fields matching `jack`. It specifies both `uids` and `labels` hints for better relevance. The `labels` hint ranks profiles higher if their `direction` label matches either `north` or `east`.\n", "value": "{\n \"name\": \"jack\", \n \"hint\": {\n \"uids\": [ \n \"u_8RKO7AKfEbSiIHZkZZ2LJy2MUSDPWDr3tMI_CkIGApU_0\",\n \"u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0\"\n ],\n \"labels\": {\n \"direction\": [\"north\", \"east\"] \n }\n }\n}" } @@ -211671,7 +211671,7 @@ ] }, "examples": { - "ResponseExample1": { + "SuggestUserProfilesResponseExample1": { "description": "A successful response from `GET /_security/saml/metadata/saml1`. It contains the SAML metadata that was generated for the SAML realm as an XML string.\n", "value": "{\n \"metadata\" : \"\"\n}" } @@ -211773,12 +211773,12 @@ }, "description": "Update an API key.\n\nUpdate attributes of an existing API key.\nThis API supports updates to an API key's access scope, expiration, and metadata.\n\nTo use this API, you must have at least the `manage_own_api_key` cluster privilege.\nUsers can only update API keys that they created or that were granted to them.\nTo update another user’s API key, use the `run_as` feature to submit a request on behalf of another user.\n\nIMPORTANT: It's not possible to use an API key as the authentication credential for this API. The owner user’s credentials are required.\n\nUse this API to update API keys created by the create API key or grant API Key APIs.\nIf you need to apply the same update to many API keys, you can use the bulk update API keys API to reduce overhead.\nIt's not possible to update expired API keys or API keys that have been invalidated by the invalidate API key API.\n\nThe access scope of an API key is derived from the `role_descriptors` you specify in the request and a snapshot of the owner user's permissions at the time of the request.\nThe snapshot of the owner's permissions is updated automatically on every call.\n\nIMPORTANT: If you don't specify `role_descriptors` in the request, a call to this API might still change the API key's access scope.\nThis change can occur if the owner user's permissions have changed since the API key was created or last modified.", "examples": { - "RequestExample1": { + "UpdateApiKeyRequestExample1": { "description": "Run `PUT /_security/api_key/VuaCfGcBCdbkQm-e5aOx` to assign new role descriptors and metadata to an API key.\n", "summary": "Update role and metadata", "value": "{\n \"role_descriptors\": {\n \"role-a\": {\n \"indices\": [\n {\n \"names\": [\"*\"],\n \"privileges\": [\"write\"]\n }\n ]\n }\n },\n \"metadata\": {\n \"environment\": {\n \"level\": 2,\n \"trusted\": true,\n \"tags\": [\"production\"]\n }\n }\n}" }, - "RequestExample2": { + "UpdateApiKeyRequestExample2": { "description": "Run `PUT /_security/api_key/VuaCfGcBCdbkQm-e5aOx` to remove the API key's previously assigned permissions. It will inherit the owner user's full permissions.\n", "summary": "Remove permissions", "value": "{\n \"role_descriptors\": {}\n}" @@ -211831,7 +211831,7 @@ ] }, "examples": { - "ResponseExample1": { + "UpdateApiKeyResponseExample1": { "description": "A successful response from `PUT /_security/api_key/VuaCfGcBCdbkQm-e5aOx`. The API key's effective permissions after the update will be the intersection of the supplied role descriptors and the owner user's permissions.\n", "summary": "Update role and metadata", "value": "{\n \"updated\": true\n}" @@ -212120,7 +212120,7 @@ }, "description": "Update user profile data.\n\nUpdate specific data for the user profile that is associated with a unique ID.\n\nNOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.\nIndividual users and external applications should not call this API directly.\nElastic reserves the right to change or remove this feature in future releases without prior notice.\n\nTo use this API, you must have one of the following privileges:\n\n* The `manage_user_profile` cluster privilege.\n* The `update_profile_data` global privilege for the namespaces that are referenced in the request.\n\nThis API updates the `labels` and `data` fields of an existing user profile document with JSON objects.\nNew keys and their values are added to the profile document and conflicting keys are replaced by data that's included in the request.\n\nFor both labels and data, content is namespaced by the top-level fields.\nThe `update_profile_data` global privilege grants privileges for updating only the allowed namespaces.", "examples": { - "RequestExample1": { + "UpdateUserProfileDataRequestExample1": { "description": "Run `POST /_security/profile/u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0/_data` to update a profile document for the `u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0` user profile.\n", "value": "{\n \"labels\": {\n \"direction\": \"east\"\n },\n \"data\": {\n \"app1\": {\n \"theme\": \"default\"\n }\n }\n}" } @@ -212203,7 +212203,7 @@ } }, "examples": { - "ResponseExample1": { + "UpdateUserProfileDataResponseExample1": { "description": "A successful response from `POST /_security/profile/u_P_0BMHgaOK3p7k-PFWUCbw9dQ-UFjt01oWJ_Dp2PmPc_0/_data`, which indicates that the request is acknowledged.\n", "value": "{\n \"acknowledged\": true\n}" } From 2ee828bf66a814785be06b396af067de7e1684ff Mon Sep 17 00:00:00 2001 From: lcawl Date: Wed, 12 Mar 2025 13:12:37 -0700 Subject: [PATCH 6/6] Update add-new-api.md --- docs/add-new-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/add-new-api.md b/docs/add-new-api.md index d0ba38b513..bdea31de22 100644 --- a/docs/add-new-api.md +++ b/docs/add-new-api.md @@ -169,7 +169,7 @@ class Response { ### Add endpoint request and response examples -Add an `examples` folder and `request` and `xxx_response` subfolders (where `xxx` is the relevant response code). +Add an `examples` folder and `request` and `xxx_response` subfolders (where `xxx` is the relevant response code). The file names within these folders should be unique (for example,`DownsampleRequestExample1.yaml` not `RequestExample1.yaml`). These examples are for use in the API documentation and must adhere to the [OpenAPI 3.0 Example object specification](https://spec.openapis.org/oas/v3.0.3#example-object). They must have a `value` field that contains the request or response body. If there are multiple examples for the endpoint, they must each have a brief `summary` field, which is used as the label for the example. You can also optionaly provide an explanation in a `description` field.