From f74ac02b0494284b7ff146d9ab0e6809028514ef Mon Sep 17 00:00:00 2001 From: "api-clients-generation-pipeline[bot]" <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com> Date: Thu, 5 Oct 2023 13:48:47 +0000 Subject: [PATCH] Correct Incident App documentation around search endpoint (#1699) Co-authored-by: ci.datadog-api-spec --- .apigentools-info | 8 ++++---- .generator/schemas/v2/openapi.yaml | 18 +++++------------- src/datadog_api_client/v2/api/incidents_api.py | 16 ++++++---------- 3 files changed, 15 insertions(+), 27 deletions(-) diff --git a/.apigentools-info b/.apigentools-info index d77eb235a4..5925dd0dd0 100644 --- a/.apigentools-info +++ b/.apigentools-info @@ -4,13 +4,13 @@ "spec_versions": { "v1": { "apigentools_version": "1.6.6", - "regenerated": "2023-10-04 17:33:10.073416", - "spec_repo_commit": "adf28ce4" + "regenerated": "2023-10-04 20:38:45.655558", + "spec_repo_commit": "79ab1c3c" }, "v2": { "apigentools_version": "1.6.6", - "regenerated": "2023-10-04 17:33:10.095399", - "spec_repo_commit": "adf28ce4" + "regenerated": "2023-10-04 20:38:45.670703", + "spec_repo_commit": "79ab1c3c" } } } \ No newline at end of file diff --git a/.generator/schemas/v2/openapi.yaml b/.generator/schemas/v2/openapi.yaml index 8b2fba6bae..ee82ba9f10 100644 --- a/.generator/schemas/v2/openapi.yaml +++ b/.generator/schemas/v2/openapi.yaml @@ -234,21 +234,13 @@ components: schema: $ref: '#/components/schemas/IncidentRelatedObject' IncidentSearchQueryQueryParameter: - description: 'Specifies which incidents should be returned. After entering a - search query in your [Incidents page][1], + description: 'Specifies which incidents should be returned. The query can contain + any number of incident facets - use the query parameter value in the URL of the page as the value for this - parameter. + joined by `ANDs`, along with multiple values for each of those facets joined + by `OR`s. For - - The query can contain any number of incident facets joined by `ANDs`, along - with multiple values for each of - - those facets joined by `OR`s, for instance: `query="state:active AND severity:(SEV-2 - OR SEV-1)"`. - - - [1]: https://app.datadoghq.com/incidents' + example: `state:active AND severity:(SEV-2 OR SEV-1)`.' explode: false in: query name: query diff --git a/src/datadog_api_client/v2/api/incidents_api.py b/src/datadog_api_client/v2/api/incidents_api.py index d107675349..d5a25a55d2 100644 --- a/src/datadog_api_client/v2/api/incidents_api.py +++ b/src/datadog_api_client/v2/api/incidents_api.py @@ -920,11 +920,9 @@ def search_incidents( Search for incidents matching a certain query. - :param query: Specifies which incidents should be returned. After entering a search query in your `Incidents page `_ , - use the query parameter value in the URL of the page as the value for this parameter. - - The query can contain any number of incident facets joined by ``ANDs`` , along with multiple values for each of - those facets joined by ``OR`` s, for instance: ``query="state:active AND severity:(SEV-2 OR SEV-1)"``. + :param query: Specifies which incidents should be returned. The query can contain any number of incident facets + joined by ``ANDs`` , along with multiple values for each of those facets joined by ``OR`` s. For + example: ``state:active AND severity:(SEV-2 OR SEV-1)``. :type query: str :param include: Specifies which types of related objects should be included in the response. :type include: IncidentRelatedObject, optional @@ -966,11 +964,9 @@ def search_incidents_with_pagination( Provide a paginated version of :meth:`search_incidents`, returning all items. - :param query: Specifies which incidents should be returned. After entering a search query in your `Incidents page `_ , - use the query parameter value in the URL of the page as the value for this parameter. - - The query can contain any number of incident facets joined by ``ANDs`` , along with multiple values for each of - those facets joined by ``OR`` s, for instance: ``query="state:active AND severity:(SEV-2 OR SEV-1)"``. + :param query: Specifies which incidents should be returned. The query can contain any number of incident facets + joined by ``ANDs`` , along with multiple values for each of those facets joined by ``OR`` s. For + example: ``state:active AND severity:(SEV-2 OR SEV-1)``. :type query: str :param include: Specifies which types of related objects should be included in the response. :type include: IncidentRelatedObject, optional