From 176ca2830b61388ba6e17cae24da184307e93f19 Mon Sep 17 00:00:00 2001 From: lcawl Date: Wed, 15 Sep 2021 16:00:42 -0700 Subject: [PATCH 1/3] Add doc_id; remove out-dated links --- specification/ml/update_job/MlUpdateJobRequest.ts | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/specification/ml/update_job/MlUpdateJobRequest.ts b/specification/ml/update_job/MlUpdateJobRequest.ts index 7393ca686d..c182e21f79 100644 --- a/specification/ml/update_job/MlUpdateJobRequest.ts +++ b/specification/ml/update_job/MlUpdateJobRequest.ts @@ -44,19 +44,20 @@ export interface Request extends RequestBase { allow_lazy_open?: boolean analysis_limits?: AnalysisMemoryLimit /** - * Advanced configuration option. The time between each periodic persistence of the model. See Job resources. - * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-job-resource.html + * Advanced configuration option. The time between each periodic persistence of the model. + * The default value is a randomized value between 3 to 4 hours, which avoids all jobs persisting at exactly the same time. The smallest allowed value is 1 hour. + * For very large models (several GB), persistence could take 10-20 minutes, so do not set the value too low. + * If the job is open when you make the update, you must stop the datafeed, close the job, then reopen the job and restart the datafeed for the changes to take effect. */ background_persist_interval?: Time /** * Advanced configuration option. Contains custom meta data about the job. For example, it can contain custom URL information as shown in Adding custom URLs to machine learning results. - * @doc_url https://www.elastic.co/guide/en/machine-learning/7.12/ml-configuring-url.html + * @doc_id ml.customUrls */ custom_settings?: Dictionary categorization_filters?: string[] /** - * A description of the job. See Job resources. - * @doc_url https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-job-resource.html + * A description of the job. */ description?: string model_plot_config?: ModelPlotConfig From 99e854a3ef9744b9ddcb4ae11ac36142e0dfcb65 Mon Sep 17 00:00:00 2001 From: lcawl Date: Mon, 20 Sep 2021 08:19:30 -0700 Subject: [PATCH 2/3] Rebase and make contrib --- output/schema/schema.json | 8 +++----- specification/ml/update_job/MlUpdateJobRequest.ts | 2 +- 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/output/schema/schema.json b/output/schema/schema.json index e33d5749f3..d4dadae927 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -119727,8 +119727,7 @@ } }, { - "description": "Advanced configuration option. The time between each periodic persistence of the model. See Job resources.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-job-resource.html", + "description": "Advanced configuration option. The time between each periodic persistence of the model.\nThe default value is a randomized value between 3 to 4 hours, which avoids all jobs persisting at exactly the same time. The smallest allowed value is 1 hour. \nFor very large models (several GB), persistence could take 10-20 minutes, so do not set the value too low.\nIf the job is open when you make the update, you must stop the datafeed, close the job, then reopen the job and restart the datafeed for the changes to take effect.", "name": "background_persist_interval", "required": false, "type": { @@ -119741,7 +119740,7 @@ }, { "description": "Advanced configuration option. Contains custom meta data about the job. For example, it can contain custom URL information as shown in Adding custom URLs to machine learning results.", - "docUrl": "https://www.elastic.co/guide/en/machine-learning/7.12/ml-configuring-url.html", + "docId": "ml.customUrls", "name": "custom_settings", "required": false, "type": { @@ -119774,8 +119773,7 @@ } }, { - "description": "A description of the job. See Job resources.", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-job-resource.html", + "description": "A description of the job.", "name": "description", "required": false, "type": { diff --git a/specification/ml/update_job/MlUpdateJobRequest.ts b/specification/ml/update_job/MlUpdateJobRequest.ts index c182e21f79..2e6adfa3a1 100644 --- a/specification/ml/update_job/MlUpdateJobRequest.ts +++ b/specification/ml/update_job/MlUpdateJobRequest.ts @@ -45,7 +45,7 @@ export interface Request extends RequestBase { analysis_limits?: AnalysisMemoryLimit /** * Advanced configuration option. The time between each periodic persistence of the model. - * The default value is a randomized value between 3 to 4 hours, which avoids all jobs persisting at exactly the same time. The smallest allowed value is 1 hour. + * The default value is a randomized value between 3 to 4 hours, which avoids all jobs persisting at exactly the same time. The smallest allowed value is 1 hour. * For very large models (several GB), persistence could take 10-20 minutes, so do not set the value too low. * If the job is open when you make the update, you must stop the datafeed, close the job, then reopen the job and restart the datafeed for the changes to take effect. */ From dbadd1924e30d9b9417f8fb0c12dadfc88089118 Mon Sep 17 00:00:00 2001 From: lcawl Date: Mon, 20 Sep 2021 14:05:45 -0700 Subject: [PATCH 3/3] Rebased --- output/schema/schema.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/output/schema/schema.json b/output/schema/schema.json index d4dadae927..c5bb75bc40 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -119727,7 +119727,7 @@ } }, { - "description": "Advanced configuration option. The time between each periodic persistence of the model.\nThe default value is a randomized value between 3 to 4 hours, which avoids all jobs persisting at exactly the same time. The smallest allowed value is 1 hour. \nFor very large models (several GB), persistence could take 10-20 minutes, so do not set the value too low.\nIf the job is open when you make the update, you must stop the datafeed, close the job, then reopen the job and restart the datafeed for the changes to take effect.", + "description": "Advanced configuration option. The time between each periodic persistence of the model.\nThe default value is a randomized value between 3 to 4 hours, which avoids all jobs persisting at exactly the same time. The smallest allowed value is 1 hour.\nFor very large models (several GB), persistence could take 10-20 minutes, so do not set the value too low.\nIf the job is open when you make the update, you must stop the datafeed, close the job, then reopen the job and restart the datafeed for the changes to take effect.", "name": "background_persist_interval", "required": false, "type": {