elasticsearch-openapi-overlays.yaml

# Overlays that are specific to the Elasticsearch OpenAPI document
overlay: 1.0.0
info:
  title: Overlays for the Elasticsearch OpenAPI document
  version: 0.0.1
actions:
# Add document info details
  - target: '$.info'
    description: Add a document description and feedback link
    update:
      title: Elasticsearch API
      description: >
        Elasticsearch provides REST APIs that are used by the UI components and can be called directly to configure and access Elasticsearch features.
        
        ## Documentation source and versions
        
        This documentation is derived from the `main` branch of the [elasticsearch-specification](https://github.com/elastic/elasticsearch-specification) repository.
        It is provided under license [Attribution-NonCommercial-NoDerivatives 4.0 International](https://creativecommons.org/licenses/by-nc-nd/4.0/).

        This documentation contains work-in-progress information for future Elastic Stack releases.
      x-doc-license:
        name: Attribution-NonCommercial-NoDerivatives 4.0 International
        url: 'https://creativecommons.org/licenses/by-nc-nd/4.0/'
      x-feedbackLink:
        label: Feedback
        url: https://github.com/elastic/docs-content/issues/new?assignees=&labels=feedback%2Ccommunity&projects=&template=api-feedback.yaml&title=%5BFeedback%5D%3A+
# Add security details
  - target: '$.components'
    description: Add securitySchemes
    update:
        securitySchemes:
          apiKeyAuth:
            in: header
            name: Authorization
            type: apiKey
            description: |
              Elasticsearch APIs support key-based authentication.
              You must create an API key and use the encoded value in the request header.
              For example:

              
              ```
              curl -X GET "${ES_URL}/_cat/indices?v=true" \
                -H "Authorization: ApiKey ${API_KEY}"
              ```
              
              To get API keys, use the `/_security/api_key` APIs.
          basicAuth:
            scheme: basic
            type: http
          bearerAuth:
            scheme: bearer
            type: http
            description: |
              Elasticsearch APIs support the use of bearer tokens in the `Authorization` HTTP header to authenticate with the API.
              For examples, refer to [Token-based authentication services](https://www.elastic.co/guide/en/elasticsearch/reference/current/token-authentication-services.html)
  - target: '$'
    description: Add document security
    update:
      security:
        - apiKeyAuth: []
        - basicAuth: []
        - bearerAuth: []
# Examples that apply only to the Elasticsearch OpenAPI document
## Examples for autoscaling
  - target: "$.paths['/_autoscaling/policy/{name}']['delete']"
    description: "Add examples for delete autoscaling policy response"
    update:
      responses:
        200:
          content:
            application/json:
              examples:
                deleteAutoscalingPolicyResponseExample1:
                  $ref: "../../specification/autoscaling/delete_autoscaling_policy/examples/response/DeleteAutoscalingPolicyResponseExample1.yaml"
  - target: "$.paths['/_autoscaling/capacity']['get']"
    description: "Add examples for get autoscaling capacity response"
    update:
      responses:
        200:
          content:
            application/json:
              examples:
                getAutoscalingCapacityResponseExample1:
                  $ref: "../../specification/autoscaling/get_autoscaling_capacity/examples/200_response/GetAutoscalingCapacityResponseExample1.yaml"
  - target: "$.paths['/_autoscaling/policy/{name}']['get']"
    description: "Add examples for get autoscaling policy response"
    update:
      responses:
        200:
          content:
            application/json:
              examples:
                getAutoscalingPolicyResponseExample1:
                  $ref: "../../specification/autoscaling/get_autoscaling_policy/examples/200_response/GetAutoscalingPolicyResponseExample1.yaml"
  - target: "$.paths['/_autoscaling/policy/{name}']['put']"
    description: "Add examples for create autoscaling policy operation"
    update:
      requestBody: 
        content: 
          application/json: 
            examples:
              createAutoscalingPolicyRequestExample1: 
                $ref: "../../specification/autoscaling/put_autoscaling_policy/examples/request/PutAutoscalingPolicyRequestExample1.yaml"
              createAutoscalingPolicyRequestExample2: 
                $ref: "../../specification/autoscaling/put_autoscaling_policy/examples/request/PutAutoscalingPolicyRequestExample2.yaml"
      responses:
        200:
          content:
            application/json:
              examples:
                createAutoscalingPolicyResponseExample1:
                  $ref: "../../specification/autoscaling/put_autoscaling_policy/examples/200_response/PutAutoscalingPolicyResponseExample1.yaml"
## Examples for behavioral analytics
  - target: "$.paths['/_application/analytics/{collection_name}/event/{event_type}']['post']"
    description: "Add examples for post analytics collection event operation"
    update: 
      requestBody: 
        content: 
          application/json: 
            examples: 
              postBehavioralAnalyticsEventRequestExample1:
                $ref: "../../specification/search_application/post_behavioral_analytics_event/examples/request/BehavioralAnalyticsEventPostRequestExample1.yaml"
## Examples for cat
  - target: "$.components['responses']['cat.thread_pool#200']"
    description: "Add example for cat thread pool response"
    update: 
      content:
        text/plain:
          schema:
            type: string
          examples:
            catThreadPoolResponseExample1:
              $ref: "../../specification/cat/thread_pool/examples/200_response/CatThreadPoolResponseExample1.yaml"
            catThreadPoolResponseExample2:
              $ref: "../../specification/cat/thread_pool/examples/200_response/CatThreadPoolResponseExample2.yaml"
## Examples for ccr
  - target: "$.paths['/{index}/_ccr/follow']['put']"
    description: "Add examples for create follower operation"
    update: 
      requestBody: 
        content: 
          application/json: 
            examples: 
              createFollowIndexRequestExample1: 
                $ref: "../../specification/ccr/follow/examples/request/CreateFollowIndexRequestExample1.yaml"
      responses:
        200:
          content:
            application/json:
              examples:
                createFollowIndexResponseExample1:
                  $ref: "../../specification/ccr/follow/examples/response/CreateFollowIndexResponseExample1.yaml"
  - target: "$.paths['/{index}/_ccr/forget_follower']['post']"
    description: "Add examples for forget follower operation"
    update: 
      requestBody: 
        content: 
          application/json: 
            examples: 
              forgetFollowerRequestExample1: 
                $ref: "../../specification/ccr/forget_follower/examples/request/ForgetFollowerIndexRequestExample1.yaml"
      responses:
        200:
          content:
            application/json:
              examples:
                forgetFollowerResponseExample1:
                  $ref: "../../specification/ccr/forget_follower/examples/response/ForgetFollowerIndexResponseExample1.yaml"
  - target: "$.paths['/_ccr/auto_follow/{name}']['put']"
    description: "Add examples for create auto-follow pattern operation"
    update: 
      requestBody: 
        content: 
          application/json: 
            examples: 
              putAutoFollowPatternRequestExample1: 
                $ref: "../../specification/ccr/put_auto_follow_pattern/examples/request/PutAutoFollowPatternRequestExample1.yaml"
      responses:
        200:
          content:
            application/json:
              examples:
                putAutoFollowPatternResponseExample1:
                  $ref: "../../specification/ccr/put_auto_follow_pattern/examples/response/PutAutoFollowPatternResponseExample1.yaml"
  - target: "$.paths['/{index}/_ccr/resume_follow']['post']"
    description: "Add examples for resume a follower operation"
    update: 
      requestBody: 
        content: 
          application/json: 
            examples: 
              resumeFollowIndexRequestExample1: 
                $ref: "../../specification/ccr/resume_follow/examples/request/ResumeFollowIndexRequestExample1.yaml"
      responses:
        200:
          content:
            application/json:
              examples:
                resumeFollowIndexResponseExample1:
                  $ref: "../../specification/ccr/resume_follow/examples/response/ResumeFollowIndexResponseExample1.yaml"
  - target: "$.paths['/{index}/_ccr/unfollow']['post']"
    description: "Add examples for unfollow an index"
    update: 
      responses:
        200:
          content:
            application/json:
              examples:
                ccrUnfollowIndexResponseExample1:
                  $ref: "../../specification/ccr/unfollow/examples/response/UnfollowIndexResponseExample1.yaml"
  - target: "$.paths['/_ccr/stats']['get']"
    description: "Add examples for get ccr stats"
    update: 
      responses:
        200:
          content:
            application/json:
              examples:
                ccrStatsResponseExample1:
                  $ref: "../../specification/ccr/stats/examples/response/CcrStatsResponseExample1.yaml"
  - target: "$.paths['/_ccr/auto_follow/{name}/resume']['post']"
    description: "Add examples for resume auto-follow pattern"
    update: 
      responses:
        200:
          content:
            application/json:
              examples:
                ccrResumeAutoFollowResponseExample1:
                  $ref: "../../specification/ccr/resume_auto_follow_pattern/examples/response/ResumeAutoFollowPatternResponseExample1.yaml"
  - target: "$.paths['/{index}/_ccr/pause_follow']['post']"
    description: "Add examples for resume auto-follow pattern"
    update: 
      responses:
        200:
          content:
            application/json:
              examples:
                ccrPauseFollowResponseExample1:
                  $ref: "../../specification/ccr/pause_follow/examples/response/PauseFollowIndexResponseExample1.yaml"
  - target: "$.paths['/_ccr/auto_follow/{name}/pause']['post']"
    description: "Add examples for pause auto-follow pattern"
    update: 
      responses:
        200:
          content:
            application/json:
              examples:
                ccrPauseAutoFollowPatternResponseExample1:
                  $ref: "../../specification/ccr/pause_auto_follow_pattern/examples/response/PauseAutoFollowPatternResponseExample1.yaml"
  - target: "$.components['responses']['ccr.get_auto_follow_pattern#200']"
    description: "Add examples for get auto-follow pattern"
    update: 
      content:
        application/json:
          examples:
            ccrPauseAutoFollowPatternResponseExample1:
              $ref: "../../specification/ccr/get_auto_follow_pattern/examples/response/GetAutoFollowPatternResponseExample1.yaml"
  - target: "$.paths['/{index}/_ccr/stats']['get']"
    description: "Add examples for get follower stats"
    update: 
      responses:
        200:
          content:
            application/json:
              examples:
                ccrFollowerStatsResponseExample1:
                  $ref: "../../specification/ccr/follow_stats/examples/response/FollowIndexStatsResponseExample1.yaml"
## Examples for cluster
  - target: "$.components['requestBodies']['cluster.allocation_explain']"
    description: "Add examples for cluster allocation explain operation"
    update: 
      content: 
        application/json: 
          examples: 
            clusterAllocationExplainRequestExample1: 
              $ref: "../../specification/cluster/allocation_explain/examples/request/clusterAllocationExplainRequestExample1.yaml"
  - target: "$.components['responses']['cluster.health#200']"
    description: "Add examples for cluster health operation"
    update: 
      content:
        application/json:
          examples:
            clusterHealthResponseExample1:
              $ref: "../../specification/cluster/health/examples/response/clusterHealthResponseExample1.yaml"
  - target: "$.paths['/_cluster/settings']['put']"
    description: "Add examples for cluster update settings operation"
    update: 
      requestBody: 
        content: 
          application/json: 
            examples: 
              clusterPutSettingsRequestExample1: 
                $ref: "../../specification/cluster/put_settings/examples/request/ClusterPutSettingsRequestExample1.yaml"
              clusterPutSettingsRequestExample2: 
                $ref: "../../specification/cluster/put_settings/examples/request/ClusterPutSettingsRequestExample2.yaml"
  - target: "$.paths['/_cluster/reroute']['post']"
    description: "Add examples for cluster reroute operation"
    update: 
      requestBody: 
        content: 
          application/json: 
            examples: 
              clusterRerouteRequestExample1: 
                $ref: "../../specification/cluster/reroute/examples/request/ClusterRerouteRequestExample1.yaml"
  - target: "$.components['requestBodies']['nodes.reload_secure_settings']"
    description: "Add examples for nodes reload secure settings operation"
    update: 
      content: 
        application/json: 
          examples: 
            clusterNodesReloadSecureSettingsRequestExample1: 
              $ref: "../../specification/nodes/reload_secure_settings/examples/request/ReloadSecureSettingsRequestExample1.yaml"
  - target: "$.components['responses']['nodes.reload_secure_settings#200']"
    description: "Add response examples for nodes reload secure settings operation"
    update: 
      content:
        application/json:
          examples:
            clusterNodesReloadSecureSettingsResponseExample1:
              $ref: "../../specification/nodes/reload_secure_settings/examples/response/ReloadSecureSettingsResponseExample1.yaml"
  - target: "$.components['responses']['nodes.info#200']"
    description: "Add response examples for nodes info"
    update: 
      content:
        application/json:
          examples:
            nodesInfoResponseExample1:
              $ref: "../../specification/nodes/info/examples/200_response/nodesInfoResponseExample1.yaml"
## Examples for connectors
  - target: "$.paths['/_connector/_sync_job/{connector_sync_job_id}/_error']['put']"
    description: "Add examples for connector job sync error operation"
    update:
      requestBody: 
        content: 
          application/json: 
            examples:
              syncJobErrorRequestExample1:
                 $ref: "../../specification/connector/sync_job_error/examples/request/SyncJobErrorRequestExample1.yaml"
  - target: "$.paths['/_connector/{connector_id}/_features']['put']"
    description: "Add examples for update connector features"
    update: 
      requestBody: 
        content: 
          application/json: 
            examples: 
              connectorUpdateFeaturesRequestExample1: 
                $ref: "../../specification/connector/update_features/examples/request/ConnectorUpdateFeaturesRequestExample1.yaml"
              connectorUpdateFeaturesRequestExample2: 
                $ref: "../../specification/connector/update_features/examples/request/ConnectorUpdateFeaturesRequestExample2.yaml"
      responses:
        200:
          content:
            application/json:
              examples:
                connectorUpdateFeaturesResponseExample1:
                  $ref: "../../specification/connector/update_features/examples/response/ConnectorUpdateFeaturesResponseExample1.yaml"
## Examples for esql
  - target: "$.paths['/_query/async']['post']"
    description: "Add examples for async esql query operation"
    update:
      requestBody: 
        content: 
          application/json: 
            examples:
              esqlAsyncQueryRequestExample1:
                 $ref: "../../specification/esql/async_query/examples/request/AsyncQueryRequestExample1.yaml"
## Examples for features
  - target: "$.paths['/_features']['get']"
    description: "Add examples for get features operation"
    update:
      responses:
        200:
          content:
            application/json:
              examples:
                getFeaturesResponseExample1:
                  $ref: "../../specification/features/get_features/examples/response/GetFeaturesResponseExample1.yaml"
  - target: "$.paths['/_features/_reset']['post']"
    description: "Add examples for reset features operation"
    update:
      responses:
        200:
          content:
            application/json:
              examples:
                resetFeaturesResponseExample1:
                  $ref: "../../specification/features/reset_features/examples/response/ResetFeaturesResponseExample1.yaml"
## Examples for ilm
  - target: "$.paths['/_ilm/policy/{policy}']['delete']"
    description: "Add examples for delete lifecycle policy operation"
    update:
      responses:
        200:
          content:
            application/json:
              examples:
                deleteLifecycleResponseExample1:
                  $ref: "../../specification/ilm/delete_lifecycle/examples/response/DeleteLifecycleResponseExample1.yaml" 
  - target: "$.paths['/_ilm/policy/{policy}']['put']"
    description: "Add examples for create a lifecycle operation"
    update:
      requestBody: 
        content: 
          application/json: 
            examples:
              putLifecycleRequestExample1: 
                $ref: "../../specification/ilm/put_lifecycle/examples/request/PutLifecycleRequestExample1.yaml"
      responses:
        200:
          content:
            application/json:
              examples:
                putLifecycleResponseExample1:
                  $ref: "../../specification/ilm/put_lifecycle/examples/response/PutLifecycleResponseExample1.yaml"  
  - target: "$.components['responses']['ilm.get_lifecycle#200']"
    description: "Add examples for get lifecycle policy operation"
    update: 
      content:
        application/json:
          examples:
            getLifecycleResponseExample1:
              $ref: "../../specification/ilm/get_lifecycle/examples/response/GetLifecycleResponseExample1.yaml"
  - target: "$.paths['/_ilm/migrate_to_data_tiers']['post']"
    description: "Add examples for migrate to data tiers routing operation"
    update:
      requestBody: 
        content: 
          application/json: 
            examples: 
              migrateToDataTiersRequestExample1: 
                $ref: "../../specification/ilm/migrate_to_data_tiers/examples/request/RequestExample1.yaml"
      responses:
        200:
          content:
            application/json:
              examples:
                migrateToDataTiersResponseExample1:
                  $ref: "../../specification/ilm/migrate_to_data_tiers/examples/response/ResponseExample1.yaml"
  - target: "$.paths['/_ilm/move/{index}']['post']"
    description: "Add examples for move to lifecycle step operation"
    update:
      requestBody: 
        content: 
          application/json: 
            examples:
              moveToStepRequestExample1: 
                $ref: "../../specification/ilm/move_to_step/examples/request/MoveToStepRequestExample1.yaml"
              moveToStepRequestExample2: 
                $ref: "../../specification/ilm/move_to_step/examples/request/MoveToStepRequestExample2.yaml"
      responses:
        200:
          content:
            application/json:
              examples:
                moveToStepResponseExample1:
                  $ref: "../../specification/ilm/move_to_step/examples/response/MoveToStepResponseExample1.yaml"
  - target: "$.paths['/_ilm/start']['post']"
    description: "Add examples for start index lifecycle management operation"
    update:
      responses:
        200:
          content:
            application/json:
              examples:
                startILMResponseExample1:
                  $ref: "../../specification/ilm/start/examples/response/StartILMResponseExample1.yaml"
  - target: "$.paths['/_ilm/stop']['post']"
    description: "Add examples for stop index lifecycle management operation"
    update:
      responses:
        200:
          content:
            application/json:
              examples:
                stopILMResponseExample1:
                  $ref: "../../specification/ilm/stop/examples/response/StopILMResponseExample1.yaml"
  - target: "$.paths['/_ilm/status']['get']"
    description: "Add examples for get index lifecycle management status operation"
    update:
      responses:
        200:
          content:
            application/json:
              examples:
                getILMStatusResponseExample1:
                  $ref: "../../specification/ilm/get_status/examples/response/GetILMStatusResponseExample1.yaml"
  - target: "$.paths['/{index}/_ilm/explain']['get']"
    description: "Add examples for explain lifecycle operation"
    update:
      responses:
        200:
          content:
            application/json:
              examples:
                explainLifecycleResponseExample1:
                  $ref: "../../specification/ilm/explain_lifecycle/examples/response/ExplainLifecycleResponseExample1.yaml"
  - target: "$.paths['/{index}/_ilm/remove']['post']"
    description: "Add examples for remove policy from index operation"
    update:
      responses:
        200:
          content:
            application/json:
              examples:
                removePolicyResponseExample1:
                  $ref: "../../specification/ilm/remove_policy/examples/response/RemovePolicyResponseExample1.yaml"
## Examples for indices
  - target: "$.paths['/_lifecycle/stats']['get']"
    description: "Add examples for get lifecycle stats operation"
    update:
      responses:
        200:
          content:
            application/json:
              examples:
                dataStreamLifecycleStatsResponseExample1:
                  $ref: "../../specification/indices/get_data_lifecycle_stats/examples/response/IndicesGetDataLifecycleStatsResponseExample1.yaml"
  - target: "$.components['requestBodies']['indices.clone']"
    description: "Add examples for clone index request"
    update: 
      content: 
        application/json: 
          examples: 
            indicesCloneRequestExample1: 
              $ref: "../../specification/indices/clone/examples/request/indicesCloneRequestExample1.yaml"
  - target: "$.paths['/{index}/_close']['post']"
    description: "Add examples for close index response"
    update:
      responses:
        200:
          content:
            application/json:
              examples:
                indicesCloseResponseExample1:
                  $ref: "../../specification/indices/close/examples/response/CloseIndexResponseExample1.yaml"
  - target: "$.components['responses']['indices.data_streams_stats#200']"
    description: "Add example for data stream stats response"
    update: 
      content:
        application/json:
          examples:
            indicesDataStreamStatsResponseExample1:
              $ref: "../../specification/indices/data_streams_stats/examples/200_response/indicesDataStreamStatsResponseExample1.yaml"
  - target: "$.paths['/{index}/_open']['post']"
    description: "Add examples for open index response"
    update:
      responses:
        200:
          content:
            application/json:
              examples:
                indicesOpenResponseExample1:
                  $ref: "../../specification/indices/open/examples/200_response/indicesOpenResponseExample1.yaml"
  - target: "$.components['responses']['indices.recovery#200']"
    description: "Add example for get index recovery response"
    update: 
      content:
        application/json:
          examples:
            getIndicesRecoveryResponseExample1:
                  $ref: "../../specification/indices/recovery/examples/200_response/indicesRecoveryResponseExample1.yaml"
  - target: "$.components['responses']['indices.resolve_cluster#200']"
    description: "Add examples for resolve cluster operation"
    update: 
      content:
        application/json:
          examples:
            resolveClusterResponseExample1:
              $ref: "../../specification/indices/resolve_cluster/examples/200_response/ResolveClusterResponseExample1.yaml"
            resolveClusterResponseExample2:
              $ref: "../../specification/indices/resolve_cluster/examples/200_response/ResolveClusterResponseExample2.yaml"
  - target: "$.components['requestBodies']['indices.shrink']"
    description: "Add example for shrink index request"
    update: 
      content:
        application/json:
          examples:
            indicesShrinkRequestExample1:
              $ref: "../../specification/indices/shrink/examples/request/indicesShrinkRequestExample1.yaml"
  - target: "$.components['requestBodies']['indices.split']"
    description: "Add example for split index request"
    update: 
      content:
        application/json:
          examples:
            indicesSplitRequestExample1:
              $ref: "../../specification/indices/split/examples/request/indicesSplitRequestExample1.yaml"
  - target: "$.components['requestBodies']['indices.put_template']"
    description: "Add example for legacy create template request"
    update: 
      content:
        application/json:
          examples:
            indicesLegacyPutTemplateRequestExample1:
              $ref: "../../specification/indices/put_template/examples/request/indicesPutTemplateRequestExample1.yaml"
## Examples for inference
  - target: "$.components['requestBodies']['inference.stream_inference']"
    description: "Add example for inference stream request"
    update:
      content:
        application/json:
          examples:
            streamInferenceRequestExample1:
              $ref: "../../specification/inference/stream_inference/examples/request/StreamInferenceRequestExample1.yaml"
## Examples for ingest
  - target: "$.components['requestBodies']['simulate.ingest']"
    description: "Add example for simulate ingest request"
    update: 
      content:
        application/json:
          examples:
            simulateIngestRequestExample1:
              $ref: "../../specification/simulate/ingest/examples/request/SimulateIngestRequestExample1.yaml"
            simulateIngestRequestExample2:
              $ref: "../../specification/simulate/ingest/examples/request/SimulateIngestRequestExample2.yaml"
            simulateIngestRequestExample3:
              $ref: "../../specification/simulate/ingest/examples/request/SimulateIngestRequestExample3.yaml"
            simulateIngestRequestExample4:
              $ref: "../../specification/simulate/ingest/examples/request/SimulateIngestRequestExample4.yaml"
  - target: "$.components['responses']['simulate.ingest#200']"
    description: "Add example for simulate ingest response"
    update: 
      content:
        application/json:
          examples:
            simulateIngestResponseExample1:
              $ref: "../../specification/simulate/ingest/examples/response/SimulateIngestResponseExample1.yaml"
            simulateIngestResponseExample2:
              $ref: "../../specification/simulate/ingest/examples/response/SimulateIngestResponseExample2.yaml"
            simulateIngestResponseExample3:
              $ref: "../../specification/simulate/ingest/examples/response/SimulateIngestResponseExample3.yaml"
## Examples for licensing
  - target: "$.paths['/_license/basic_status']['get']"
    description: "Add example for get basic status response"
    update: 
      responses:
        200:
          content:
            application/json:
              examples:
                getBasicStatusResponseExample1:
                  $ref: "../../specification/license/get_basic_status/examples/200_response/GetBasicLicenseStatusResponseExample1.yaml"
  - target: "$.paths['/_license/trial_status']['get']"
    description: "Add example for get trial status response"
    update: 
      responses:
        200:
          content:
            application/json:
              examples:
                getLicenseResponseExample1:
                  $ref: "../../specification/license/get_trial_status/examples/200_response/GetTrialLicenseStatusResponseExample1.yaml"
  - target: "$.paths['/_license/start_basic']['post']"
    description: "Add example for start basic response"
    update: 
      responses:
        200:
          content:
            application/json:
              examples:
                startBasicLicenseResponseExample1:
                  $ref: "../../specification/license/post_start_basic/examples/200_response/StartBasicLicenseResponseExample1.yaml"
  - target: "$.paths['/_license/start_trial']['post']"
    description: "Add example for start trial response"
    update: 
      responses:
        200:
          content:
            application/json:
              examples:
                startTrialLicenseResponseExample1:
                  $ref: "../../specification/license/post_start_trial/examples/200_response/StartTrialLicenseResponseExample1.yaml"
  - target: "$.components['requestBodies']['license.post']"
    description: "Add examples for update license request"
    update: 
      content: 
        application/json: 
          examples: 
            updateLicenseRequestExample1: 
              $ref: "../../specification/license/post/examples/request/PostLicenseRequestExample1.yaml"
  - target: "$.components['responses']['license.post#200']"
    description: "Add examples for update license response"
    update: 
      content:
        application/json:
          examples:
            clusterHealthResponseExample1:
              $ref: "../../specification/license/post/examples/200_response/PostLicenseResponseExample1.yaml"
## Examples for machine learning
  - target: "$.components['requestBodies']['ml.explain_data_frame_analytics']"
    description: "Add examples for explain dataframe analytics"
    update: 
      content: 
        application/json: 
          examples: 
            mlDataFrameAnalyticsExplainRequestExample1: 
              $ref: "../../specification/ml/explain_data_frame_analytics/examples/request/MlExplainDataFrameAnalyticsRequestExample1.yaml"
  - target: "$.components['responses']['ml.explain_data_frame_analytics#200']"
    description: "Add examples for explain dataframe analytics response"
    update: 
      content:
        application/json:
          examples:
            mlDataFrameAnalyticsExplainResponseExample1:
              $ref: "../../specification/ml/explain_data_frame_analytics/examples/response/MlExplainDataFrameAnalyticsResponseExample1.yaml"
  - target: "$.paths['/_ml/trained_models/{model_id}/deployment/cache/_clear']['post']"
    description: "Add examples for clear trained model cache"
    update: 
      responses:
        200:
          content:
            application/json:
              examples:
                mlTrainedModelClearResponseExample1:
                  $ref: "../../specification/ml/clear_trained_model_deployment_cache/examples/response/MlClearTrainedModelDeploymentCacheResponseExample1.yaml"
  - target: "$.paths['/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}']['delete']"
    description: "Add examples for delete trained model snapshot"
    update: 
      responses:
        200:
          content:
            application/json:
              examples:
                mlTrainedModelSnapshotDeleteResponseExample1:
                  $ref: "../../specification/ml/delete_model_snapshot/examples/response/MlDeleteModelSnapshotResponseExample1.yaml"
  - target: "$.components['responses']['ml.delete_forecast#200']"
    description: "Add examples for delete forecast"
    update: 
        content:
          application/json:
            examples:
              mlForecastDeleteResponseExample1:
                $ref: "../../specification/ml/delete_forecast/examples/response/MlDeleteForecastResponseExample1.yaml"
  - target: "$.components['responses']['ml.delete_expired_data#200']"
    description: "Add examples for delete expired data"
    update: 
        content:
          application/json:
            examples:
              mlExpiredDataDeleteResponseExample1:
                $ref: "../../specification/ml/delete_expired_data/examples/response/MlDeleteExpiredDataResponseExample1.yaml"
## Examples for search applications
  - target: "$.paths['/_application/search_application/{name}/_render_query']['post']"
    description: "Add examples for render search application query operation"
    update:
      requestBody: 
        content: 
          application/json: 
            examples:
              renderSearchApplicationQueryRequestExample1: 
                $ref: "../../specification/search_application/render_query/examples/request/SearchApplicationsRenderQueryRequestExample1.yaml"
## Examples for security
  - target: "$.paths['/_security/api_key/_bulk_update']['post']"
    description: "Add examples for bulk update API keys operation"
    update:
      requestBody: 
        content: 
          application/json: 
            examples: 
              bulkUpdateApiKeysRequestExample1: 
                $ref: "../../specification/security/bulk_update_api_keys/examples/request/SecurityBulkUpdateApiKeysRequestExample1.yaml"
              bulkUpdateApiKeysRequestExample2: 
                $ref: "../../specification/security/bulk_update_api_keys/examples/request/SecurityBulkUpdateApiKeysRequestExample2.yaml"
      responses:
        200:
          content:
            application/json:
              examples:
                bulkUpdateApiKeysResponseExample1:
                  $ref: "../../specification/security/bulk_update_api_keys/examples/200_response/SecurityBulkUpdateApiKeysResponseExample1.yaml"
  - target: "$.paths['/_security/delegate_pki']['post']"
    description: "Add examples for delegate PKI operation"
    update:
      requestBody: 
        content: 
          application/json: 
            examples: 
              delegatePkiRequestExample1: 
                $ref: "../../specification/security/delegate_pki/examples/request/SecurityDelegatePkiRequestExample1.yaml"
      responses:
        200:
          content:
            application/json:
              examples:
                delegatePkiResponseExample1:
                  $ref: "../../specification/security/delegate_pki/examples/200_response/SecurityDelegatePkiResponseExample1.yaml"
## Examples for tasks
  - target: "$.paths['/_tasks']['get']"
    description: "Add examples for task management operation"
    update:
      responses:
        200:
          content:
            application/json:
              examples:
                getTasksResponseExample1:
                  $ref: "../../specification/tasks/get/examples/200_response/GetTaskResponseExample1.yaml"
## Examples for transforms
  - target: "$.paths['/_transform/_upgrade']['post']"
    description: "Add examples for transform upgrade"
    update:
      responses:
        200:
          content:
            application/json:
              examples:
                transformUpgradeResponseExample1:
                  $ref: "../../specification/transform/upgrade_transforms/examples/response/UpgradeTransformResponseExample1.yaml"
## Examples for watcher
  - target: "$.paths['/_watcher/settings']['put']"
    description: "Add request example for update watcher settings"
    update:
      requestBody: 
        content: 
          application/json: 
            examples:
              updateWatcherSettingsRequestExample1: 
                $ref: "../../specification/watcher/update_settings/examples/request/WatcherUpdateSettingsRequestExample1.yaml"
  - target: "$.paths['/_watcher/settings']['get']"
    description: "Add response example for get watcher settings"
    update:
      responses:
        200:
          content: 
            application/json: 
              examples:
                updateWatcherSettingsRequestExample1: 
                  $ref: "../../specification/watcher/get_settings/examples/200_response/WatcherGetSettingsResponseExample1.yaml"