Correct Incident App documentation around search endpoint (#1699)

Co-authored-by: ci.datadog-api-spec <[email protected]>
DataDog · Oct 5, 2023 · f74ac02 · f74ac02
1 parent 75a4192
commit f74ac02
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 27 deletions.
diff --git 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"
         }
     }
 }
diff --git 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
@@ -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 <https://app.datadoghq.com/incidents>`_ ,
-            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 <https://app.datadoghq.com/incidents>`_ ,
-            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