Simplifies folder structure of API request and response examples (#2779)

szabosteve · web-flow · commit 9b0de25d867f · 2024-08-12T10:57:58.000+02:00
* Transform APIs.

* ML APIs.

* Fixes format.
diff --git a/specification/ml/clear_trained_model_deployment_cache/MlClearTrainedModelDeploymentCacheResponseExample1.json b/specification/ml/clear_trained_model_deployment_cache/MlClearTrainedModelDeploymentCacheResponseExample1.json
@@ -1,5 +1,8 @@
 {
   "summary": "A successful response when clearing the inference cache.",
+  "description": "",
+  "type": "response",
+  "response_code": 200,
   "value": {
     "cleared": true
   }
diff --git a/specification/ml/close_job/MlCloseJobResponseExample1.json b/specification/ml/close_job/MlCloseJobResponseExample1.json
@@ -1,5 +1,8 @@
 {
   "summary": "A successful response when closing anomaly detection jobs.",
+  "description": "",
+  "type": "response",
+  "response_code": 200,
   "value": {
     "closed": true
   }
diff --git a/specification/ml/delete_calendar/MlDeleteCalendarResponseExample1.json b/specification/ml/delete_calendar/MlDeleteCalendarResponseExample1.json
@@ -1,5 +1,8 @@
 {
   "summary": "A successful response when deleting a calendar.",
+  "description": "",
+  "type": "response",
+  "response_code": 200,
   "value": {
     "acknowledged": true
   }
diff --git a/specification/ml/delete_calendar_event/MlDeleteCalendarEventResponseExample1.json b/specification/ml/delete_calendar_event/MlDeleteCalendarEventResponseExample1.json
@@ -1,5 +1,8 @@
 {
   "summary": "A successful response when deleting a calendar event.",
+  "description": "",
+  "type": "response",
+  "response_code": 200,
   "value": {
     "acknowledged": true
   }
diff --git a/specification/ml/delete_calendar_job/MlDeleteCalendarJobResponseExample1.json b/specification/ml/delete_calendar_job/MlDeleteCalendarJobResponseExample1.json
@@ -1,5 +1,8 @@
 {
   "summary": "A successful response when deleting an anomaly detection job from a calendar.",
+  "description": "",
+  "type": "response",
+  "response_code": 200,
   "value": {
     "calendar_id": "planned-outages",
     "job_ids": []
diff --git a/specification/ml/delete_data_frame_analytics/MlDeleteDataFrameAnalyticsResponseExample1.json b/specification/ml/delete_data_frame_analytics/MlDeleteDataFrameAnalyticsResponseExample1.json
@@ -1,5 +1,8 @@
 {
   "summary": "A successful response when deleting a data frame analytics job.",
+  "description": "",
+  "type": "response",
+  "response_code": 200,
   "value": {
     "acknowledged": true
   }
diff --git a/specification/ml/delete_datafeed/MlDeleteDatafeedResponseExample1.json b/specification/ml/delete_datafeed/MlDeleteDatafeedResponseExample1.json
@@ -1,5 +1,8 @@
 {
   "summary": "A successful response when deleting a datafeed.",
+  "description": "",
+  "type": "response",
+  "response_code": 200,
   "value": {
     "acknowledged": true
   }
diff --git a/specification/ml/delete_expired_data/MlDeleteExpiredDataResponseExample1.json b/specification/ml/delete_expired_data/MlDeleteExpiredDataResponseExample1.json
@@ -1,5 +1,8 @@
 {
   "summary": "A successful response when deleting expired and unused anomaly detection data.",
+  "description": "",
+  "type": "response",
+  "response_code": 200,
   "value": {
     "deleted": true
   }
diff --git a/specification/ml/delete_filter/MlDeleteFilterResponseExample1.json b/specification/ml/delete_filter/MlDeleteFilterResponseExample1.json
@@ -1,5 +1,8 @@
 {
   "summary": "A successful response when deleting a filter.",
+  "description": "",
+  "type": "response",
+  "response_code": 200,
   "value": {
     "acknowledged": true
   }
diff --git a/specification/ml/delete_forecast/MlDeleteForecastResponseExample1.json b/specification/ml/delete_forecast/MlDeleteForecastResponseExample1.json
@@ -1,5 +1,8 @@
 {
   "summary": "A successful response when deleting a forecast from an anomaly detection job.",
+  "description": "",
+  "type": "response",
+  "response_code": 200,
   "value": {
     "acknowledged": true
   }
diff --git a/specification/ml/delete_job/MlDeleteJobResponseExample1.json b/specification/ml/delete_job/MlDeleteJobResponseExample1.json
@@ -1,5 +1,8 @@
 {
   "summary": "A successful response when deleting an anomaly detection job.",
+  "description": "",
+  "type": "response",
+  "response_code": 200,
   "value": {
     "acknowledged": true
   }
diff --git a/specification/ml/delete_job/MlDeleteJobResponseExample2.json b/specification/ml/delete_job/MlDeleteJobResponseExample2.json
@@ -1,6 +1,8 @@
 {
   "summary": "A successful response when deleting an anomaly detection job asynchronously.",
   "description": "When the `wait_for_completion` query parameter is set to `false`, the response contains an identifier for the job deletion task.",
+  "type": "response",
+  "response_code": 200,
   "value": {
     "task": "oTUltX4IQMOUUVeiohTt8A:39"
   }
diff --git a/specification/ml/delete_model_snapshot/MlDeleteModelSnapshotResponseExample1.json b/specification/ml/delete_model_snapshot/MlDeleteModelSnapshotResponseExample1.json
@@ -1,5 +1,8 @@
 {
   "summary": "A successful response when deleting an existing model snapshot.",
+  "description": "",
+  "type": "response",
+  "response_code": 200,
   "value": {
     "acknowledged": true
   }
diff --git a/specification/ml/delete_trained_model/MlDeleteTrainedModelResponseExample1.json b/specification/ml/delete_trained_model/MlDeleteTrainedModelResponseExample1.json
@@ -1,5 +1,8 @@
 {
   "summary": "A successful response when deleting an existing trained inference model.",
+  "description": "",
+  "type": "response",
+  "response_code": 200,
   "value": {
     "acknowledged": true
   }
diff --git a/specification/ml/delete_trained_model_alias/MlDeleteTrainedModelAliasResponseExample1.json b/specification/ml/delete_trained_model_alias/MlDeleteTrainedModelAliasResponseExample1.json
@@ -1,5 +1,8 @@
 {
   "summary": "A successful response when deleting a trained model alias.",
+  "description": "",
+  "type": "response",
+  "response_code": 200,
   "value": {
     "acknowledged": true
   }
diff --git a/specification/ml/estimate_model_memory/MlEstimateModelMemoryRequestExample1.json b/specification/ml/estimate_model_memory/MlEstimateModelMemoryRequestExample1.json
@@ -1,5 +1,8 @@
 {
   "summary": "A request of estimating model memory limit based on the analysis configuration details provided in the body.",
+  "method_request": "POST _ml/anomaly_detectors/_estimate_model_memory",
+  "description": "",
+  "type": "request",
   "value": {
     "analysis_config": {
       "bucket_span": "5m",
diff --git a/specification/ml/estimate_model_memory/MlEstimateModelMemoryResponseExample1.json b/specification/ml/estimate_model_memory/MlEstimateModelMemoryResponseExample1.json
@@ -1,5 +1,8 @@
 {
   "summary": "A successful response when estimating sufficent memory for a model.",
+  "description": "",
+  "type": "response",
+  "response_code": 200,
   "value": {
     "model_memory_estimate": "21mb"
   }
diff --git a/specification/ml/evaluate_data_frame/MlEvaluateDataFrameRequestClassificationExample1.json b/specification/ml/evaluate_data_frame/MlEvaluateDataFrameRequestClassificationExample1.json
@@ -1,6 +1,8 @@
 {
   "summary": "A request for evaluating a classification job for an annotated index.",
+  "method_request": "POST _ml/data_frame/_evaluate",
   "description": "The `actual_field` contains the ground truth for classification. The `predicted_field` contains the predicted value calculated by the classification analysis.",
+  "type": "request",
   "value": {
     "index": "animal_classification",
     "evaluation": {
diff --git a/specification/ml/evaluate_data_frame/MlEvaluateDataFrameRequestClassificationExample2.json b/specification/ml/evaluate_data_frame/MlEvaluateDataFrameRequestClassificationExample2.json
@@ -1,6 +1,8 @@
 {
   "summary": "A request for evaluating a classification job with AUC ROC metrics for an annotated index.",
+  "method_request": "POST _ml/data_frame/_evaluate",
   "description": "The `class_name` specifies the class name that is treated as positive during the evaluation, all the other classes are treated as negative.",
+  "type": "request",
   "value": {
     "index": "animal_classification",
     "evaluation": {
diff --git a/specification/ml/evaluate_data_frame/MlEvaluateDataFrameRequestOutlierExample.json b/specification/ml/evaluate_data_frame/MlEvaluateDataFrameRequestOutlierExample.json
@@ -1,5 +1,8 @@
 {
   "summary": "A request for evaluating an outlier detection job for an annotated index.",
+  "method_request": "POST _ml/data_frame/_evaluate",
+  "description": "",
+  "type": "request",
   "value": {
     "index": "my_analytics_dest_index",
     "evaluation": {
diff --git a/specification/ml/evaluate_data_frame/MlEvaluateDataFrameRequestRegressionExample1.json b/specification/ml/evaluate_data_frame/MlEvaluateDataFrameRequestRegressionExample1.json
@@ -1,6 +1,8 @@
 {
   "summary": "A request for evaluating the testing error of a regression job for an annotated index.",
+  "method_request": "POST _ml/data_frame/_evaluate",
   "description": "The term query in the body limits evaluation to be performed on the test split only. The `actual_field` contains the ground truth for house prices. The `predicted_field` contains the house price calculated by the regression analysis.",
+  "type": "request",
   "value": {
     "index": "house_price_predictions",
     "query": {
diff --git a/specification/ml/evaluate_data_frame/MlEvaluateDataFrameRequestRegressionExample2.json b/specification/ml/evaluate_data_frame/MlEvaluateDataFrameRequestRegressionExample2.json
@@ -1,6 +1,8 @@
 {
   "summary": "A request for evaluating the training error of a regression job for an annotated index.",
+  "method_request": "POST _ml/data_frame/_evaluate",
   "description": "The term query in the body limits evaluation to be performed on the training split only. The `actual_field` contains the ground truth for house prices. The `predicted_field` contains the house price calculated by the regression analysis.",
+  "type": "request",
   "value": {
     "index": "house_price_predictions",
     "query": {
diff --git a/specification/ml/evaluate_data_frame/MlEvaluateDataFrameResponseClassificationExample1.json b/specification/ml/evaluate_data_frame/MlEvaluateDataFrameResponseClassificationExample1.json
@@ -1,6 +1,8 @@
 {
   "summary": "A succesful response for evaluating a classification analysis job for an annotated index.",
   "description": "The `actual_class` contains the name of the class the analysis tried to predict. The `actual_class_doc_count` is the number of documents in the index belonging to the `actual_class`. The `predicted_classes` object contains the list of the predicted classes and the number of predictions associated with the class.",
+  "type": "response",
+  "response_code": 200,
   "value": {
     "classification": {
       "multiclass_confusion_matrix": {
diff --git a/specification/ml/evaluate_data_frame/MlEvaluateDataFrameResponseClassificationExample2.json b/specification/ml/evaluate_data_frame/MlEvaluateDataFrameResponseClassificationExample2.json
@@ -1,5 +1,8 @@
 {
   "summary": "A succesful response for evaluating a classification analysis job with the AUC ROC metrics for an annotated index.",
+  "description": "",
+  "type": "response",
+  "response_code": 200,
   "value": {
     "classification": {
       "auc_roc": {
diff --git a/specification/ml/evaluate_data_frame/MlEvaluateDataFrameResponseOutlierExample.json b/specification/ml/evaluate_data_frame/MlEvaluateDataFrameResponseOutlierExample.json
@@ -1,5 +1,8 @@
 {
   "summary": "A successful response when evaluating an outlier detection job.",
+  "description": "",
+  "type": "response",
+  "response_code": 200,
   "value": {
     "outlier_detection": {
       "auc_roc": {
diff --git a/specification/ml/explain_data_frame_analytics/MlExplainDataFrameAnalyticsRequestExample1.json b/specification/ml/explain_data_frame_analytics/MlExplainDataFrameAnalyticsRequestExample1.json
@@ -1,5 +1,8 @@
 {
   "summary": "A request for explaining a data frame analytics job configuration.",
+  "method_request": "POST _ml/data_frame/analytics/_explain",
+  "description": "",
+  "type": "request",
   "value": {
     "source": {
       "index": "houses_sold_last_10_yrs"
diff --git a/specification/ml/explain_data_frame_analytics/MlExplainDataFrameAnalyticsResponseExample1.json b/specification/ml/explain_data_frame_analytics/MlExplainDataFrameAnalyticsResponseExample1.json
@@ -1,5 +1,8 @@
 {
   "summary": "A succesful response for explaining a data frame analytics job configuration.",
+  "description": "",
+  "type": "response",
+  "response_code": 200,
   "value": {
     "field_selection": [
       {
diff --git a/specification/transform/delete_transform/DeleteTransformResponseExample1.json b/specification/transform/delete_transform/DeleteTransformResponseExample1.json
@@ -1,5 +1,8 @@
 {
   "summary": "A successful response when the transform is deleted.",
+  "description": "",
+  "type": "response",
+  "response_code": 200,
   "value": {
     "acknowledged": true
   }
diff --git a/specification/transform/get_transform/GetTransformResponseExample1.json b/specification/transform/get_transform/GetTransformResponseExample1.json
@@ -1,5 +1,8 @@
 {
   "summary": "A successful response that contains configuration information for a transform.",
+  "description": "",
+  "type": "response",
+  "response_code": 200,
   "value": {
     "count": 1,
     "transforms": [
diff --git a/specification/transform/get_transform_stats/GetTransformStatsResponseExample1.json b/specification/transform/get_transform_stats/GetTransformStatsResponseExample1.json
@@ -1,5 +1,8 @@
 {
   "summary": "A successful response that contains usage information for a transform.",
+  "description": "",
+  "type": "response",
+  "response_code": 200,
   "value": {
     "count": 1,
     "transforms": [
diff --git a/specification/transform/preview_transform/PreviewTransformRequestExample1.json b/specification/transform/preview_transform/PreviewTransformRequestExample1.json
@@ -1,5 +1,8 @@
 {
   "summary": "A request to preview a transform that uses the pivot method.",
+  "method_request": "POST _transform/_preview",
+  "description": "",
+  "type": "request",
   "value": {
     "source": {
       "index": "kibana_sample_data_ecommerce"
diff --git a/specification/transform/preview_transform/PreviewTransformResponseExample1.json b/specification/transform/preview_transform/PreviewTransformResponseExample1.json
@@ -1,5 +1,8 @@
 {
   "summary": "A successful response contains a preview a transform that uses the pivot method.",
+  "description": "",
+  "type": "response",
+  "response_code": 200,
   "value": {
     "preview": [
       {
diff --git a/specification/transform/put_transform/PutTransformRequestExample1.json b/specification/transform/put_transform/PutTransformRequestExample1.json
@@ -1,5 +1,8 @@
 {
   "summary": "A request to create a transform that uses the pivot method.",
+  "method_request": "PUT _transform/ecommerce_transform1",
+  "description": "",
+  "type": "request",
   "value": {
     "source": {
       "index": "kibana_sample_data_ecommerce",
diff --git a/specification/transform/put_transform/PutTransformRequestExample2.json b/specification/transform/put_transform/PutTransformRequestExample2.json
@@ -1,5 +1,8 @@
 {
   "summary": "A request to create a transform that uses the latest method.",
+  "method_request": "PUT _transform/ecommerce_transform2",
+  "description": "",
+  "type": "request",
   "value": {
     "source": {
       "index": "kibana_sample_data_ecommerce"
diff --git a/specification/transform/put_transform/PutTransformResponseExample1.json b/specification/transform/put_transform/PutTransformResponseExample1.json
@@ -1,5 +1,8 @@
 {
   "summary": "A successful response when creating a transform.",
+  "description": "",
+  "type": "response",
+  "response_code": 200,
   "value": {
     "acknowledged": true
   }
diff --git a/specification/transform/reset_transform/ResetTransformResponseExample1.json b/specification/transform/reset_transform/ResetTransformResponseExample1.json
@@ -1,5 +1,8 @@
 {
   "summary": "A successful response when the transform is reset.",
+  "description": "",
+  "type": "response",
+  "response_code": 200,
   "value": {
     "acknowledged": true
   }
diff --git a/specification/transform/schedule_now_transform/ResetTransformResponseExample1.json b/specification/transform/schedule_now_transform/ResetTransformResponseExample1.json
@@ -1,5 +1,8 @@
 {
   "summary": "A successful response when the transform is scheduled to run now.",
+  "description": "",
+  "type": "response",
+  "response_code": 200,
   "value": {
     "acknowledged": true
   }
diff --git a/specification/transform/start_transform/StartTransformResponseExample1.json b/specification/transform/start_transform/StartTransformResponseExample1.json
@@ -1,5 +1,8 @@
 {
   "summary": "A successful response when a transform starts.",
+  "description": "",
+  "type": "response",
+  "response_code": 200,
   "value": {
     "acknowledged": true
   }
diff --git a/specification/transform/stop_transform/StopTransformResponseExample1.json b/specification/transform/stop_transform/StopTransformResponseExample1.json
@@ -1,5 +1,8 @@
 {
   "summary": "A successful response when a transform stops.",
+  "description": "",
+  "type": "response",
+  "response_code": 200,
   "value": {
     "acknowledged": true
   }
diff --git a/specification/transform/update_transform/UpdateTransformRequestExample1.json b/specification/transform/update_transform/UpdateTransformRequestExample1.json
@@ -1,5 +1,8 @@
 {
   "summary": "A request to update a transform that uses the pivot method.",
+  "method_request": "POST _transform/simple-kibana-ecomm-pivot/_update",
+  "description": "",
+  "type": "request",
   "value": {
     "source": {
       "index": "kibana_sample_data_ecommerce",
diff --git a/specification/transform/update_transform/UpdateTransformResponseExample1.json b/specification/transform/update_transform/UpdateTransformResponseExample1.json
@@ -1,5 +1,8 @@
 {
   "summary": "A successful response when creating a transform.",
+  "description": "",
+  "type": "response",
+  "response_code": 200,
   "value": {
     "id": "simple-kibana-ecomm-pivot",
     "authorization": {
diff --git a/specification/transform/upgrade_transforms/UpgradeTransformResponseExample1.json b/specification/transform/upgrade_transforms/UpgradeTransformResponseExample1.json
@@ -1,5 +1,8 @@
 {
   "summary": "A successful response contains a summary when all transforms are upgraded.",
+  "description": "",
+  "type": "response",
+  "response_code": 200,
   "value": {
     "needs_update": 0,
     "updated": 2,

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,8 @@`
`1`	`1`	`{`
`2`	`2`	`"summary": "A successful response when clearing the inference cache.",`
	`3`	`+ "description": "",`
	`4`	`+ "type": "response",`
	`5`	`+ "response_code": 200,`
`3`	`6`	`"value": {`
`4`	`7`	`"cleared": true`
`5`	`8`	`}`