From 84d57a43b0425c6750910f768a381c5aa74d15c1 Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Wed, 15 Jan 2025 10:59:27 -0800 Subject: [PATCH] Add more example subfolders (#3505) --- docs/add-new-api.md | 32 ++++++++++++ .../elasticsearch-openapi-overlays.yaml | 48 +++++++++--------- .../elasticsearch-shared-overlays.yaml | 50 +++++++++---------- ...eteAutoscalingPolicyResponseExample1.yaml} | 0 ...tAutoscalingCapacityResponseExample1.yaml} | 0 ...GetAutoscalingPolicyResponseExample1.yaml} | 0 ...PutAutoscalingPolicyResponseExample1.yaml} | 0 .../PutAutoscalingPolicyRequestExample1.yaml} | 0 .../PutAutoscalingPolicyRequestExample2.yaml} | 0 ...erPutComponentTemplateRequestExample1.yaml | 0 ...erPutComponentTemplateRequestExample2.yaml | 0 .../ConnectorCheckInResponseExample1.yaml | 0 .../ConnectorDeleteResponseExample1.yaml | 0 ...onnectorUpdateLastSyncRequestExample1.yaml | 0 .../request}/ConnectorPutRequestExample1.yaml | 0 .../request}/ConnectorPutRequestExample2.yaml | 0 .../ConnectorPutResponseExample1.yaml | 0 .../SyncJobDeleteResponseExample1.yaml | 0 .../request}/SyncJobErrorRequestExample1.yaml | 0 .../request}/SyncJobPostRequestExample1.yaml | 0 ...nnectorUpdateApiKeyIDRequestExample1.yaml} | 0 ...nnectorUpdateAPIKeyIDResponseExample1.yaml | 0 ...torUpdateConfigurationRequestExample1.yaml | 0 ...torUpdateConfigurationRequestExample2.yaml | 0 ...orUpdateConfigurationResponseExample1.yaml | 0 .../ConnectorUpdateErrorRequestExample1.yaml | 0 .../ConnectorUpdateErrorResponseExample1.yaml | 0 ...onnectorUpdateFeaturesRequestExample1.yaml | 0 ...onnectorUpdateFeaturesRequestExample2.yaml | 0 ...nnectorUpdateFeaturesResponseExample1.yaml | 0 ...nnectorUpdateFilteringRequestExample1.yaml | 0 ...nnectorUpdateFilteringRequestExample2.yaml | 0 ...nectorUpdateFilteringResponseExample1.yaml | 0 ...nnectorUpdateIndexNameRequestExample1.yaml | 0 ...nectorUpdateIndexNameResponseExample1.yaml | 0 .../ConnectorUpdateNameRequestExample1.yaml | 0 .../ConnectorUpdateNameResponseExample1.yaml | 0 ...onnectorUpdatePipelineRequestExample1.yaml | 0 ...nnectorUpdatePipelineResponseExample1.yaml | 0 ...nectorUpdateSchedulingRequestExample1.yaml | 0 ...nectorUpdateSchedulingRequestExample2.yaml | 0 ...ectorUpdateSchedulingResponseExample1.yaml | 0 ...ectorUpdateServiceTypeRequestExample1.yaml | 0 ...ctorUpdateServiceTypeResponseExample1.yaml | 0 .../ConnectorUpdateStatusRequestExample1.yaml | 0 ...ConnectorUpdateStatusResponseExample1.yaml | 0 .../ImportDanglingIndexResponseExample1.yaml | 0 .../ListDanglingIndicesResponseExample1.yaml | 0 .../IndicesAddBlockResponseExample1.yaml | 0 .../indicesAnalyzeResponseExample7.yaml | 0 .../indicesAnalyzeRequestExample1.yaml | 0 .../indicesAnalyzeRequestExample2.yaml | 0 .../indicesAnalyzeRequestExample3.yaml | 0 .../indicesAnalyzeRequestExample4.yaml | 0 .../indicesAnalyzeRequestExample5.yaml | 0 .../indicesAnalyzeRequestExample6.yaml | 0 .../indicesAnalyzeRequestExample7.yaml | 0 .../request}/indicesCloneRequestExample1.yaml | 0 .../indicesCreateRequestExample1.yaml | 0 .../indicesCreateRequestExample2.yaml | 0 .../indicesCreateRequestExample3.yaml | 0 ...ndicesDataStreamStatsResponseExample1.yaml | 0 ...esDeleteDataLifecycleResponseExample1.yaml | 0 .../indicesDiskUsageResponseExample1.yaml | 0 .../request}/RequestExample1.yaml | 0 ...sExplainDataLifecycleResponseExample1.yaml | 0 ...sExplainDataLifecycleResponseExample2.yaml | 0 ...ndicesFieldUsageStatsResponseExample1.yaml | 0 ...dicesGetDataLifecycleResponseExample1.yaml | 0 .../indicesGetDataStreamResponseExample1.yaml | 0 ...ndicesGetFieldMappingResponseExample1.yaml | 0 ...ndicesGetFieldMappingResponseExample2.yaml | 0 ...ndicesGetFieldMappingResponseExample3.yaml | 0 .../indicesOpenResponseExample1.yaml | 0 .../indicesPutAliasRequestExample1.yaml | 0 ...dicesPutDataLifecycleResponseExample1.yaml | 0 ...ndicesPutDataLifecycleRequestExample1.yaml | 0 ...ndicesPutDataLifecycleRequestExample2.yaml | 0 ...ndicesPutIndexTemplateRequestExample1.yaml | 0 ...ndicesPutIndexTemplateRequestExample2.yaml | 0 .../indicesPutMappingRequestExample1.yaml | 0 .../IndicesPutSettingsRequestExample1.yaml | 0 .../indicesPutSettingsRequestExample2.yaml | 0 .../indicesPutSettingsRequestExample3.yaml | 0 .../indicesPutTemplateRequestExample1.yaml | 0 .../indicesPutTemplateRequestExample2.yaml | 0 .../indicesRecoveryResponseExample1.yaml | 0 .../indicesRecoveryResponseExample2.yaml | 0 .../ResolveClusterResponseExample1.yaml | 0 .../ResolveClusterResponseExample2.yaml | 0 .../indicesRolloverResponseExample1.yaml | 0 .../indicesRolloverRequestExample1.yaml | 0 .../indicesSegmentsResponseExample1.yaml | 0 .../indicesShardStoresResponseExample1.yaml | 0 .../indicesShrinkRequestExample1.yaml | 0 ...SimulateIndexTemplateResponseExample1.yaml | 0 ...dicesSimulateTemplateResponseExample2.yaml | 0 ...ndicesSimulateTemplateRequestExample1.yaml | 0 .../request}/indicesSplitRequestExample1.yaml | 0 .../GetPipelineResponseExample1.yaml | 0 .../request}/PutPipelineRequestExample1.yaml | 0 .../request}/PutPipelineRequestExample2.yaml | 0 .../response}/GetLicenseResponseExample1.yaml | 0 ...GetBasicLicenseStatusResponseExample1.yaml | 0 ...GetTrialLicenseStatusResponseExample1.yaml | 0 .../PostLicenseResponseExample1.yaml | 0 .../request}/PostLicenseRequestExample1.yaml | 0 .../StartBasicLicenseResponseExample1.yaml | 0 .../StartTrialLicenseResponseExample1.yaml | 0 .../LogstashGetPipelineResponseExample1.yaml | 0 .../LogstashPutPipelineRequestExample1.yaml | 0 .../DeprecationInfoResponseExample1.yaml | 0 ...tFeatureUpgradeStatusResponseExample1.yaml | 0 .../PostFeatureUpgradeResponseExample1.yaml | 0 .../nodesInfoResponseExample1.yaml | 0 .../QueryRuleGetResponseExample1.yaml | 0 .../QueryRulesetGetResponseExample1.yaml | 0 .../QueryRulesetListResponseExample1.yaml | 0 .../request}/QueryRulePutRequestExample1.yaml | 0 .../QueryRulesetPutRequestExample1.yaml | 0 .../QueryRulesetTestRequestExample1.yaml | 0 .../QueryRulesetTestResponseExample1.yaml | 0 .../SearchApplicationGetResponseExample1.yaml | 0 ...ehavioralAnalyticsGetResponseExample1.yaml | 0 ...earchApplicationsListResponseExample1.yaml | 0 ...oralAnalyticsEventPostRequestExample1.yaml | 0 .../SearchApplicationPutRequestExample1.yaml | 0 ...plicationsRenderQueryResponseExample1.yaml | 0 ...pplicationsRenderQueryRequestExample1.yaml | 0 ...archApplicationsSearchRequestExample1.yaml | 0 .../ShutdownDeleteNodeResponseExample1.yaml | 0 .../ShutdownGetNodeResponseExample1.yaml | 0 .../ShutdownPutNodeRequestExample1.yaml | 0 133 files changed, 81 insertions(+), 49 deletions(-) rename specification/autoscaling/delete_autoscaling_policy/{autoscalingApisDeleteAutoscalingPolicyResponseExample1.yaml => examples/response/DeleteAutoscalingPolicyResponseExample1.yaml} (100%) rename specification/autoscaling/get_autoscaling_capacity/{autoscalingApisGetAutoscalingCapacityResponseExample1.yaml => examples/200_response/GetAutoscalingCapacityResponseExample1.yaml} (100%) rename specification/autoscaling/get_autoscaling_policy/{autoscalingApisGetAutoscalingPolicyResponseExample1.yaml => examples/200_response/GetAutoscalingPolicyResponseExample1.yaml} (100%) rename specification/autoscaling/put_autoscaling_policy/{autoscalingApisPutAutoscalingPolicyResponseExample1.yaml => examples/200_response/PutAutoscalingPolicyResponseExample1.yaml} (100%) rename specification/autoscaling/put_autoscaling_policy/{autoscalingApisPutAutoscalingPolicyRequestExample1.yaml => examples/request/PutAutoscalingPolicyRequestExample1.yaml} (100%) rename specification/autoscaling/put_autoscaling_policy/{autoscalingApisPutAutoscalingPolicyRequestExample2.yaml => examples/request/PutAutoscalingPolicyRequestExample2.yaml} (100%) rename specification/cluster/put_component_template/{ => examples/request}/ClusterPutComponentTemplateRequestExample1.yaml (100%) rename specification/cluster/put_component_template/{ => examples/request}/ClusterPutComponentTemplateRequestExample2.yaml (100%) rename specification/connector/check_in/{ => examples/response}/ConnectorCheckInResponseExample1.yaml (100%) rename specification/connector/delete/{ => examples/response}/ConnectorDeleteResponseExample1.yaml (100%) rename specification/connector/last_sync/{ => examples/request}/ConnectorUpdateLastSyncRequestExample1.yaml (100%) rename specification/connector/put/{ => examples/request}/ConnectorPutRequestExample1.yaml (100%) rename specification/connector/put/{ => examples/request}/ConnectorPutRequestExample2.yaml (100%) rename specification/connector/put/{ => examples/response}/ConnectorPutResponseExample1.yaml (100%) rename specification/connector/sync_job_delete/{ => examples/response}/SyncJobDeleteResponseExample1.yaml (100%) rename specification/connector/sync_job_error/{ => examples/request}/SyncJobErrorRequestExample1.yaml (100%) rename specification/connector/sync_job_post/{ => examples/request}/SyncJobPostRequestExample1.yaml (100%) rename specification/connector/update_api_key_id/{ConnectorUpdateApiKeyIdExample1.yaml => examples/request/ConnectorUpdateApiKeyIDRequestExample1.yaml} (100%) rename specification/connector/update_api_key_id/{ => examples/response}/ConnectorUpdateAPIKeyIDResponseExample1.yaml (100%) rename specification/connector/update_configuration/{ => examples/request}/ConnectorUpdateConfigurationRequestExample1.yaml (100%) rename specification/connector/update_configuration/{ => examples/request}/ConnectorUpdateConfigurationRequestExample2.yaml (100%) rename specification/connector/update_configuration/{ => examples/response}/ConnectorUpdateConfigurationResponseExample1.yaml (100%) rename specification/connector/update_error/{ => examples/request}/ConnectorUpdateErrorRequestExample1.yaml (100%) rename specification/connector/update_error/{ => examples/response}/ConnectorUpdateErrorResponseExample1.yaml (100%) rename specification/connector/update_features/{ => examples/request}/ConnectorUpdateFeaturesRequestExample1.yaml (100%) rename specification/connector/update_features/{ => examples/request}/ConnectorUpdateFeaturesRequestExample2.yaml (100%) rename specification/connector/update_features/{ => examples/response}/ConnectorUpdateFeaturesResponseExample1.yaml (100%) rename specification/connector/update_filtering/{ => examples/request}/ConnectorUpdateFilteringRequestExample1.yaml (100%) rename specification/connector/update_filtering/{ => examples/request}/ConnectorUpdateFilteringRequestExample2.yaml (100%) rename specification/connector/update_filtering/{ => examples/response}/ConnectorUpdateFilteringResponseExample1.yaml (100%) rename specification/connector/update_index_name/{ => examples/request}/ConnectorUpdateIndexNameRequestExample1.yaml (100%) rename specification/connector/update_index_name/{ => examples/response}/ConnectorUpdateIndexNameResponseExample1.yaml (100%) rename specification/connector/update_name/{ => examples/request}/ConnectorUpdateNameRequestExample1.yaml (100%) rename specification/connector/update_name/{ => examples/response}/ConnectorUpdateNameResponseExample1.yaml (100%) rename specification/connector/update_pipeline/{ => examples/request}/ConnectorUpdatePipelineRequestExample1.yaml (100%) rename specification/connector/update_pipeline/{ => examples/response}/ConnectorUpdatePipelineResponseExample1.yaml (100%) rename specification/connector/update_scheduling/{ => examples/request}/ConnectorUpdateSchedulingRequestExample1.yaml (100%) rename specification/connector/update_scheduling/{ => examples/request}/ConnectorUpdateSchedulingRequestExample2.yaml (100%) rename specification/connector/update_scheduling/{ => examples/response}/ConnectorUpdateSchedulingResponseExample1.yaml (100%) rename specification/connector/update_service_type/{ => examples/request}/ConnectorUpdateServiceTypeRequestExample1.yaml (100%) rename specification/connector/update_service_type/{ => examples/response}/ConnectorUpdateServiceTypeResponseExample1.yaml (100%) rename specification/connector/update_status/{ => examples/request}/ConnectorUpdateStatusRequestExample1.yaml (100%) rename specification/connector/update_status/{ => examples/response}/ConnectorUpdateStatusResponseExample1.yaml (100%) rename specification/dangling_indices/import_dangling_index/{ => examples/response}/ImportDanglingIndexResponseExample1.yaml (100%) rename specification/dangling_indices/list_dangling_indices/{ => examples/response}/ListDanglingIndicesResponseExample1.yaml (100%) rename specification/indices/add_block/{ => examples/response}/IndicesAddBlockResponseExample1.yaml (100%) rename specification/indices/analyze/{ => examples/200_response}/indicesAnalyzeResponseExample7.yaml (100%) rename specification/indices/analyze/{ => examples/request}/indicesAnalyzeRequestExample1.yaml (100%) rename specification/indices/analyze/{ => examples/request}/indicesAnalyzeRequestExample2.yaml (100%) rename specification/indices/analyze/{ => examples/request}/indicesAnalyzeRequestExample3.yaml (100%) rename specification/indices/analyze/{ => examples/request}/indicesAnalyzeRequestExample4.yaml (100%) rename specification/indices/analyze/{ => examples/request}/indicesAnalyzeRequestExample5.yaml (100%) rename specification/indices/analyze/{ => examples/request}/indicesAnalyzeRequestExample6.yaml (100%) rename specification/indices/analyze/{ => examples/request}/indicesAnalyzeRequestExample7.yaml (100%) rename specification/indices/clone/{ => examples/request}/indicesCloneRequestExample1.yaml (100%) rename specification/indices/create/{ => examples/request}/indicesCreateRequestExample1.yaml (100%) rename specification/indices/create/{ => examples/request}/indicesCreateRequestExample2.yaml (100%) rename specification/indices/create/{ => examples/request}/indicesCreateRequestExample3.yaml (100%) rename specification/indices/data_streams_stats/{ => examples/200_response}/indicesDataStreamStatsResponseExample1.yaml (100%) rename specification/indices/delete_data_lifecycle/{ => examples/200_response}/IndicesDeleteDataLifecycleResponseExample1.yaml (100%) rename specification/indices/disk_usage/{ => request/200_response}/indicesDiskUsageResponseExample1.yaml (100%) rename specification/indices/downsample/{ => examples/request}/RequestExample1.yaml (100%) rename specification/indices/explain_data_lifecycle/{ => examples/response}/IndicesExplainDataLifecycleResponseExample1.yaml (100%) rename specification/indices/explain_data_lifecycle/{ => examples/response}/IndicesExplainDataLifecycleResponseExample2.yaml (100%) rename specification/indices/field_usage_stats/{ => examples/200_response}/indicesFieldUsageStatsResponseExample1.yaml (100%) rename specification/indices/get_data_lifecycle/{ => examples/response}/IndicesGetDataLifecycleResponseExample1.yaml (100%) rename specification/indices/get_data_stream/{ => examples/200_response}/indicesGetDataStreamResponseExample1.yaml (100%) rename specification/indices/get_field_mapping/{ => examples/response}/indicesGetFieldMappingResponseExample1.yaml (100%) rename specification/indices/get_field_mapping/{ => examples/response}/indicesGetFieldMappingResponseExample2.yaml (100%) rename specification/indices/get_field_mapping/{ => examples/response}/indicesGetFieldMappingResponseExample3.yaml (100%) rename specification/indices/open/{ => examples/200_response}/indicesOpenResponseExample1.yaml (100%) rename specification/indices/put_alias/{ => examples/request}/indicesPutAliasRequestExample1.yaml (100%) rename specification/indices/put_data_lifecycle/{ => examples/200_response}/IndicesPutDataLifecycleResponseExample1.yaml (100%) rename specification/indices/put_data_lifecycle/{ => examples/request}/IndicesPutDataLifecycleRequestExample1.yaml (100%) rename specification/indices/put_data_lifecycle/{ => examples/request}/IndicesPutDataLifecycleRequestExample2.yaml (100%) rename specification/indices/put_index_template/{ => examples/request}/IndicesPutIndexTemplateRequestExample1.yaml (100%) rename specification/indices/put_index_template/{ => examples/request}/IndicesPutIndexTemplateRequestExample2.yaml (100%) rename specification/indices/put_mapping/{ => examples/request}/indicesPutMappingRequestExample1.yaml (100%) rename specification/indices/put_settings/{ => examples/request}/IndicesPutSettingsRequestExample1.yaml (100%) rename specification/indices/put_settings/{ => examples/request}/indicesPutSettingsRequestExample2.yaml (100%) rename specification/indices/put_settings/{ => examples/request}/indicesPutSettingsRequestExample3.yaml (100%) rename specification/indices/put_template/{ => examples/request}/indicesPutTemplateRequestExample1.yaml (100%) rename specification/indices/put_template/{ => examples/request}/indicesPutTemplateRequestExample2.yaml (100%) rename specification/indices/recovery/{ => examples/200_response}/indicesRecoveryResponseExample1.yaml (100%) rename specification/indices/recovery/{ => examples/200_response}/indicesRecoveryResponseExample2.yaml (100%) rename specification/indices/resolve_cluster/{ => examples/200_response}/ResolveClusterResponseExample1.yaml (100%) rename specification/indices/resolve_cluster/{ => examples/200_response}/ResolveClusterResponseExample2.yaml (100%) rename specification/indices/rollover/{ => examples/200_response}/indicesRolloverResponseExample1.yaml (100%) rename specification/indices/rollover/{ => examples/request}/indicesRolloverRequestExample1.yaml (100%) rename specification/indices/segments/{ => examples/200_response}/indicesSegmentsResponseExample1.yaml (100%) rename specification/indices/shard_stores/{ => examples/200_response}/indicesShardStoresResponseExample1.yaml (100%) rename specification/indices/shrink/{ => examples/request}/indicesShrinkRequestExample1.yaml (100%) rename specification/indices/simulate_index_template/{ => examples/200_response}/indicesSimulateIndexTemplateResponseExample1.yaml (100%) rename specification/indices/simulate_template/{ => examples/200_response}/indicesSimulateTemplateResponseExample2.yaml (100%) rename specification/indices/simulate_template/{ => examples/request}/indicesSimulateTemplateRequestExample1.yaml (100%) rename specification/indices/split/{ => examples/request}/indicesSplitRequestExample1.yaml (100%) rename specification/ingest/get_pipeline/{ => examples/200_response}/GetPipelineResponseExample1.yaml (100%) rename specification/ingest/put_pipeline/{ => examples/request}/PutPipelineRequestExample1.yaml (100%) rename specification/ingest/put_pipeline/{ => examples/request}/PutPipelineRequestExample2.yaml (100%) rename specification/license/get/{ => examples/response}/GetLicenseResponseExample1.yaml (100%) rename specification/license/get_basic_status/{ => examples/200_response}/GetBasicLicenseStatusResponseExample1.yaml (100%) rename specification/license/get_trial_status/{ => examples/200_response}/GetTrialLicenseStatusResponseExample1.yaml (100%) rename specification/license/post/{ => examples/200_response}/PostLicenseResponseExample1.yaml (100%) rename specification/license/post/{ => examples/request}/PostLicenseRequestExample1.yaml (100%) rename specification/license/post_start_basic/{ => examples/200_response}/StartBasicLicenseResponseExample1.yaml (100%) rename specification/license/post_start_trial/{ => examples/200_response}/StartTrialLicenseResponseExample1.yaml (100%) rename specification/logstash/get_pipeline/{ => examples/200_response}/LogstashGetPipelineResponseExample1.yaml (100%) rename specification/logstash/put_pipeline/{ => examples/request}/LogstashPutPipelineRequestExample1.yaml (100%) rename specification/migration/deprecations/{ => examples/200_response}/DeprecationInfoResponseExample1.yaml (100%) rename specification/migration/get_feature_upgrade_status/{ => examples/response}/GetFeatureUpgradeStatusResponseExample1.yaml (100%) rename specification/migration/post_feature_upgrade/{ => examples/response}/PostFeatureUpgradeResponseExample1.yaml (100%) rename specification/nodes/info/{ => examples/200_response}/nodesInfoResponseExample1.yaml (100%) rename specification/query_rules/get_rule/{ => examples/response}/QueryRuleGetResponseExample1.yaml (100%) rename specification/query_rules/get_ruleset/{ => examples/response}/QueryRulesetGetResponseExample1.yaml (100%) rename specification/query_rules/list_rulesets/{ => examples/response}/QueryRulesetListResponseExample1.yaml (100%) rename specification/query_rules/put_rule/{ => examples/request}/QueryRulePutRequestExample1.yaml (100%) rename specification/query_rules/put_ruleset/{ => examples/request}/QueryRulesetPutRequestExample1.yaml (100%) rename specification/query_rules/test/{ => examples/request}/QueryRulesetTestRequestExample1.yaml (100%) rename specification/query_rules/test/{ => examples/response}/QueryRulesetTestResponseExample1.yaml (100%) rename specification/search_application/get/{ => examples/200_response}/SearchApplicationGetResponseExample1.yaml (100%) rename specification/search_application/get_behavioral_analytics/{ => examples/200_response}/BehavioralAnalyticsGetResponseExample1.yaml (100%) rename specification/search_application/list/{ => examples/200_response}/SearchApplicationsListResponseExample1.yaml (100%) rename specification/search_application/post_behavioral_analytics_event/{ => examples/request}/BehavioralAnalyticsEventPostRequestExample1.yaml (100%) rename specification/search_application/put/{ => examples/request}/SearchApplicationPutRequestExample1.yaml (100%) rename specification/search_application/render_query/{ => examples/200_response}/SearchApplicationsRenderQueryResponseExample1.yaml (100%) rename specification/search_application/render_query/{ => examples/request}/SearchApplicationsRenderQueryRequestExample1.yaml (100%) rename specification/search_application/search/{ => examples/request}/SearchApplicationsSearchRequestExample1.yaml (100%) rename specification/shutdown/delete_node/{ => examples/response}/ShutdownDeleteNodeResponseExample1.yaml (100%) rename specification/shutdown/get_node/{ => examples/response}/ShutdownGetNodeResponseExample1.yaml (100%) rename specification/shutdown/put_node/{ => examples/request}/ShutdownPutNodeRequestExample1.yaml (100%) diff --git a/docs/add-new-api.md b/docs/add-new-api.md index 64c963a0c2..d0ba38b513 100644 --- a/docs/add-new-api.md +++ b/docs/add-new-api.md @@ -166,3 +166,35 @@ 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). + +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. + +For example: + +```yaml +summary: Sequence query +# method_request: GET /my-data-stream/_eql/search +# type: request +description: > + Run `GET /my-data-stream/_eql/search` to search for a sequence of events. + The sequence starts with an event with an `event.category` of `file`, a `file.name` of `cmd.exe`, and a `process.pid` other than `2013`. + It is followed by an event with an `event.category` of `process` and a `process.executable` that contains the substring `regsvr32`. + These events must also share the same `process.pid` value. +value: |- + { + "query": """ + sequence by process.pid + [ file where file.name == "cmd.exe" and process.pid != 2013 ] + [ process where stringContains(process.executable, "regsvr32") ] + """ + } +``` + +NOTE: A good example covers a very common use case or demonstrates a more complex but critical use case. +It involves realistic data sets ( rather than generic "hello world" values). +If it requires detailed setup or explanations, however, it is more appropriate for coverage in longer-form narrative documentation. diff --git a/docs/overlays/elasticsearch-openapi-overlays.yaml b/docs/overlays/elasticsearch-openapi-overlays.yaml index 2523534f1c..17e63ff46d 100644 --- a/docs/overlays/elasticsearch-openapi-overlays.yaml +++ b/docs/overlays/elasticsearch-openapi-overlays.yaml @@ -149,7 +149,7 @@ actions: application/json: examples: nodesInfoResponseExample1: - $ref: "../../specification/nodes/info/nodesInfoResponseExample1.yaml" + $ref: "../../specification/nodes/info/examples/200_response/nodesInfoResponseExample1.yaml" - target: "$.paths['/_ilm/policy/{policy}']['delete']" description: "Add examples for delete lifecycle policy operation" update: @@ -275,7 +275,7 @@ actions: application/json: examples: indicesCloneRequestExample1: - $ref: "../../specification/indices/clone/indicesCloneRequestExample1.yaml" + $ref: "../../specification/indices/clone/examples/request/indicesCloneRequestExample1.yaml" - target: "$.paths['/{index}/_close']['post']" description: "Add examples for close index response" update: @@ -293,7 +293,7 @@ actions: application/json: examples: indicesDataStreamStatsResponseExample1: - $ref: "../../specification/indices/data_streams_stats/indicesDataStreamStatsResponseExample1.yaml" + $ref: "../../specification/indices/data_streams_stats/examples/200_response/indicesDataStreamStatsResponseExample1.yaml" - target: "$.paths['/{index}/_open']['post']" description: "Add examples for open index response" update: @@ -303,7 +303,7 @@ actions: application/json: examples: indicesOpenResponseExample1: - $ref: "../../specification/indices/open/indicesOpenResponseExample1.yaml" + $ref: "../../specification/indices/open/examples/200_response/indicesOpenResponseExample1.yaml" - target: "$.paths['/_autoscaling/policy/{name}']['delete']" description: "Add examples for delete autoscaling policy response" update: @@ -313,7 +313,7 @@ actions: application/json: examples: deleteAutoscalingPolicyResponseExample1: - $ref: "../../specification/autoscaling/delete_autoscaling_policy/autoscalingApisDeleteAutoscalingPolicyResponseExample1.yaml" + $ref: "../../specification/autoscaling/delete_autoscaling_policy/examples/response/DeleteAutoscalingPolicyResponseExample1.yaml" - target: "$.paths['/_autoscaling/capacity']['get']" description: "Add examples for get autoscaling capacity response" update: @@ -323,7 +323,7 @@ actions: application/json: examples: getAutoscalingCapacityResponseExample1: - $ref: "../../specification/autoscaling/get_autoscaling_capacity/autoscalingApisGetAutoscalingCapacityResponseExample1.yaml" + $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: @@ -333,7 +333,7 @@ actions: application/json: examples: getAutoscalingPolicyResponseExample1: - $ref: "../../specification/autoscaling/get_autoscaling_policy/autoscalingApisGetAutoscalingPolicyResponseExample1.yaml" + $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: @@ -342,16 +342,16 @@ actions: application/json: examples: createAutoscalingPolicyRequestExample1: - $ref: "../../specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyRequestExample1.yaml" + $ref: "../../specification/autoscaling/put_autoscaling_policy/examples/request/PutAutoscalingPolicyRequestExample1.yaml" createAutoscalingPolicyRequestExample2: - $ref: "../../specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyRequestExample2.yaml" + $ref: "../../specification/autoscaling/put_autoscaling_policy/examples/request/PutAutoscalingPolicyRequestExample2.yaml" responses: 200: content: application/json: examples: createAutoscalingPolicyResponseExample1: - $ref: "../../specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyResponseExample1.yaml" + $ref: "../../specification/autoscaling/put_autoscaling_policy/examples/200_response/PutAutoscalingPolicyResponseExample1.yaml" - target: "$.components['responses']['indices.recovery#200']" description: "Add example for get index recovery response" update: @@ -359,7 +359,7 @@ actions: application/json: examples: getIndicesRecoveryResponseExample1: - $ref: "../../specification/indices/recovery/indicesRecoveryResponseExample1.yaml" + $ref: "../../specification/indices/recovery/examples/200_response/indicesRecoveryResponseExample1.yaml" - target: "$.paths['/_resolve/cluster/{name}']['get']" description: "Add examples for resolve cluster operation" update: @@ -369,7 +369,7 @@ actions: application/json: examples: resolveClusterResponseExample1: - $ref: "../../specification/indices/resolve_cluster/ResolveClusterResponseExample1.yaml" + $ref: "../../specification/indices/resolve_cluster/examples/200_response/ResolveClusterResponseExample1.yaml" - target: "$.components['requestBodies']['indices.shrink']" description: "Add example for shrink index request" update: @@ -377,7 +377,7 @@ actions: application/json: examples: indicesShrinkRequestExample1: - $ref: "../../specification/indices/shrink/indicesShrinkRequestExample1.yaml" + $ref: "../../specification/indices/shrink/examples/request/indicesShrinkRequestExample1.yaml" - target: "$.components['requestBodies']['indices.split']" description: "Add example for split index request" update: @@ -385,7 +385,7 @@ actions: application/json: examples: indicesSplitRequestExample1: - $ref: "../../specification/indices/split/indicesSplitRequestExample1.yaml" + $ref: "../../specification/indices/split/examples/request/indicesSplitRequestExample1.yaml" - target: "$.components['requestBodies']['indices.put_template']" description: "Add example for legacy create template request" update: @@ -393,7 +393,7 @@ actions: application/json: examples: indicesLegacyPutTemplateRequestExample1: - $ref: "../../specification/indices/put_template/indicesPutTemplateRequestExample1.yaml" + $ref: "../../specification/indices/put_template/examples/request/indicesPutTemplateRequestExample1.yaml" ## Examples for behavioral analytics - target: "$.paths['/_application/analytics/{collection_name}/event/{event_type}']['post']" description: "Add examples for post analytics collection event operation" @@ -403,7 +403,7 @@ actions: application/json: examples: postBehavioralAnalyticsEventRequestExample1: - $ref: "../../specification/search_application/post_behavioral_analytics_event/BehavioralAnalyticsEventPostRequestExample1.yaml" + $ref: "../../specification/search_application/post_behavioral_analytics_event/examples/request/BehavioralAnalyticsEventPostRequestExample1.yaml" ## Examples for indices - target: "$.paths['/_lifecycle/stats']['get']" description: "Add examples for get lifecycle stats operation" @@ -452,7 +452,7 @@ actions: application/json: examples: getBasicStatusResponseExample1: - $ref: "../../specification/license/get_basic_status/GetBasicLicenseStatusResponseExample1.yaml" + $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: @@ -462,7 +462,7 @@ actions: application/json: examples: getLicenseResponseExample1: - $ref: "../../specification/license/get_trial_status/GetTrialLicenseStatusResponseExample1.yaml" + $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: @@ -472,7 +472,7 @@ actions: application/json: examples: startBasicLicenseResponseExample1: - $ref: "../../specification/license/post_start_basic/StartBasicLicenseResponseExample1.yaml" + $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: @@ -482,7 +482,7 @@ actions: application/json: examples: startTrialLicenseResponseExample1: - $ref: "../../specification/license/post_start_trial/StartTrialLicenseResponseExample1.yaml" + $ref: "../../specification/license/post_start_trial/examples/200_response/StartTrialLicenseResponseExample1.yaml" - target: "$.components['requestBodies']['license.post']" description: "Add examples for update license request" update: @@ -490,7 +490,7 @@ actions: application/json: examples: updateLicenseRequestExample1: - $ref: "../../specification/license/post/PostLicenseRequestExample1.yaml" + $ref: "../../specification/license/post/examples/request/PostLicenseRequestExample1.yaml" - target: "$.components['responses']['license.post#200']" description: "Add examples for update license response" update: @@ -498,7 +498,7 @@ actions: application/json: examples: clusterHealthResponseExample1: - $ref: "../../specification/license/post/PostLicenseResponseExample1.yaml" + $ref: "../../specification/license/post/examples/200_response/PostLicenseResponseExample1.yaml" ## Examples for search applications - target: "$.paths['/_application/search_application/{name}/_render_query']['post']" description: "Add examples for render search application query operation" @@ -508,9 +508,9 @@ actions: application/json: examples: renderSearchApplicationQueryRequestExample1: - $ref: "../../specification/search_application/render_query/SearchApplicationsRenderQueryRequestExample1.yaml" + $ref: "../../specification/search_application/render_query/examples/request/SearchApplicationsRenderQueryRequestExample1.yaml" renderSearchApplicationQueryResponseExample1: - $ref: "../../specification/search_application/render_query/SearchApplicationsRenderQueryResponseExample1.yaml" + $ref: "../../specification/search_application/render_query/examples/request/SearchApplicationsRenderQueryResponseExample1.yaml" # Examples for security - target: "$.paths['/_security/api_key/_bulk_update']['post']" description: "Add examples for bulk update API keys operation" diff --git a/docs/overlays/elasticsearch-shared-overlays.yaml b/docs/overlays/elasticsearch-shared-overlays.yaml index c54c8281ee..1a4828c983 100644 --- a/docs/overlays/elasticsearch-shared-overlays.yaml +++ b/docs/overlays/elasticsearch-shared-overlays.yaml @@ -1190,7 +1190,7 @@ actions: application/json: examples: indicesAddBlockResponseExample1: - $ref: "../../specification/indices/add_block/IndicesAddBlockResponseExample1.yaml" + $ref: "../../specification/indices/add_block/examples/response/IndicesAddBlockResponseExample1.yaml" - target: "$.components['requestBodies']['indices.analyze']" description: "Add example for analyze API request" update: @@ -1198,7 +1198,7 @@ actions: application/json: examples: indicesAnalyzeRequestExample1: - $ref: "../../specification/indices/analyze/indicesAnalyzeRequestExample1.yaml" + $ref: "../../specification/indices/analyze/examples/request/indicesAnalyzeRequestExample1.yaml" - target: "$.paths['/{index}']['put']" description: "Add examples for create index request" update: @@ -1207,9 +1207,9 @@ actions: application/json: examples: indicesCreateRequestExample1: - $ref: "../../specification/indices/create/indicesCreateRequestExample1.yaml" + $ref: "../../specification/indices/create/examples/request/indicesCreateRequestExample1.yaml" indicesCreateRequestExample2: - $ref: "../../specification/indices/create/indicesCreateRequestExample2.yaml" + $ref: "../../specification/indices/create/examples/request/indicesCreateRequestExample2.yaml" - target: "$.paths['/_data_stream/{name}/_lifecycle']['delete']" description: "Add example for delete data stream lifecycle response" update: @@ -1219,7 +1219,7 @@ actions: application/json: examples: indicesDeleteDataLifecycleResponseExample1: - $ref: "../../specification/indices/delete_data_lifecycle/IndicesDeleteDataLifecycleResponseExample1.yaml" + $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: @@ -1229,7 +1229,7 @@ actions: application/json: examples: indicesGetDataLifecycleResponseExample1: - $ref: "../../specification/indices/get_data_lifecycle/IndicesGetDataLifecycleResponseExample1.yaml" + $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: @@ -1237,7 +1237,7 @@ actions: application/json: examples: indicesGetDataStreamResponseExample: - $ref: "../../specification/indices/get_data_stream/indicesGetDataStreamResponseExample1.yaml" + $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: @@ -1246,16 +1246,16 @@ actions: application/json: examples: indicesPutDataLifecycleRequestExample1: - $ref: "../../specification/indices/put_data_lifecycle/IndicesPutDataLifecycleRequestExample1.yaml" + $ref: "../../specification/indices/put_data_lifecycle/examples/request/IndicesPutDataLifecycleRequestExample1.yaml" indicesPutLifecycleRequestExample2: - $ref: "../../specification/indices/put_data_lifecycle/IndicesPutDataLifecycleRequestExample2.yaml" + $ref: "../../specification/indices/put_data_lifecycle/examples/request/IndicesPutDataLifecycleRequestExample2.yaml" responses: 200: content: application/json: examples: indicesPutDataLifecycleResponseExample1: - $ref: "../../specification/indices/put_data_lifecycle/IndicesPutDataLifecycleResponseExample1.yaml" + $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: @@ -1265,7 +1265,7 @@ actions: application/json: examples: indicesExplainDataLifecycleResponseExample: - $ref: "../../specification/indices/explain_data_lifecycle/IndicesExplainDataLifecycleResponseExample1.yaml" + $ref: "../../specification/indices/explain_data_lifecycle/examples/response/IndicesExplainDataLifecycleResponseExample1.yaml" - target: "$.components['responses']['ingest.get_pipeline#200']" description: "Add example for get pipeline response" update: @@ -1273,7 +1273,7 @@ actions: application/json: examples: indicesGetDataStreamResponseExample: - $ref: "../../specification/ingest/get_pipeline/GetPipelineResponseExample1.yaml" + $ref: "../../specification/ingest/get_pipeline/examples/200_response/GetPipelineResponseExample1.yaml" - target: "$.paths['/_ingest/pipeline/{id}']['put']" description: "Add examples for create pipeline" update: @@ -1282,9 +1282,9 @@ actions: application/json: examples: putPipelineRequestExample1: - $ref: "../../specification/ingest/put_pipeline/PutPipelineRequestExample1.yaml" + $ref: "../../specification/ingest/put_pipeline/examples/request/PutPipelineRequestExample1.yaml" putPipelineRequestExample2: - $ref: "../../specification/ingest/put_pipeline/PutPipelineRequestExample2.yaml" + $ref: "../../specification/ingest/put_pipeline/examples/request/PutPipelineRequestExample2.yaml" - target: "$.components['requestBodies']['ingest.simulate']" description: "Add example for simulate pipeline request" update: @@ -1308,7 +1308,7 @@ actions: application/json: examples: indicesPutIndexTemplateRequestExample1: - $ref: "../../specification/indices/put_index_template/indicesPutIndexTemplateRequestExample1.yaml" + $ref: "../../specification/indices/put_index_template/examples/request/indicesPutIndexTemplateRequestExample1.yaml" - target: "$.components['requestBodies']['indices.put_mapping']" description: "Add example for update mapping request" update: @@ -1316,7 +1316,7 @@ actions: application/json: examples: indicesPutSettingRequestExample1: - $ref: "../../specification/indices/put_mapping/indicesPutMappingRequestExample1.yaml" + $ref: "../../specification/indices/put_mapping/examples/request/indicesPutMappingRequestExample1.yaml" - target: "$.components['requestBodies']['indices.put_settings']" description: "Add example for update index settings request" update: @@ -1324,7 +1324,7 @@ actions: application/json: examples: indicesPutSettingRequestExample1: - $ref: "../../specification/indices/put_settings/IndicesPutSettingsRequestExample1.yaml" + $ref: "../../specification/indices/put_settings/examples/request/IndicesPutSettingsRequestExample1.yaml" - target: "$.paths['/_resolve/index/{name}']['get']" description: "Add examples for resolve index operation" update: @@ -1342,7 +1342,7 @@ actions: application/json: examples: indicesRolloverRequestExample1: - $ref: "../../specification/indices/rollover/indicesRolloverRequestExample1.yaml" + $ref: "../../specification/indices/rollover/examples/request/indicesRolloverRequestExample1.yaml" - target: "$.components['responses']['indices.rollover#200']" description: "Add example for rollover index response" update: @@ -1350,7 +1350,7 @@ actions: application/json: examples: indicesRolloverResponseExample1: - $ref: "../../specification/indices/rollover/indicesRolloverResponseExample1.yaml" + $ref: "../../specification/indices/rollover/examples/200_response/indicesRolloverResponseExample1.yaml" ## Examples for behavioral analytics - target: "$.components['responses']['search_application.get_behavioral_analytics#200']" description: "Add example for get behavioral analytics collections response" @@ -1359,7 +1359,7 @@ actions: application/json: examples: getBehavioralAnalyticsCollectionsResponseExample1: - $ref: "../../specification/search_application/get_behavioral_analytics/BehavioralAnalyticsGetResponseExample1.yaml" + $ref: "../../specification/search_application/get_behavioral_analytics/examples/200_response/BehavioralAnalyticsGetResponseExample1.yaml" ## Examples for licensing - target: "$.paths['/_license']['get']" description: "Add example for get license response" @@ -1370,7 +1370,7 @@ actions: application/json: examples: getLicenseResponseExample1: - $ref: "../../specification/license/get/GetLicenseResponseExample1.yaml" + $ref: "../../specification/license/get/examples/response/GetLicenseResponseExample1.yaml" ## Examples for search applications - target: "$.paths['/_application/search_application']['get']" description: "Add examples for get search applications operation" @@ -1381,7 +1381,7 @@ actions: application/json: examples: getSearchApplicationsResponseExample1: - $ref: "../../specification/search_application/list/SearchApplicationsListResponseExample1.yaml" + $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: @@ -1391,7 +1391,7 @@ actions: application/json: examples: getSearchApplicationResponseExample1: - $ref: "../../specification/search_application/get/SearchApplicationGetResponseExample1.yaml" + $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: @@ -1400,7 +1400,7 @@ actions: application/json: examples: putSearchApplicationRequestExample1: - $ref: "../../specification/search_application/put/SearchApplicationPutRequestExample1.yaml" + $ref: "../../specification/search_application/put/examples/request/SearchApplicationPutRequestExample1.yaml" - target: "$.components['requestBodies']['search_application.search']" description: "Add example for search application search request" update: @@ -1408,4 +1408,4 @@ actions: application/json: examples: searchApplicationSearchRequestExample1: - $ref: "../../specification/search_application/search/SearchApplicationsSearchRequestExample1.yaml" \ No newline at end of file + $ref: "../../specification/search_application/search/examples/request/SearchApplicationsSearchRequestExample1.yaml" \ No newline at end of file diff --git a/specification/autoscaling/delete_autoscaling_policy/autoscalingApisDeleteAutoscalingPolicyResponseExample1.yaml b/specification/autoscaling/delete_autoscaling_policy/examples/response/DeleteAutoscalingPolicyResponseExample1.yaml similarity index 100% rename from specification/autoscaling/delete_autoscaling_policy/autoscalingApisDeleteAutoscalingPolicyResponseExample1.yaml rename to specification/autoscaling/delete_autoscaling_policy/examples/response/DeleteAutoscalingPolicyResponseExample1.yaml diff --git a/specification/autoscaling/get_autoscaling_capacity/autoscalingApisGetAutoscalingCapacityResponseExample1.yaml b/specification/autoscaling/get_autoscaling_capacity/examples/200_response/GetAutoscalingCapacityResponseExample1.yaml similarity index 100% rename from specification/autoscaling/get_autoscaling_capacity/autoscalingApisGetAutoscalingCapacityResponseExample1.yaml rename to specification/autoscaling/get_autoscaling_capacity/examples/200_response/GetAutoscalingCapacityResponseExample1.yaml diff --git a/specification/autoscaling/get_autoscaling_policy/autoscalingApisGetAutoscalingPolicyResponseExample1.yaml b/specification/autoscaling/get_autoscaling_policy/examples/200_response/GetAutoscalingPolicyResponseExample1.yaml similarity index 100% rename from specification/autoscaling/get_autoscaling_policy/autoscalingApisGetAutoscalingPolicyResponseExample1.yaml rename to specification/autoscaling/get_autoscaling_policy/examples/200_response/GetAutoscalingPolicyResponseExample1.yaml diff --git a/specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyResponseExample1.yaml b/specification/autoscaling/put_autoscaling_policy/examples/200_response/PutAutoscalingPolicyResponseExample1.yaml similarity index 100% rename from specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyResponseExample1.yaml rename to specification/autoscaling/put_autoscaling_policy/examples/200_response/PutAutoscalingPolicyResponseExample1.yaml diff --git a/specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyRequestExample1.yaml b/specification/autoscaling/put_autoscaling_policy/examples/request/PutAutoscalingPolicyRequestExample1.yaml similarity index 100% rename from specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyRequestExample1.yaml rename to specification/autoscaling/put_autoscaling_policy/examples/request/PutAutoscalingPolicyRequestExample1.yaml diff --git a/specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyRequestExample2.yaml b/specification/autoscaling/put_autoscaling_policy/examples/request/PutAutoscalingPolicyRequestExample2.yaml similarity index 100% rename from specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyRequestExample2.yaml rename to specification/autoscaling/put_autoscaling_policy/examples/request/PutAutoscalingPolicyRequestExample2.yaml diff --git a/specification/cluster/put_component_template/ClusterPutComponentTemplateRequestExample1.yaml b/specification/cluster/put_component_template/examples/request/ClusterPutComponentTemplateRequestExample1.yaml similarity index 100% rename from specification/cluster/put_component_template/ClusterPutComponentTemplateRequestExample1.yaml rename to specification/cluster/put_component_template/examples/request/ClusterPutComponentTemplateRequestExample1.yaml diff --git a/specification/cluster/put_component_template/ClusterPutComponentTemplateRequestExample2.yaml b/specification/cluster/put_component_template/examples/request/ClusterPutComponentTemplateRequestExample2.yaml similarity index 100% rename from specification/cluster/put_component_template/ClusterPutComponentTemplateRequestExample2.yaml rename to specification/cluster/put_component_template/examples/request/ClusterPutComponentTemplateRequestExample2.yaml diff --git a/specification/connector/check_in/ConnectorCheckInResponseExample1.yaml b/specification/connector/check_in/examples/response/ConnectorCheckInResponseExample1.yaml similarity index 100% rename from specification/connector/check_in/ConnectorCheckInResponseExample1.yaml rename to specification/connector/check_in/examples/response/ConnectorCheckInResponseExample1.yaml diff --git a/specification/connector/delete/ConnectorDeleteResponseExample1.yaml b/specification/connector/delete/examples/response/ConnectorDeleteResponseExample1.yaml similarity index 100% rename from specification/connector/delete/ConnectorDeleteResponseExample1.yaml rename to specification/connector/delete/examples/response/ConnectorDeleteResponseExample1.yaml diff --git a/specification/connector/last_sync/ConnectorUpdateLastSyncRequestExample1.yaml b/specification/connector/last_sync/examples/request/ConnectorUpdateLastSyncRequestExample1.yaml similarity index 100% rename from specification/connector/last_sync/ConnectorUpdateLastSyncRequestExample1.yaml rename to specification/connector/last_sync/examples/request/ConnectorUpdateLastSyncRequestExample1.yaml diff --git a/specification/connector/put/ConnectorPutRequestExample1.yaml b/specification/connector/put/examples/request/ConnectorPutRequestExample1.yaml similarity index 100% rename from specification/connector/put/ConnectorPutRequestExample1.yaml rename to specification/connector/put/examples/request/ConnectorPutRequestExample1.yaml diff --git a/specification/connector/put/ConnectorPutRequestExample2.yaml b/specification/connector/put/examples/request/ConnectorPutRequestExample2.yaml similarity index 100% rename from specification/connector/put/ConnectorPutRequestExample2.yaml rename to specification/connector/put/examples/request/ConnectorPutRequestExample2.yaml diff --git a/specification/connector/put/ConnectorPutResponseExample1.yaml b/specification/connector/put/examples/response/ConnectorPutResponseExample1.yaml similarity index 100% rename from specification/connector/put/ConnectorPutResponseExample1.yaml rename to specification/connector/put/examples/response/ConnectorPutResponseExample1.yaml diff --git a/specification/connector/sync_job_delete/SyncJobDeleteResponseExample1.yaml b/specification/connector/sync_job_delete/examples/response/SyncJobDeleteResponseExample1.yaml similarity index 100% rename from specification/connector/sync_job_delete/SyncJobDeleteResponseExample1.yaml rename to specification/connector/sync_job_delete/examples/response/SyncJobDeleteResponseExample1.yaml diff --git a/specification/connector/sync_job_error/SyncJobErrorRequestExample1.yaml b/specification/connector/sync_job_error/examples/request/SyncJobErrorRequestExample1.yaml similarity index 100% rename from specification/connector/sync_job_error/SyncJobErrorRequestExample1.yaml rename to specification/connector/sync_job_error/examples/request/SyncJobErrorRequestExample1.yaml diff --git a/specification/connector/sync_job_post/SyncJobPostRequestExample1.yaml b/specification/connector/sync_job_post/examples/request/SyncJobPostRequestExample1.yaml similarity index 100% rename from specification/connector/sync_job_post/SyncJobPostRequestExample1.yaml rename to specification/connector/sync_job_post/examples/request/SyncJobPostRequestExample1.yaml diff --git a/specification/connector/update_api_key_id/ConnectorUpdateApiKeyIdExample1.yaml b/specification/connector/update_api_key_id/examples/request/ConnectorUpdateApiKeyIDRequestExample1.yaml similarity index 100% rename from specification/connector/update_api_key_id/ConnectorUpdateApiKeyIdExample1.yaml rename to specification/connector/update_api_key_id/examples/request/ConnectorUpdateApiKeyIDRequestExample1.yaml diff --git a/specification/connector/update_api_key_id/ConnectorUpdateAPIKeyIDResponseExample1.yaml b/specification/connector/update_api_key_id/examples/response/ConnectorUpdateAPIKeyIDResponseExample1.yaml similarity index 100% rename from specification/connector/update_api_key_id/ConnectorUpdateAPIKeyIDResponseExample1.yaml rename to specification/connector/update_api_key_id/examples/response/ConnectorUpdateAPIKeyIDResponseExample1.yaml diff --git a/specification/connector/update_configuration/ConnectorUpdateConfigurationRequestExample1.yaml b/specification/connector/update_configuration/examples/request/ConnectorUpdateConfigurationRequestExample1.yaml similarity index 100% rename from specification/connector/update_configuration/ConnectorUpdateConfigurationRequestExample1.yaml rename to specification/connector/update_configuration/examples/request/ConnectorUpdateConfigurationRequestExample1.yaml diff --git a/specification/connector/update_configuration/ConnectorUpdateConfigurationRequestExample2.yaml b/specification/connector/update_configuration/examples/request/ConnectorUpdateConfigurationRequestExample2.yaml similarity index 100% rename from specification/connector/update_configuration/ConnectorUpdateConfigurationRequestExample2.yaml rename to specification/connector/update_configuration/examples/request/ConnectorUpdateConfigurationRequestExample2.yaml diff --git a/specification/connector/update_configuration/ConnectorUpdateConfigurationResponseExample1.yaml b/specification/connector/update_configuration/examples/response/ConnectorUpdateConfigurationResponseExample1.yaml similarity index 100% rename from specification/connector/update_configuration/ConnectorUpdateConfigurationResponseExample1.yaml rename to specification/connector/update_configuration/examples/response/ConnectorUpdateConfigurationResponseExample1.yaml diff --git a/specification/connector/update_error/ConnectorUpdateErrorRequestExample1.yaml b/specification/connector/update_error/examples/request/ConnectorUpdateErrorRequestExample1.yaml similarity index 100% rename from specification/connector/update_error/ConnectorUpdateErrorRequestExample1.yaml rename to specification/connector/update_error/examples/request/ConnectorUpdateErrorRequestExample1.yaml diff --git a/specification/connector/update_error/ConnectorUpdateErrorResponseExample1.yaml b/specification/connector/update_error/examples/response/ConnectorUpdateErrorResponseExample1.yaml similarity index 100% rename from specification/connector/update_error/ConnectorUpdateErrorResponseExample1.yaml rename to specification/connector/update_error/examples/response/ConnectorUpdateErrorResponseExample1.yaml diff --git a/specification/connector/update_features/ConnectorUpdateFeaturesRequestExample1.yaml b/specification/connector/update_features/examples/request/ConnectorUpdateFeaturesRequestExample1.yaml similarity index 100% rename from specification/connector/update_features/ConnectorUpdateFeaturesRequestExample1.yaml rename to specification/connector/update_features/examples/request/ConnectorUpdateFeaturesRequestExample1.yaml diff --git a/specification/connector/update_features/ConnectorUpdateFeaturesRequestExample2.yaml b/specification/connector/update_features/examples/request/ConnectorUpdateFeaturesRequestExample2.yaml similarity index 100% rename from specification/connector/update_features/ConnectorUpdateFeaturesRequestExample2.yaml rename to specification/connector/update_features/examples/request/ConnectorUpdateFeaturesRequestExample2.yaml diff --git a/specification/connector/update_features/ConnectorUpdateFeaturesResponseExample1.yaml b/specification/connector/update_features/examples/response/ConnectorUpdateFeaturesResponseExample1.yaml similarity index 100% rename from specification/connector/update_features/ConnectorUpdateFeaturesResponseExample1.yaml rename to specification/connector/update_features/examples/response/ConnectorUpdateFeaturesResponseExample1.yaml diff --git a/specification/connector/update_filtering/ConnectorUpdateFilteringRequestExample1.yaml b/specification/connector/update_filtering/examples/request/ConnectorUpdateFilteringRequestExample1.yaml similarity index 100% rename from specification/connector/update_filtering/ConnectorUpdateFilteringRequestExample1.yaml rename to specification/connector/update_filtering/examples/request/ConnectorUpdateFilteringRequestExample1.yaml diff --git a/specification/connector/update_filtering/ConnectorUpdateFilteringRequestExample2.yaml b/specification/connector/update_filtering/examples/request/ConnectorUpdateFilteringRequestExample2.yaml similarity index 100% rename from specification/connector/update_filtering/ConnectorUpdateFilteringRequestExample2.yaml rename to specification/connector/update_filtering/examples/request/ConnectorUpdateFilteringRequestExample2.yaml diff --git a/specification/connector/update_filtering/ConnectorUpdateFilteringResponseExample1.yaml b/specification/connector/update_filtering/examples/response/ConnectorUpdateFilteringResponseExample1.yaml similarity index 100% rename from specification/connector/update_filtering/ConnectorUpdateFilteringResponseExample1.yaml rename to specification/connector/update_filtering/examples/response/ConnectorUpdateFilteringResponseExample1.yaml diff --git a/specification/connector/update_index_name/ConnectorUpdateIndexNameRequestExample1.yaml b/specification/connector/update_index_name/examples/request/ConnectorUpdateIndexNameRequestExample1.yaml similarity index 100% rename from specification/connector/update_index_name/ConnectorUpdateIndexNameRequestExample1.yaml rename to specification/connector/update_index_name/examples/request/ConnectorUpdateIndexNameRequestExample1.yaml diff --git a/specification/connector/update_index_name/ConnectorUpdateIndexNameResponseExample1.yaml b/specification/connector/update_index_name/examples/response/ConnectorUpdateIndexNameResponseExample1.yaml similarity index 100% rename from specification/connector/update_index_name/ConnectorUpdateIndexNameResponseExample1.yaml rename to specification/connector/update_index_name/examples/response/ConnectorUpdateIndexNameResponseExample1.yaml diff --git a/specification/connector/update_name/ConnectorUpdateNameRequestExample1.yaml b/specification/connector/update_name/examples/request/ConnectorUpdateNameRequestExample1.yaml similarity index 100% rename from specification/connector/update_name/ConnectorUpdateNameRequestExample1.yaml rename to specification/connector/update_name/examples/request/ConnectorUpdateNameRequestExample1.yaml diff --git a/specification/connector/update_name/ConnectorUpdateNameResponseExample1.yaml b/specification/connector/update_name/examples/response/ConnectorUpdateNameResponseExample1.yaml similarity index 100% rename from specification/connector/update_name/ConnectorUpdateNameResponseExample1.yaml rename to specification/connector/update_name/examples/response/ConnectorUpdateNameResponseExample1.yaml diff --git a/specification/connector/update_pipeline/ConnectorUpdatePipelineRequestExample1.yaml b/specification/connector/update_pipeline/examples/request/ConnectorUpdatePipelineRequestExample1.yaml similarity index 100% rename from specification/connector/update_pipeline/ConnectorUpdatePipelineRequestExample1.yaml rename to specification/connector/update_pipeline/examples/request/ConnectorUpdatePipelineRequestExample1.yaml diff --git a/specification/connector/update_pipeline/ConnectorUpdatePipelineResponseExample1.yaml b/specification/connector/update_pipeline/examples/response/ConnectorUpdatePipelineResponseExample1.yaml similarity index 100% rename from specification/connector/update_pipeline/ConnectorUpdatePipelineResponseExample1.yaml rename to specification/connector/update_pipeline/examples/response/ConnectorUpdatePipelineResponseExample1.yaml diff --git a/specification/connector/update_scheduling/ConnectorUpdateSchedulingRequestExample1.yaml b/specification/connector/update_scheduling/examples/request/ConnectorUpdateSchedulingRequestExample1.yaml similarity index 100% rename from specification/connector/update_scheduling/ConnectorUpdateSchedulingRequestExample1.yaml rename to specification/connector/update_scheduling/examples/request/ConnectorUpdateSchedulingRequestExample1.yaml diff --git a/specification/connector/update_scheduling/ConnectorUpdateSchedulingRequestExample2.yaml b/specification/connector/update_scheduling/examples/request/ConnectorUpdateSchedulingRequestExample2.yaml similarity index 100% rename from specification/connector/update_scheduling/ConnectorUpdateSchedulingRequestExample2.yaml rename to specification/connector/update_scheduling/examples/request/ConnectorUpdateSchedulingRequestExample2.yaml diff --git a/specification/connector/update_scheduling/ConnectorUpdateSchedulingResponseExample1.yaml b/specification/connector/update_scheduling/examples/response/ConnectorUpdateSchedulingResponseExample1.yaml similarity index 100% rename from specification/connector/update_scheduling/ConnectorUpdateSchedulingResponseExample1.yaml rename to specification/connector/update_scheduling/examples/response/ConnectorUpdateSchedulingResponseExample1.yaml diff --git a/specification/connector/update_service_type/ConnectorUpdateServiceTypeRequestExample1.yaml b/specification/connector/update_service_type/examples/request/ConnectorUpdateServiceTypeRequestExample1.yaml similarity index 100% rename from specification/connector/update_service_type/ConnectorUpdateServiceTypeRequestExample1.yaml rename to specification/connector/update_service_type/examples/request/ConnectorUpdateServiceTypeRequestExample1.yaml diff --git a/specification/connector/update_service_type/ConnectorUpdateServiceTypeResponseExample1.yaml b/specification/connector/update_service_type/examples/response/ConnectorUpdateServiceTypeResponseExample1.yaml similarity index 100% rename from specification/connector/update_service_type/ConnectorUpdateServiceTypeResponseExample1.yaml rename to specification/connector/update_service_type/examples/response/ConnectorUpdateServiceTypeResponseExample1.yaml diff --git a/specification/connector/update_status/ConnectorUpdateStatusRequestExample1.yaml b/specification/connector/update_status/examples/request/ConnectorUpdateStatusRequestExample1.yaml similarity index 100% rename from specification/connector/update_status/ConnectorUpdateStatusRequestExample1.yaml rename to specification/connector/update_status/examples/request/ConnectorUpdateStatusRequestExample1.yaml diff --git a/specification/connector/update_status/ConnectorUpdateStatusResponseExample1.yaml b/specification/connector/update_status/examples/response/ConnectorUpdateStatusResponseExample1.yaml similarity index 100% rename from specification/connector/update_status/ConnectorUpdateStatusResponseExample1.yaml rename to specification/connector/update_status/examples/response/ConnectorUpdateStatusResponseExample1.yaml diff --git a/specification/dangling_indices/import_dangling_index/ImportDanglingIndexResponseExample1.yaml b/specification/dangling_indices/import_dangling_index/examples/response/ImportDanglingIndexResponseExample1.yaml similarity index 100% rename from specification/dangling_indices/import_dangling_index/ImportDanglingIndexResponseExample1.yaml rename to specification/dangling_indices/import_dangling_index/examples/response/ImportDanglingIndexResponseExample1.yaml diff --git a/specification/dangling_indices/list_dangling_indices/ListDanglingIndicesResponseExample1.yaml b/specification/dangling_indices/list_dangling_indices/examples/response/ListDanglingIndicesResponseExample1.yaml similarity index 100% rename from specification/dangling_indices/list_dangling_indices/ListDanglingIndicesResponseExample1.yaml rename to specification/dangling_indices/list_dangling_indices/examples/response/ListDanglingIndicesResponseExample1.yaml diff --git a/specification/indices/add_block/IndicesAddBlockResponseExample1.yaml b/specification/indices/add_block/examples/response/IndicesAddBlockResponseExample1.yaml similarity index 100% rename from specification/indices/add_block/IndicesAddBlockResponseExample1.yaml rename to specification/indices/add_block/examples/response/IndicesAddBlockResponseExample1.yaml diff --git a/specification/indices/analyze/indicesAnalyzeResponseExample7.yaml b/specification/indices/analyze/examples/200_response/indicesAnalyzeResponseExample7.yaml similarity index 100% rename from specification/indices/analyze/indicesAnalyzeResponseExample7.yaml rename to specification/indices/analyze/examples/200_response/indicesAnalyzeResponseExample7.yaml diff --git a/specification/indices/analyze/indicesAnalyzeRequestExample1.yaml b/specification/indices/analyze/examples/request/indicesAnalyzeRequestExample1.yaml similarity index 100% rename from specification/indices/analyze/indicesAnalyzeRequestExample1.yaml rename to specification/indices/analyze/examples/request/indicesAnalyzeRequestExample1.yaml diff --git a/specification/indices/analyze/indicesAnalyzeRequestExample2.yaml b/specification/indices/analyze/examples/request/indicesAnalyzeRequestExample2.yaml similarity index 100% rename from specification/indices/analyze/indicesAnalyzeRequestExample2.yaml rename to specification/indices/analyze/examples/request/indicesAnalyzeRequestExample2.yaml diff --git a/specification/indices/analyze/indicesAnalyzeRequestExample3.yaml b/specification/indices/analyze/examples/request/indicesAnalyzeRequestExample3.yaml similarity index 100% rename from specification/indices/analyze/indicesAnalyzeRequestExample3.yaml rename to specification/indices/analyze/examples/request/indicesAnalyzeRequestExample3.yaml diff --git a/specification/indices/analyze/indicesAnalyzeRequestExample4.yaml b/specification/indices/analyze/examples/request/indicesAnalyzeRequestExample4.yaml similarity index 100% rename from specification/indices/analyze/indicesAnalyzeRequestExample4.yaml rename to specification/indices/analyze/examples/request/indicesAnalyzeRequestExample4.yaml diff --git a/specification/indices/analyze/indicesAnalyzeRequestExample5.yaml b/specification/indices/analyze/examples/request/indicesAnalyzeRequestExample5.yaml similarity index 100% rename from specification/indices/analyze/indicesAnalyzeRequestExample5.yaml rename to specification/indices/analyze/examples/request/indicesAnalyzeRequestExample5.yaml diff --git a/specification/indices/analyze/indicesAnalyzeRequestExample6.yaml b/specification/indices/analyze/examples/request/indicesAnalyzeRequestExample6.yaml similarity index 100% rename from specification/indices/analyze/indicesAnalyzeRequestExample6.yaml rename to specification/indices/analyze/examples/request/indicesAnalyzeRequestExample6.yaml diff --git a/specification/indices/analyze/indicesAnalyzeRequestExample7.yaml b/specification/indices/analyze/examples/request/indicesAnalyzeRequestExample7.yaml similarity index 100% rename from specification/indices/analyze/indicesAnalyzeRequestExample7.yaml rename to specification/indices/analyze/examples/request/indicesAnalyzeRequestExample7.yaml diff --git a/specification/indices/clone/indicesCloneRequestExample1.yaml b/specification/indices/clone/examples/request/indicesCloneRequestExample1.yaml similarity index 100% rename from specification/indices/clone/indicesCloneRequestExample1.yaml rename to specification/indices/clone/examples/request/indicesCloneRequestExample1.yaml diff --git a/specification/indices/create/indicesCreateRequestExample1.yaml b/specification/indices/create/examples/request/indicesCreateRequestExample1.yaml similarity index 100% rename from specification/indices/create/indicesCreateRequestExample1.yaml rename to specification/indices/create/examples/request/indicesCreateRequestExample1.yaml diff --git a/specification/indices/create/indicesCreateRequestExample2.yaml b/specification/indices/create/examples/request/indicesCreateRequestExample2.yaml similarity index 100% rename from specification/indices/create/indicesCreateRequestExample2.yaml rename to specification/indices/create/examples/request/indicesCreateRequestExample2.yaml diff --git a/specification/indices/create/indicesCreateRequestExample3.yaml b/specification/indices/create/examples/request/indicesCreateRequestExample3.yaml similarity index 100% rename from specification/indices/create/indicesCreateRequestExample3.yaml rename to specification/indices/create/examples/request/indicesCreateRequestExample3.yaml diff --git a/specification/indices/data_streams_stats/indicesDataStreamStatsResponseExample1.yaml b/specification/indices/data_streams_stats/examples/200_response/indicesDataStreamStatsResponseExample1.yaml similarity index 100% rename from specification/indices/data_streams_stats/indicesDataStreamStatsResponseExample1.yaml rename to specification/indices/data_streams_stats/examples/200_response/indicesDataStreamStatsResponseExample1.yaml diff --git a/specification/indices/delete_data_lifecycle/IndicesDeleteDataLifecycleResponseExample1.yaml b/specification/indices/delete_data_lifecycle/examples/200_response/IndicesDeleteDataLifecycleResponseExample1.yaml similarity index 100% rename from specification/indices/delete_data_lifecycle/IndicesDeleteDataLifecycleResponseExample1.yaml rename to specification/indices/delete_data_lifecycle/examples/200_response/IndicesDeleteDataLifecycleResponseExample1.yaml diff --git a/specification/indices/disk_usage/indicesDiskUsageResponseExample1.yaml b/specification/indices/disk_usage/request/200_response/indicesDiskUsageResponseExample1.yaml similarity index 100% rename from specification/indices/disk_usage/indicesDiskUsageResponseExample1.yaml rename to specification/indices/disk_usage/request/200_response/indicesDiskUsageResponseExample1.yaml diff --git a/specification/indices/downsample/RequestExample1.yaml b/specification/indices/downsample/examples/request/RequestExample1.yaml similarity index 100% rename from specification/indices/downsample/RequestExample1.yaml rename to specification/indices/downsample/examples/request/RequestExample1.yaml diff --git a/specification/indices/explain_data_lifecycle/IndicesExplainDataLifecycleResponseExample1.yaml b/specification/indices/explain_data_lifecycle/examples/response/IndicesExplainDataLifecycleResponseExample1.yaml similarity index 100% rename from specification/indices/explain_data_lifecycle/IndicesExplainDataLifecycleResponseExample1.yaml rename to specification/indices/explain_data_lifecycle/examples/response/IndicesExplainDataLifecycleResponseExample1.yaml diff --git a/specification/indices/explain_data_lifecycle/IndicesExplainDataLifecycleResponseExample2.yaml b/specification/indices/explain_data_lifecycle/examples/response/IndicesExplainDataLifecycleResponseExample2.yaml similarity index 100% rename from specification/indices/explain_data_lifecycle/IndicesExplainDataLifecycleResponseExample2.yaml rename to specification/indices/explain_data_lifecycle/examples/response/IndicesExplainDataLifecycleResponseExample2.yaml diff --git a/specification/indices/field_usage_stats/indicesFieldUsageStatsResponseExample1.yaml b/specification/indices/field_usage_stats/examples/200_response/indicesFieldUsageStatsResponseExample1.yaml similarity index 100% rename from specification/indices/field_usage_stats/indicesFieldUsageStatsResponseExample1.yaml rename to specification/indices/field_usage_stats/examples/200_response/indicesFieldUsageStatsResponseExample1.yaml diff --git a/specification/indices/get_data_lifecycle/IndicesGetDataLifecycleResponseExample1.yaml b/specification/indices/get_data_lifecycle/examples/response/IndicesGetDataLifecycleResponseExample1.yaml similarity index 100% rename from specification/indices/get_data_lifecycle/IndicesGetDataLifecycleResponseExample1.yaml rename to specification/indices/get_data_lifecycle/examples/response/IndicesGetDataLifecycleResponseExample1.yaml diff --git a/specification/indices/get_data_stream/indicesGetDataStreamResponseExample1.yaml b/specification/indices/get_data_stream/examples/200_response/indicesGetDataStreamResponseExample1.yaml similarity index 100% rename from specification/indices/get_data_stream/indicesGetDataStreamResponseExample1.yaml rename to specification/indices/get_data_stream/examples/200_response/indicesGetDataStreamResponseExample1.yaml diff --git a/specification/indices/get_field_mapping/indicesGetFieldMappingResponseExample1.yaml b/specification/indices/get_field_mapping/examples/response/indicesGetFieldMappingResponseExample1.yaml similarity index 100% rename from specification/indices/get_field_mapping/indicesGetFieldMappingResponseExample1.yaml rename to specification/indices/get_field_mapping/examples/response/indicesGetFieldMappingResponseExample1.yaml diff --git a/specification/indices/get_field_mapping/indicesGetFieldMappingResponseExample2.yaml b/specification/indices/get_field_mapping/examples/response/indicesGetFieldMappingResponseExample2.yaml similarity index 100% rename from specification/indices/get_field_mapping/indicesGetFieldMappingResponseExample2.yaml rename to specification/indices/get_field_mapping/examples/response/indicesGetFieldMappingResponseExample2.yaml diff --git a/specification/indices/get_field_mapping/indicesGetFieldMappingResponseExample3.yaml b/specification/indices/get_field_mapping/examples/response/indicesGetFieldMappingResponseExample3.yaml similarity index 100% rename from specification/indices/get_field_mapping/indicesGetFieldMappingResponseExample3.yaml rename to specification/indices/get_field_mapping/examples/response/indicesGetFieldMappingResponseExample3.yaml diff --git a/specification/indices/open/indicesOpenResponseExample1.yaml b/specification/indices/open/examples/200_response/indicesOpenResponseExample1.yaml similarity index 100% rename from specification/indices/open/indicesOpenResponseExample1.yaml rename to specification/indices/open/examples/200_response/indicesOpenResponseExample1.yaml diff --git a/specification/indices/put_alias/indicesPutAliasRequestExample1.yaml b/specification/indices/put_alias/examples/request/indicesPutAliasRequestExample1.yaml similarity index 100% rename from specification/indices/put_alias/indicesPutAliasRequestExample1.yaml rename to specification/indices/put_alias/examples/request/indicesPutAliasRequestExample1.yaml diff --git a/specification/indices/put_data_lifecycle/IndicesPutDataLifecycleResponseExample1.yaml b/specification/indices/put_data_lifecycle/examples/200_response/IndicesPutDataLifecycleResponseExample1.yaml similarity index 100% rename from specification/indices/put_data_lifecycle/IndicesPutDataLifecycleResponseExample1.yaml rename to specification/indices/put_data_lifecycle/examples/200_response/IndicesPutDataLifecycleResponseExample1.yaml diff --git a/specification/indices/put_data_lifecycle/IndicesPutDataLifecycleRequestExample1.yaml b/specification/indices/put_data_lifecycle/examples/request/IndicesPutDataLifecycleRequestExample1.yaml similarity index 100% rename from specification/indices/put_data_lifecycle/IndicesPutDataLifecycleRequestExample1.yaml rename to specification/indices/put_data_lifecycle/examples/request/IndicesPutDataLifecycleRequestExample1.yaml diff --git a/specification/indices/put_data_lifecycle/IndicesPutDataLifecycleRequestExample2.yaml b/specification/indices/put_data_lifecycle/examples/request/IndicesPutDataLifecycleRequestExample2.yaml similarity index 100% rename from specification/indices/put_data_lifecycle/IndicesPutDataLifecycleRequestExample2.yaml rename to specification/indices/put_data_lifecycle/examples/request/IndicesPutDataLifecycleRequestExample2.yaml diff --git a/specification/indices/put_index_template/IndicesPutIndexTemplateRequestExample1.yaml b/specification/indices/put_index_template/examples/request/IndicesPutIndexTemplateRequestExample1.yaml similarity index 100% rename from specification/indices/put_index_template/IndicesPutIndexTemplateRequestExample1.yaml rename to specification/indices/put_index_template/examples/request/IndicesPutIndexTemplateRequestExample1.yaml diff --git a/specification/indices/put_index_template/IndicesPutIndexTemplateRequestExample2.yaml b/specification/indices/put_index_template/examples/request/IndicesPutIndexTemplateRequestExample2.yaml similarity index 100% rename from specification/indices/put_index_template/IndicesPutIndexTemplateRequestExample2.yaml rename to specification/indices/put_index_template/examples/request/IndicesPutIndexTemplateRequestExample2.yaml diff --git a/specification/indices/put_mapping/indicesPutMappingRequestExample1.yaml b/specification/indices/put_mapping/examples/request/indicesPutMappingRequestExample1.yaml similarity index 100% rename from specification/indices/put_mapping/indicesPutMappingRequestExample1.yaml rename to specification/indices/put_mapping/examples/request/indicesPutMappingRequestExample1.yaml diff --git a/specification/indices/put_settings/IndicesPutSettingsRequestExample1.yaml b/specification/indices/put_settings/examples/request/IndicesPutSettingsRequestExample1.yaml similarity index 100% rename from specification/indices/put_settings/IndicesPutSettingsRequestExample1.yaml rename to specification/indices/put_settings/examples/request/IndicesPutSettingsRequestExample1.yaml diff --git a/specification/indices/put_settings/indicesPutSettingsRequestExample2.yaml b/specification/indices/put_settings/examples/request/indicesPutSettingsRequestExample2.yaml similarity index 100% rename from specification/indices/put_settings/indicesPutSettingsRequestExample2.yaml rename to specification/indices/put_settings/examples/request/indicesPutSettingsRequestExample2.yaml diff --git a/specification/indices/put_settings/indicesPutSettingsRequestExample3.yaml b/specification/indices/put_settings/examples/request/indicesPutSettingsRequestExample3.yaml similarity index 100% rename from specification/indices/put_settings/indicesPutSettingsRequestExample3.yaml rename to specification/indices/put_settings/examples/request/indicesPutSettingsRequestExample3.yaml diff --git a/specification/indices/put_template/indicesPutTemplateRequestExample1.yaml b/specification/indices/put_template/examples/request/indicesPutTemplateRequestExample1.yaml similarity index 100% rename from specification/indices/put_template/indicesPutTemplateRequestExample1.yaml rename to specification/indices/put_template/examples/request/indicesPutTemplateRequestExample1.yaml diff --git a/specification/indices/put_template/indicesPutTemplateRequestExample2.yaml b/specification/indices/put_template/examples/request/indicesPutTemplateRequestExample2.yaml similarity index 100% rename from specification/indices/put_template/indicesPutTemplateRequestExample2.yaml rename to specification/indices/put_template/examples/request/indicesPutTemplateRequestExample2.yaml diff --git a/specification/indices/recovery/indicesRecoveryResponseExample1.yaml b/specification/indices/recovery/examples/200_response/indicesRecoveryResponseExample1.yaml similarity index 100% rename from specification/indices/recovery/indicesRecoveryResponseExample1.yaml rename to specification/indices/recovery/examples/200_response/indicesRecoveryResponseExample1.yaml diff --git a/specification/indices/recovery/indicesRecoveryResponseExample2.yaml b/specification/indices/recovery/examples/200_response/indicesRecoveryResponseExample2.yaml similarity index 100% rename from specification/indices/recovery/indicesRecoveryResponseExample2.yaml rename to specification/indices/recovery/examples/200_response/indicesRecoveryResponseExample2.yaml diff --git a/specification/indices/resolve_cluster/ResolveClusterResponseExample1.yaml b/specification/indices/resolve_cluster/examples/200_response/ResolveClusterResponseExample1.yaml similarity index 100% rename from specification/indices/resolve_cluster/ResolveClusterResponseExample1.yaml rename to specification/indices/resolve_cluster/examples/200_response/ResolveClusterResponseExample1.yaml diff --git a/specification/indices/resolve_cluster/ResolveClusterResponseExample2.yaml b/specification/indices/resolve_cluster/examples/200_response/ResolveClusterResponseExample2.yaml similarity index 100% rename from specification/indices/resolve_cluster/ResolveClusterResponseExample2.yaml rename to specification/indices/resolve_cluster/examples/200_response/ResolveClusterResponseExample2.yaml diff --git a/specification/indices/rollover/indicesRolloverResponseExample1.yaml b/specification/indices/rollover/examples/200_response/indicesRolloverResponseExample1.yaml similarity index 100% rename from specification/indices/rollover/indicesRolloverResponseExample1.yaml rename to specification/indices/rollover/examples/200_response/indicesRolloverResponseExample1.yaml diff --git a/specification/indices/rollover/indicesRolloverRequestExample1.yaml b/specification/indices/rollover/examples/request/indicesRolloverRequestExample1.yaml similarity index 100% rename from specification/indices/rollover/indicesRolloverRequestExample1.yaml rename to specification/indices/rollover/examples/request/indicesRolloverRequestExample1.yaml diff --git a/specification/indices/segments/indicesSegmentsResponseExample1.yaml b/specification/indices/segments/examples/200_response/indicesSegmentsResponseExample1.yaml similarity index 100% rename from specification/indices/segments/indicesSegmentsResponseExample1.yaml rename to specification/indices/segments/examples/200_response/indicesSegmentsResponseExample1.yaml diff --git a/specification/indices/shard_stores/indicesShardStoresResponseExample1.yaml b/specification/indices/shard_stores/examples/200_response/indicesShardStoresResponseExample1.yaml similarity index 100% rename from specification/indices/shard_stores/indicesShardStoresResponseExample1.yaml rename to specification/indices/shard_stores/examples/200_response/indicesShardStoresResponseExample1.yaml diff --git a/specification/indices/shrink/indicesShrinkRequestExample1.yaml b/specification/indices/shrink/examples/request/indicesShrinkRequestExample1.yaml similarity index 100% rename from specification/indices/shrink/indicesShrinkRequestExample1.yaml rename to specification/indices/shrink/examples/request/indicesShrinkRequestExample1.yaml diff --git a/specification/indices/simulate_index_template/indicesSimulateIndexTemplateResponseExample1.yaml b/specification/indices/simulate_index_template/examples/200_response/indicesSimulateIndexTemplateResponseExample1.yaml similarity index 100% rename from specification/indices/simulate_index_template/indicesSimulateIndexTemplateResponseExample1.yaml rename to specification/indices/simulate_index_template/examples/200_response/indicesSimulateIndexTemplateResponseExample1.yaml diff --git a/specification/indices/simulate_template/indicesSimulateTemplateResponseExample2.yaml b/specification/indices/simulate_template/examples/200_response/indicesSimulateTemplateResponseExample2.yaml similarity index 100% rename from specification/indices/simulate_template/indicesSimulateTemplateResponseExample2.yaml rename to specification/indices/simulate_template/examples/200_response/indicesSimulateTemplateResponseExample2.yaml diff --git a/specification/indices/simulate_template/indicesSimulateTemplateRequestExample1.yaml b/specification/indices/simulate_template/examples/request/indicesSimulateTemplateRequestExample1.yaml similarity index 100% rename from specification/indices/simulate_template/indicesSimulateTemplateRequestExample1.yaml rename to specification/indices/simulate_template/examples/request/indicesSimulateTemplateRequestExample1.yaml diff --git a/specification/indices/split/indicesSplitRequestExample1.yaml b/specification/indices/split/examples/request/indicesSplitRequestExample1.yaml similarity index 100% rename from specification/indices/split/indicesSplitRequestExample1.yaml rename to specification/indices/split/examples/request/indicesSplitRequestExample1.yaml diff --git a/specification/ingest/get_pipeline/GetPipelineResponseExample1.yaml b/specification/ingest/get_pipeline/examples/200_response/GetPipelineResponseExample1.yaml similarity index 100% rename from specification/ingest/get_pipeline/GetPipelineResponseExample1.yaml rename to specification/ingest/get_pipeline/examples/200_response/GetPipelineResponseExample1.yaml diff --git a/specification/ingest/put_pipeline/PutPipelineRequestExample1.yaml b/specification/ingest/put_pipeline/examples/request/PutPipelineRequestExample1.yaml similarity index 100% rename from specification/ingest/put_pipeline/PutPipelineRequestExample1.yaml rename to specification/ingest/put_pipeline/examples/request/PutPipelineRequestExample1.yaml diff --git a/specification/ingest/put_pipeline/PutPipelineRequestExample2.yaml b/specification/ingest/put_pipeline/examples/request/PutPipelineRequestExample2.yaml similarity index 100% rename from specification/ingest/put_pipeline/PutPipelineRequestExample2.yaml rename to specification/ingest/put_pipeline/examples/request/PutPipelineRequestExample2.yaml diff --git a/specification/license/get/GetLicenseResponseExample1.yaml b/specification/license/get/examples/response/GetLicenseResponseExample1.yaml similarity index 100% rename from specification/license/get/GetLicenseResponseExample1.yaml rename to specification/license/get/examples/response/GetLicenseResponseExample1.yaml diff --git a/specification/license/get_basic_status/GetBasicLicenseStatusResponseExample1.yaml b/specification/license/get_basic_status/examples/200_response/GetBasicLicenseStatusResponseExample1.yaml similarity index 100% rename from specification/license/get_basic_status/GetBasicLicenseStatusResponseExample1.yaml rename to specification/license/get_basic_status/examples/200_response/GetBasicLicenseStatusResponseExample1.yaml diff --git a/specification/license/get_trial_status/GetTrialLicenseStatusResponseExample1.yaml b/specification/license/get_trial_status/examples/200_response/GetTrialLicenseStatusResponseExample1.yaml similarity index 100% rename from specification/license/get_trial_status/GetTrialLicenseStatusResponseExample1.yaml rename to specification/license/get_trial_status/examples/200_response/GetTrialLicenseStatusResponseExample1.yaml diff --git a/specification/license/post/PostLicenseResponseExample1.yaml b/specification/license/post/examples/200_response/PostLicenseResponseExample1.yaml similarity index 100% rename from specification/license/post/PostLicenseResponseExample1.yaml rename to specification/license/post/examples/200_response/PostLicenseResponseExample1.yaml diff --git a/specification/license/post/PostLicenseRequestExample1.yaml b/specification/license/post/examples/request/PostLicenseRequestExample1.yaml similarity index 100% rename from specification/license/post/PostLicenseRequestExample1.yaml rename to specification/license/post/examples/request/PostLicenseRequestExample1.yaml diff --git a/specification/license/post_start_basic/StartBasicLicenseResponseExample1.yaml b/specification/license/post_start_basic/examples/200_response/StartBasicLicenseResponseExample1.yaml similarity index 100% rename from specification/license/post_start_basic/StartBasicLicenseResponseExample1.yaml rename to specification/license/post_start_basic/examples/200_response/StartBasicLicenseResponseExample1.yaml diff --git a/specification/license/post_start_trial/StartTrialLicenseResponseExample1.yaml b/specification/license/post_start_trial/examples/200_response/StartTrialLicenseResponseExample1.yaml similarity index 100% rename from specification/license/post_start_trial/StartTrialLicenseResponseExample1.yaml rename to specification/license/post_start_trial/examples/200_response/StartTrialLicenseResponseExample1.yaml diff --git a/specification/logstash/get_pipeline/LogstashGetPipelineResponseExample1.yaml b/specification/logstash/get_pipeline/examples/200_response/LogstashGetPipelineResponseExample1.yaml similarity index 100% rename from specification/logstash/get_pipeline/LogstashGetPipelineResponseExample1.yaml rename to specification/logstash/get_pipeline/examples/200_response/LogstashGetPipelineResponseExample1.yaml diff --git a/specification/logstash/put_pipeline/LogstashPutPipelineRequestExample1.yaml b/specification/logstash/put_pipeline/examples/request/LogstashPutPipelineRequestExample1.yaml similarity index 100% rename from specification/logstash/put_pipeline/LogstashPutPipelineRequestExample1.yaml rename to specification/logstash/put_pipeline/examples/request/LogstashPutPipelineRequestExample1.yaml diff --git a/specification/migration/deprecations/DeprecationInfoResponseExample1.yaml b/specification/migration/deprecations/examples/200_response/DeprecationInfoResponseExample1.yaml similarity index 100% rename from specification/migration/deprecations/DeprecationInfoResponseExample1.yaml rename to specification/migration/deprecations/examples/200_response/DeprecationInfoResponseExample1.yaml diff --git a/specification/migration/get_feature_upgrade_status/GetFeatureUpgradeStatusResponseExample1.yaml b/specification/migration/get_feature_upgrade_status/examples/response/GetFeatureUpgradeStatusResponseExample1.yaml similarity index 100% rename from specification/migration/get_feature_upgrade_status/GetFeatureUpgradeStatusResponseExample1.yaml rename to specification/migration/get_feature_upgrade_status/examples/response/GetFeatureUpgradeStatusResponseExample1.yaml diff --git a/specification/migration/post_feature_upgrade/PostFeatureUpgradeResponseExample1.yaml b/specification/migration/post_feature_upgrade/examples/response/PostFeatureUpgradeResponseExample1.yaml similarity index 100% rename from specification/migration/post_feature_upgrade/PostFeatureUpgradeResponseExample1.yaml rename to specification/migration/post_feature_upgrade/examples/response/PostFeatureUpgradeResponseExample1.yaml diff --git a/specification/nodes/info/nodesInfoResponseExample1.yaml b/specification/nodes/info/examples/200_response/nodesInfoResponseExample1.yaml similarity index 100% rename from specification/nodes/info/nodesInfoResponseExample1.yaml rename to specification/nodes/info/examples/200_response/nodesInfoResponseExample1.yaml diff --git a/specification/query_rules/get_rule/QueryRuleGetResponseExample1.yaml b/specification/query_rules/get_rule/examples/response/QueryRuleGetResponseExample1.yaml similarity index 100% rename from specification/query_rules/get_rule/QueryRuleGetResponseExample1.yaml rename to specification/query_rules/get_rule/examples/response/QueryRuleGetResponseExample1.yaml diff --git a/specification/query_rules/get_ruleset/QueryRulesetGetResponseExample1.yaml b/specification/query_rules/get_ruleset/examples/response/QueryRulesetGetResponseExample1.yaml similarity index 100% rename from specification/query_rules/get_ruleset/QueryRulesetGetResponseExample1.yaml rename to specification/query_rules/get_ruleset/examples/response/QueryRulesetGetResponseExample1.yaml diff --git a/specification/query_rules/list_rulesets/QueryRulesetListResponseExample1.yaml b/specification/query_rules/list_rulesets/examples/response/QueryRulesetListResponseExample1.yaml similarity index 100% rename from specification/query_rules/list_rulesets/QueryRulesetListResponseExample1.yaml rename to specification/query_rules/list_rulesets/examples/response/QueryRulesetListResponseExample1.yaml diff --git a/specification/query_rules/put_rule/QueryRulePutRequestExample1.yaml b/specification/query_rules/put_rule/examples/request/QueryRulePutRequestExample1.yaml similarity index 100% rename from specification/query_rules/put_rule/QueryRulePutRequestExample1.yaml rename to specification/query_rules/put_rule/examples/request/QueryRulePutRequestExample1.yaml diff --git a/specification/query_rules/put_ruleset/QueryRulesetPutRequestExample1.yaml b/specification/query_rules/put_ruleset/examples/request/QueryRulesetPutRequestExample1.yaml similarity index 100% rename from specification/query_rules/put_ruleset/QueryRulesetPutRequestExample1.yaml rename to specification/query_rules/put_ruleset/examples/request/QueryRulesetPutRequestExample1.yaml diff --git a/specification/query_rules/test/QueryRulesetTestRequestExample1.yaml b/specification/query_rules/test/examples/request/QueryRulesetTestRequestExample1.yaml similarity index 100% rename from specification/query_rules/test/QueryRulesetTestRequestExample1.yaml rename to specification/query_rules/test/examples/request/QueryRulesetTestRequestExample1.yaml diff --git a/specification/query_rules/test/QueryRulesetTestResponseExample1.yaml b/specification/query_rules/test/examples/response/QueryRulesetTestResponseExample1.yaml similarity index 100% rename from specification/query_rules/test/QueryRulesetTestResponseExample1.yaml rename to specification/query_rules/test/examples/response/QueryRulesetTestResponseExample1.yaml diff --git a/specification/search_application/get/SearchApplicationGetResponseExample1.yaml b/specification/search_application/get/examples/200_response/SearchApplicationGetResponseExample1.yaml similarity index 100% rename from specification/search_application/get/SearchApplicationGetResponseExample1.yaml rename to specification/search_application/get/examples/200_response/SearchApplicationGetResponseExample1.yaml diff --git a/specification/search_application/get_behavioral_analytics/BehavioralAnalyticsGetResponseExample1.yaml b/specification/search_application/get_behavioral_analytics/examples/200_response/BehavioralAnalyticsGetResponseExample1.yaml similarity index 100% rename from specification/search_application/get_behavioral_analytics/BehavioralAnalyticsGetResponseExample1.yaml rename to specification/search_application/get_behavioral_analytics/examples/200_response/BehavioralAnalyticsGetResponseExample1.yaml diff --git a/specification/search_application/list/SearchApplicationsListResponseExample1.yaml b/specification/search_application/list/examples/200_response/SearchApplicationsListResponseExample1.yaml similarity index 100% rename from specification/search_application/list/SearchApplicationsListResponseExample1.yaml rename to specification/search_application/list/examples/200_response/SearchApplicationsListResponseExample1.yaml diff --git a/specification/search_application/post_behavioral_analytics_event/BehavioralAnalyticsEventPostRequestExample1.yaml b/specification/search_application/post_behavioral_analytics_event/examples/request/BehavioralAnalyticsEventPostRequestExample1.yaml similarity index 100% rename from specification/search_application/post_behavioral_analytics_event/BehavioralAnalyticsEventPostRequestExample1.yaml rename to specification/search_application/post_behavioral_analytics_event/examples/request/BehavioralAnalyticsEventPostRequestExample1.yaml diff --git a/specification/search_application/put/SearchApplicationPutRequestExample1.yaml b/specification/search_application/put/examples/request/SearchApplicationPutRequestExample1.yaml similarity index 100% rename from specification/search_application/put/SearchApplicationPutRequestExample1.yaml rename to specification/search_application/put/examples/request/SearchApplicationPutRequestExample1.yaml diff --git a/specification/search_application/render_query/SearchApplicationsRenderQueryResponseExample1.yaml b/specification/search_application/render_query/examples/200_response/SearchApplicationsRenderQueryResponseExample1.yaml similarity index 100% rename from specification/search_application/render_query/SearchApplicationsRenderQueryResponseExample1.yaml rename to specification/search_application/render_query/examples/200_response/SearchApplicationsRenderQueryResponseExample1.yaml diff --git a/specification/search_application/render_query/SearchApplicationsRenderQueryRequestExample1.yaml b/specification/search_application/render_query/examples/request/SearchApplicationsRenderQueryRequestExample1.yaml similarity index 100% rename from specification/search_application/render_query/SearchApplicationsRenderQueryRequestExample1.yaml rename to specification/search_application/render_query/examples/request/SearchApplicationsRenderQueryRequestExample1.yaml diff --git a/specification/search_application/search/SearchApplicationsSearchRequestExample1.yaml b/specification/search_application/search/examples/request/SearchApplicationsSearchRequestExample1.yaml similarity index 100% rename from specification/search_application/search/SearchApplicationsSearchRequestExample1.yaml rename to specification/search_application/search/examples/request/SearchApplicationsSearchRequestExample1.yaml diff --git a/specification/shutdown/delete_node/ShutdownDeleteNodeResponseExample1.yaml b/specification/shutdown/delete_node/examples/response/ShutdownDeleteNodeResponseExample1.yaml similarity index 100% rename from specification/shutdown/delete_node/ShutdownDeleteNodeResponseExample1.yaml rename to specification/shutdown/delete_node/examples/response/ShutdownDeleteNodeResponseExample1.yaml diff --git a/specification/shutdown/get_node/ShutdownGetNodeResponseExample1.yaml b/specification/shutdown/get_node/examples/response/ShutdownGetNodeResponseExample1.yaml similarity index 100% rename from specification/shutdown/get_node/ShutdownGetNodeResponseExample1.yaml rename to specification/shutdown/get_node/examples/response/ShutdownGetNodeResponseExample1.yaml diff --git a/specification/shutdown/put_node/ShutdownPutNodeRequestExample1.yaml b/specification/shutdown/put_node/examples/request/ShutdownPutNodeRequestExample1.yaml similarity index 100% rename from specification/shutdown/put_node/ShutdownPutNodeRequestExample1.yaml rename to specification/shutdown/put_node/examples/request/ShutdownPutNodeRequestExample1.yaml