From 11704e383be3e51f55e23e656620a78d8c79d988 Mon Sep 17 00:00:00 2001 From: lcawl Date: Fri, 13 Dec 2024 19:13:50 -0800 Subject: [PATCH] Generate output --- output/openapi/elasticsearch-openapi.json | 33 ++++++---- output/schema/schema.json | 78 ++++++++++++++++------- 2 files changed, 76 insertions(+), 35 deletions(-) diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 67c12225ee..e9c4b6e63d 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -25207,7 +25207,8 @@ "tags": [ "rollup" ], - "summary": "Retrieves the configuration, stats, and status of rollup jobs", + "summary": "Get rollup job information", + "description": "Get the configuration, stats, and status of rollup jobs.\n\nNOTE: This API returns only active (both `STARTED` and `STOPPED`) jobs.\nIf a job was created, ran for a while, then was deleted, the API does not return any details about it.\nFor details about a historical rollup job, the rollup capabilities API may be more useful.", "operationId": "rollup-get-jobs", "parameters": [ { @@ -25225,7 +25226,8 @@ "tags": [ "rollup" ], - "summary": "Creates a rollup job", + "summary": "Create a rollup job", + "description": "WARNING: From 8.15.0, calling this API in a cluster with no rollup usage will fail with a message about the deprecation and planned removal of rollup features. A cluster either needs to contain a rollup job or a rollup index in order for this API to be allowed to run.\n\nThe rollup job configuration contains all the details about how the job should run, when it indexes documents, and what future queries will be able to run against the rollup index.\n\nThere are three main sections to the job configuration: the logistical details about the job (for example, the cron schedule), the fields that are used for grouping, and what metrics to collect for each group.\n\nJobs are created in a `STOPPED` state. You can start them with the start rollup jobs API.", "operationId": "rollup-put-job", "parameters": [ { @@ -25308,7 +25310,8 @@ "tags": [ "rollup" ], - "summary": "Deletes an existing rollup job", + "summary": "Delete a rollup job", + "description": "A job must be stopped first before it can be deleted.\nIf you attempt to delete a started job, an error occurs.\nSimilarly, if you attempt to delete a nonexistent job, an exception occurs.\n\nIMPORTANT: When you delete a job, you remove only the process that is actively monitoring and rolling up data.\nThe API does not delete any previously rolled up data.\nThis is by design; a user may wish to roll up a static data set.\nBecause the data set is static, after it has been fully rolled up there is no need to keep the indexing rollup job around (as there will be no new data).\nThus the job can be deleted, leaving behind the rolled up data for analysis.\nIf you wish to also remove the rollup data and the rollup index contains the data for only a single job, you can delete the whole rollup index.\nIf the rollup index stores data from several jobs, you must issue a delete-by-query that targets the rollup job's identifier in the rollup index. For example:\n\n```\nPOST my_rollup_index/_delete_by_query\n{\n \"query\": {\n \"term\": {\n \"_rollup.id\": \"the_rollup_job_id\"\n }\n }\n}\n```", "operationId": "rollup-delete-job", "parameters": [ { @@ -25357,7 +25360,8 @@ "tags": [ "rollup" ], - "summary": "Retrieves the configuration, stats, and status of rollup jobs", + "summary": "Get rollup job information", + "description": "Get the configuration, stats, and status of rollup jobs.\n\nNOTE: This API returns only active (both `STARTED` and `STOPPED`) jobs.\nIf a job was created, ran for a while, then was deleted, the API does not return any details about it.\nFor details about a historical rollup job, the rollup capabilities API may be more useful.", "operationId": "rollup-get-jobs-1", "responses": { "200": { @@ -25372,7 +25376,8 @@ "tags": [ "rollup" ], - "summary": "Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern", + "summary": "Get the rollup job capabilities", + "description": "Get the capabilities of any rollup jobs that have been configured for a specific index or index pattern.\n\nThis API is useful because a rollup job is often configured to rollup only a subset of fields from the source index. \nFurthermore, only certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on that configuration.\nThis API enables you to inspect an index and determine:\n\n1. Does this index have associated rollup data somewhere in the cluster?\n2. If yes to the first question, what fields were rolled up, what aggregations can be performed, and where does the data live?", "operationId": "rollup-get-rollup-caps", "parameters": [ { @@ -25392,7 +25397,8 @@ "tags": [ "rollup" ], - "summary": "Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern", + "summary": "Get the rollup job capabilities", + "description": "Get the capabilities of any rollup jobs that have been configured for a specific index or index pattern.\n\nThis API is useful because a rollup job is often configured to rollup only a subset of fields from the source index. \nFurthermore, only certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on that configuration.\nThis API enables you to inspect an index and determine:\n\n1. Does this index have associated rollup data somewhere in the cluster?\n2. If yes to the first question, what fields were rolled up, what aggregations can be performed, and where does the data live?", "operationId": "rollup-get-rollup-caps-1", "responses": { "200": { @@ -25407,7 +25413,8 @@ "tags": [ "rollup" ], - "summary": "Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored)", + "summary": "Get the rollup index capabilities", + "description": "Get the rollup capabilities of all jobs inside of a rollup index.\nA single rollup index may store the data for multiple rollup jobs and may have a variety of capabilities depending on those jobs. This API enables you to determine:\n\n* What jobs are stored in an index (or indices specified via a pattern)?\n* What target indices were rolled up, what fields were used in those rollups, and what aggregations can be performed on each job?", "operationId": "rollup-get-rollup-index-caps", "parameters": [ { @@ -25445,7 +25452,8 @@ "tags": [ "rollup" ], - "summary": "Enables searching rolled-up data using the standard Query DSL", + "summary": "Search rolled-up data", + "description": "The rollup search endpoint is needed because, internally, rolled-up documents utilize a different document structure than the original data.\nIt rewrites standard Query DSL into a format that matches the rollup documents then takes the response and rewrites it back to what a client would expect given the original query.", "operationId": "rollup-rollup-search", "parameters": [ { @@ -25472,7 +25480,8 @@ "tags": [ "rollup" ], - "summary": "Enables searching rolled-up data using the standard Query DSL", + "summary": "Search rolled-up data", + "description": "The rollup search endpoint is needed because, internally, rolled-up documents utilize a different document structure than the original data.\nIt rewrites standard Query DSL into a format that matches the rollup documents then takes the response and rewrites it back to what a client would expect given the original query.", "operationId": "rollup-rollup-search-1", "parameters": [ { @@ -25501,7 +25510,8 @@ "tags": [ "rollup" ], - "summary": "Starts an existing, stopped rollup job", + "summary": "Start rollup jobs", + "description": "If you try to start a job that does not exist, an exception occurs.\nIf you try to start a job that is already started, nothing happens.", "operationId": "rollup-start-job", "parameters": [ { @@ -25544,7 +25554,8 @@ "tags": [ "rollup" ], - "summary": "Stops an existing, started rollup job", + "summary": "Stop rollup jobs", + "description": "If you try to stop a job that does not exist, an exception occurs.\nIf you try to stop a job that is already stopped, nothing happens.", "operationId": "rollup-stop-job", "parameters": [ { diff --git a/output/schema/schema.json b/output/schema/schema.json index 478520ccf2..2e37860aa5 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -14202,9 +14202,14 @@ "stability": "experimental" } }, - "description": "Deletes an existing rollup job.", + "description": "Delete a rollup job.\n\nA job must be stopped first before it can be deleted.\nIf you attempt to delete a started job, an error occurs.\nSimilarly, if you attempt to delete a nonexistent job, an exception occurs.\n\nIMPORTANT: When you delete a job, you remove only the process that is actively monitoring and rolling up data.\nThe API does not delete any previously rolled up data.\nThis is by design; a user may wish to roll up a static data set.\nBecause the data set is static, after it has been fully rolled up there is no need to keep the indexing rollup job around (as there will be no new data).\nThus the job can be deleted, leaving behind the rolled up data for analysis.\nIf you wish to also remove the rollup data and the rollup index contains the data for only a single job, you can delete the whole rollup index.\nIf the rollup index stores data from several jobs, you must issue a delete-by-query that targets the rollup job's identifier in the rollup index. For example:\n\n```\nPOST my_rollup_index/_delete_by_query\n{\n \"query\": {\n \"term\": {\n \"_rollup.id\": \"the_rollup_job_id\"\n }\n }\n}\n```", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-delete-job.html", "name": "rollup.delete_job", + "privileges": { + "cluster": [ + "manage_rollup" + ] + }, "request": { "name": "Request", "namespace": "rollup.delete_job" @@ -14233,9 +14238,14 @@ "stability": "experimental" } }, - "description": "Retrieves the configuration, stats, and status of rollup jobs.", + "description": "Get rollup job information.\nGet the configuration, stats, and status of rollup jobs.\n\nNOTE: This API returns only active (both `STARTED` and `STOPPED`) jobs.\nIf a job was created, ran for a while, then was deleted, the API does not return any details about it.\nFor details about a historical rollup job, the rollup capabilities API may be more useful.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-get-job.html", "name": "rollup.get_jobs", + "privileges": { + "cluster": [ + "monitor_rollup" + ] + }, "request": { "name": "Request", "namespace": "rollup.get_jobs" @@ -14270,9 +14280,14 @@ "stability": "experimental" } }, - "description": "Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern.", + "description": "Get the rollup job capabilities.\nGet the capabilities of any rollup jobs that have been configured for a specific index or index pattern.\n\nThis API is useful because a rollup job is often configured to rollup only a subset of fields from the source index. \nFurthermore, only certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on that configuration.\nThis API enables you to inspect an index and determine:\n\n1. Does this index have associated rollup data somewhere in the cluster?\n2. If yes to the first question, what fields were rolled up, what aggregations can be performed, and where does the data live?", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-get-rollup-caps.html", "name": "rollup.get_rollup_caps", + "privileges": { + "cluster": [ + "monitor_rollup" + ] + }, "request": { "name": "Request", "namespace": "rollup.get_rollup_caps" @@ -14307,9 +14322,14 @@ "stability": "experimental" } }, - "description": "Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored).", + "description": "Get the rollup index capabilities.\nGet the rollup capabilities of all jobs inside of a rollup index.\nA single rollup index may store the data for multiple rollup jobs and may have a variety of capabilities depending on those jobs. This API enables you to determine:\n\n* What jobs are stored in an index (or indices specified via a pattern)?\n* What target indices were rolled up, what fields were used in those rollups, and what aggregations can be performed on each job?", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-get-rollup-index-caps.html", "name": "rollup.get_rollup_index_caps", + "privileges": { + "index": [ + "read" + ] + }, "request": { "name": "Request", "namespace": "rollup.get_rollup_index_caps" @@ -14338,7 +14358,7 @@ "stability": "experimental" } }, - "description": "Creates a rollup job.", + "description": "Create a rollup job.\n\nWARNING: From 8.15.0, calling this API in a cluster with no rollup usage will fail with a message about the deprecation and planned removal of rollup features. A cluster either needs to contain a rollup job or a rollup index in order for this API to be allowed to run.\n\nThe rollup job configuration contains all the details about how the job should run, when it indexes documents, and what future queries will be able to run against the rollup index.\n\nThere are three main sections to the job configuration: the logistical details about the job (for example, the cron schedule), the fields that are used for grouping, and what metrics to collect for each group.\n\nJobs are created in a `STOPPED` state. You can start them with the start rollup jobs API.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-put-job.html", "name": "rollup.put_job", "privileges": { @@ -14378,7 +14398,7 @@ "stability": "experimental" } }, - "description": "Enables searching rolled-up data using the standard Query DSL.", + "description": "Search rolled-up data.\nThe rollup search endpoint is needed because, internally, rolled-up documents utilize a different document structure than the original data.\nIt rewrites standard Query DSL into a format that matches the rollup documents then takes the response and rewrites it back to what a client would expect given the original query.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-search.html", "name": "rollup.rollup_search", "request": { @@ -14413,9 +14433,14 @@ "stability": "experimental" } }, - "description": "Starts an existing, stopped rollup job.", + "description": "Start rollup jobs.\nIf you try to start a job that does not exist, an exception occurs.\nIf you try to start a job that is already started, nothing happens.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-start-job.html", "name": "rollup.start_job", + "privileges": { + "cluster": [ + "manage_rollup" + ] + }, "request": { "name": "Request", "namespace": "rollup.start_job" @@ -14444,9 +14469,14 @@ "stability": "experimental" } }, - "description": "Stops an existing, started rollup job.", + "description": "Stop rollup jobs.\nIf you try to stop a job that does not exist, an exception occurs.\nIf you try to stop a job that is already stopped, nothing happens.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-stop-job.html", "name": "rollup.stop_job", + "privileges": { + "cluster": [ + "manage_rollup" + ] + }, "request": { "name": "Request", "namespace": "rollup.stop_job" @@ -185443,7 +185473,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes an existing rollup job.", + "description": "Delete a rollup job.\n\nA job must be stopped first before it can be deleted.\nIf you attempt to delete a started job, an error occurs.\nSimilarly, if you attempt to delete a nonexistent job, an exception occurs.\n\nIMPORTANT: When you delete a job, you remove only the process that is actively monitoring and rolling up data.\nThe API does not delete any previously rolled up data.\nThis is by design; a user may wish to roll up a static data set.\nBecause the data set is static, after it has been fully rolled up there is no need to keep the indexing rollup job around (as there will be no new data).\nThus the job can be deleted, leaving behind the rolled up data for analysis.\nIf you wish to also remove the rollup data and the rollup index contains the data for only a single job, you can delete the whole rollup index.\nIf the rollup index stores data from several jobs, you must issue a delete-by-query that targets the rollup job's identifier in the rollup index. For example:\n\n```\nPOST my_rollup_index/_delete_by_query\n{\n \"query\": {\n \"term\": {\n \"_rollup.id\": \"the_rollup_job_id\"\n }\n }\n}\n```", "inherits": { "type": { "name": "RequestBase", @@ -185469,7 +185499,7 @@ } ], "query": [], - "specLocation": "rollup/delete_job/DeleteRollupJobRequest.ts#L23-L35" + "specLocation": "rollup/delete_job/DeleteRollupJobRequest.ts#L23-L59" }, { "kind": "response", @@ -185542,7 +185572,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves the configuration, stats, and status of rollup jobs.", + "description": "Get rollup job information.\nGet the configuration, stats, and status of rollup jobs.\n\nNOTE: This API returns only active (both `STARTED` and `STOPPED`) jobs.\nIf a job was created, ran for a while, then was deleted, the API does not return any details about it.\nFor details about a historical rollup job, the rollup capabilities API may be more useful.", "inherits": { "type": { "name": "RequestBase", @@ -185568,7 +185598,7 @@ } ], "query": [], - "specLocation": "rollup/get_jobs/GetRollupJobRequest.ts#L23-L36" + "specLocation": "rollup/get_jobs/GetRollupJobRequest.ts#L23-L42" }, { "kind": "response", @@ -185968,7 +185998,7 @@ "body": { "kind": "no_body" }, - "description": "Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern.", + "description": "Get the rollup job capabilities.\nGet the capabilities of any rollup jobs that have been configured for a specific index or index pattern.\n\nThis API is useful because a rollup job is often configured to rollup only a subset of fields from the source index. \nFurthermore, only certain aggregations can be configured for various fields, leading to a limited subset of functionality depending on that configuration.\nThis API enables you to inspect an index and determine:\n\n1. Does this index have associated rollup data somewhere in the cluster?\n2. If yes to the first question, what fields were rolled up, what aggregations can be performed, and where does the data live?", "inherits": { "type": { "name": "RequestBase", @@ -185994,7 +186024,7 @@ } ], "query": [], - "specLocation": "rollup/get_rollup_caps/GetRollupCapabilitiesRequest.ts#L23-L36" + "specLocation": "rollup/get_rollup_caps/GetRollupCapabilitiesRequest.ts#L23-L45" }, { "kind": "response", @@ -186192,7 +186222,7 @@ "body": { "kind": "no_body" }, - "description": "Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored).", + "description": "Get the rollup index capabilities.\nGet the rollup capabilities of all jobs inside of a rollup index.\nA single rollup index may store the data for multiple rollup jobs and may have a variety of capabilities depending on those jobs. This API enables you to determine:\n\n* What jobs are stored in an index (or indices specified via a pattern)?\n* What target indices were rolled up, what fields were used in those rollups, and what aggregations can be performed on each job?", "inherits": { "type": { "name": "RequestBase", @@ -186218,7 +186248,7 @@ } ], "query": [], - "specLocation": "rollup/get_rollup_index_caps/GetRollupIndexCapabilitiesRequest.ts#L23-L36" + "specLocation": "rollup/get_rollup_index_caps/GetRollupIndexCapabilitiesRequest.ts#L23-L42" }, { "kind": "response", @@ -186469,7 +186499,7 @@ } ] }, - "description": "Creates a rollup job.", + "description": "Create a rollup job.\n\nWARNING: From 8.15.0, calling this API in a cluster with no rollup usage will fail with a message about the deprecation and planned removal of rollup features. A cluster either needs to contain a rollup job or a rollup index in order for this API to be allowed to run.\n\nThe rollup job configuration contains all the details about how the job should run, when it indexes documents, and what future queries will be able to run against the rollup index.\n\nThere are three main sections to the job configuration: the logistical details about the job (for example, the cron schedule), the fields that are used for grouping, and what metrics to collect for each group.\n\nJobs are created in a `STOPPED` state. You can start them with the start rollup jobs API.", "inherits": { "type": { "name": "RequestBase", @@ -186495,7 +186525,7 @@ } ], "query": [], - "specLocation": "rollup/put_job/CreateRollupJobRequest.ts#L27-L89" + "specLocation": "rollup/put_job/CreateRollupJobRequest.ts#L27-L97" }, { "kind": "response", @@ -186575,7 +186605,7 @@ } ] }, - "description": "Enables searching rolled-up data using the standard Query DSL.", + "description": "Search rolled-up data.\nThe rollup search endpoint is needed because, internally, rolled-up documents utilize a different document structure than the original data.\nIt rewrites standard Query DSL into a format that matches the rollup documents then takes the response and rewrites it back to what a client would expect given the original query.", "inherits": { "type": { "name": "RequestBase", @@ -186626,7 +186656,7 @@ } } ], - "specLocation": "rollup/rollup_search/RollupSearchRequest.ts#L27-L57" + "specLocation": "rollup/rollup_search/RollupSearchRequest.ts#L27-L59" }, { "kind": "response", @@ -186741,7 +186771,7 @@ "body": { "kind": "no_body" }, - "description": "Starts an existing, stopped rollup job.", + "description": "Start rollup jobs.\nIf you try to start a job that does not exist, an exception occurs.\nIf you try to start a job that is already started, nothing happens.", "inherits": { "type": { "name": "RequestBase", @@ -186767,7 +186797,7 @@ } ], "query": [], - "specLocation": "rollup/start_job/StartRollupJobRequest.ts#L23-L35" + "specLocation": "rollup/start_job/StartRollupJobRequest.ts#L23-L38" }, { "kind": "response", @@ -186801,7 +186831,7 @@ "body": { "kind": "no_body" }, - "description": "Stops an existing, started rollup job.", + "description": "Stop rollup jobs.\nIf you try to stop a job that does not exist, an exception occurs.\nIf you try to stop a job that is already stopped, nothing happens.", "inherits": { "type": { "name": "RequestBase", @@ -186854,7 +186884,7 @@ } } ], - "specLocation": "rollup/stop_job/StopRollupJobRequest.ts#L24-L50" + "specLocation": "rollup/stop_job/StopRollupJobRequest.ts#L24-L53" }, { "kind": "response",