Correct Incident App documentation around search endpoint (#2008)

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com>

Author: api-clients-generation-pipeline[bot]

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2023-10-04 17:33:04.961391",
-            "spec_repo_commit": "adf28ce4"
+            "regenerated": "2023-10-04 20:38:56.966827",
+            "spec_repo_commit": "79ab1c3c"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2023-10-04 17:33:04.978253",
-            "spec_repo_commit": "adf28ce4"
+            "regenerated": "2023-10-04 20:38:56.985498",
+            "spec_repo_commit": "79ab1c3c"
         }
     }
 }

.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

src/main/java/com/datadog/api/client/v2/api/IncidentsApi.java

@@ -2584,12 +2584,10 @@ public SearchIncidentsOptionalParameters pageOffset(Long pageOffset) {
    *
    * <p>See {@link #searchIncidentsWithHttpInfo}.
    *
-   * @param query Specifies which incidents should be returned. After entering a search query in
-   *     your <a href="https://app.datadoghq.com/incidents">Incidents page</a>, 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 <code>ANDs</code>, along with multiple
-   *     values for each of those facets joined by <code>OR</code>s, for instance: <code>
-   *     query="state:active AND severity:(SEV-2 OR SEV-1)"</code>. (required)
+   * @param query Specifies which incidents should be returned. The query can contain any number of
+   *     incident facets joined by <code>ANDs</code>, along with multiple values for each of those
+   *     facets joined by <code>OR</code>s. For example: <code>
+   *     state:active AND severity:(SEV-2 OR SEV-1)</code>. (required)
    * @return IncidentSearchResponse
    * @throws ApiException if fails to make API call
    */
@@ -2602,12 +2600,10 @@ public IncidentSearchResponse searchIncidents(String query) throws ApiException
    *
    * <p>See {@link #searchIncidentsWithHttpInfoAsync}.
    *
-   * @param query Specifies which incidents should be returned. After entering a search query in
-   *     your <a href="https://app.datadoghq.com/incidents">Incidents page</a>, 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 <code>ANDs</code>, along with multiple
-   *     values for each of those facets joined by <code>OR</code>s, for instance: <code>
-   *     query="state:active AND severity:(SEV-2 OR SEV-1)"</code>. (required)
+   * @param query Specifies which incidents should be returned. The query can contain any number of
+   *     incident facets joined by <code>ANDs</code>, along with multiple values for each of those
+   *     facets joined by <code>OR</code>s. For example: <code>
+   *     state:active AND severity:(SEV-2 OR SEV-1)</code>. (required)
    * @return CompletableFuture&lt;IncidentSearchResponse&gt;
    */
   public CompletableFuture<IncidentSearchResponse> searchIncidentsAsync(String query) {
@@ -2623,12 +2619,10 @@ public CompletableFuture<IncidentSearchResponse> searchIncidentsAsync(String que
    *
    * <p>See {@link #searchIncidentsWithHttpInfo}.
    *
-   * @param query Specifies which incidents should be returned. After entering a search query in
-   *     your <a href="https://app.datadoghq.com/incidents">Incidents page</a>, 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 <code>ANDs</code>, along with multiple
-   *     values for each of those facets joined by <code>OR</code>s, for instance: <code>
-   *     query="state:active AND severity:(SEV-2 OR SEV-1)"</code>. (required)
+   * @param query Specifies which incidents should be returned. The query can contain any number of
+   *     incident facets joined by <code>ANDs</code>, along with multiple values for each of those
+   *     facets joined by <code>OR</code>s. For example: <code>
+   *     state:active AND severity:(SEV-2 OR SEV-1)</code>. (required)
    * @param parameters Optional parameters for the request.
    * @return IncidentSearchResponse
    * @throws ApiException if fails to make API call
@@ -2643,12 +2637,10 @@ public IncidentSearchResponse searchIncidents(
    *
    * <p>See {@link #searchIncidentsWithHttpInfoAsync}.
    *
-   * @param query Specifies which incidents should be returned. After entering a search query in
-   *     your <a href="https://app.datadoghq.com/incidents">Incidents page</a>, 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 <code>ANDs</code>, along with multiple
-   *     values for each of those facets joined by <code>OR</code>s, for instance: <code>
-   *     query="state:active AND severity:(SEV-2 OR SEV-1)"</code>. (required)
+   * @param query Specifies which incidents should be returned. The query can contain any number of
+   *     incident facets joined by <code>ANDs</code>, along with multiple values for each of those
+   *     facets joined by <code>OR</code>s. For example: <code>
+   *     state:active AND severity:(SEV-2 OR SEV-1)</code>. (required)
    * @param parameters Optional parameters for the request.
    * @return CompletableFuture&lt;IncidentSearchResponse&gt;
    */
@@ -2666,12 +2658,10 @@ public CompletableFuture<IncidentSearchResponse> searchIncidentsAsync(
    *
    * <p>See {@link #searchIncidentsWithHttpInfo}.
    *
-   * @param query Specifies which incidents should be returned. After entering a search query in
-   *     your <a href="https://app.datadoghq.com/incidents">Incidents page</a>, 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 <code>ANDs</code>, along with multiple
-   *     values for each of those facets joined by <code>OR</code>s, for instance: <code>
-   *     query="state:active AND severity:(SEV-2 OR SEV-1)"</code>. (required)
+   * @param query Specifies which incidents should be returned. The query can contain any number of
+   *     incident facets joined by <code>ANDs</code>, along with multiple values for each of those
+   *     facets joined by <code>OR</code>s. For example: <code>
+   *     state:active AND severity:(SEV-2 OR SEV-1)</code>. (required)
    * @return PaginationIterable&lt;IncidentSearchResponseIncidentsData&gt;
    */
   public PaginationIterable<IncidentSearchResponseIncidentsData> searchIncidentsWithPagination(
@@ -2685,12 +2675,10 @@ public PaginationIterable<IncidentSearchResponseIncidentsData> searchIncidentsWi
    *
    * <p>See {@link #searchIncidentsWithHttpInfo}.
    *
-   * @param query Specifies which incidents should be returned. After entering a search query in
-   *     your <a href="https://app.datadoghq.com/incidents">Incidents page</a>, 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 <code>ANDs</code>, along with multiple
-   *     values for each of those facets joined by <code>OR</code>s, for instance: <code>
-   *     query="state:active AND severity:(SEV-2 OR SEV-1)"</code>. (required)
+   * @param query Specifies which incidents should be returned. The query can contain any number of
+   *     incident facets joined by <code>ANDs</code>, along with multiple values for each of those
+   *     facets joined by <code>OR</code>s. For example: <code>
+   *     state:active AND severity:(SEV-2 OR SEV-1)</code>. (required)
    * @return IncidentSearchResponse
    */
   public PaginationIterable<IncidentSearchResponseIncidentsData> searchIncidentsWithPagination(
@@ -2730,12 +2718,10 @@ public PaginationIterable<IncidentSearchResponseIncidentsData> searchIncidentsWi
   /**
    * Search for incidents matching a certain query.
    *
-   * @param query Specifies which incidents should be returned. After entering a search query in
-   *     your <a href="https://app.datadoghq.com/incidents">Incidents page</a>, 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 <code>ANDs</code>, along with multiple
-   *     values for each of those facets joined by <code>OR</code>s, for instance: <code>
-   *     query="state:active AND severity:(SEV-2 OR SEV-1)"</code>. (required)
+   * @param query Specifies which incidents should be returned. The query can contain any number of
+   *     incident facets joined by <code>ANDs</code>, along with multiple values for each of those
+   *     facets joined by <code>OR</code>s. For example: <code>
+   *     state:active AND severity:(SEV-2 OR SEV-1)</code>. (required)
    * @param parameters Optional parameters for the request.
    * @return ApiResponse&lt;IncidentSearchResponse&gt;
    * @throws ApiException if fails to make API call
@@ -2808,12 +2794,10 @@ public ApiResponse<IncidentSearchResponse> searchIncidentsWithHttpInfo(
    *
    * <p>See {@link #searchIncidentsWithHttpInfo}.
    *
-   * @param query Specifies which incidents should be returned. After entering a search query in
-   *     your <a href="https://app.datadoghq.com/incidents">Incidents page</a>, 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 <code>ANDs</code>, along with multiple
-   *     values for each of those facets joined by <code>OR</code>s, for instance: <code>
-   *     query="state:active AND severity:(SEV-2 OR SEV-1)"</code>. (required)
+   * @param query Specifies which incidents should be returned. The query can contain any number of
+   *     incident facets joined by <code>ANDs</code>, along with multiple values for each of those
+   *     facets joined by <code>OR</code>s. For example: <code>
+   *     state:active AND severity:(SEV-2 OR SEV-1)</code>. (required)
    * @param parameters Optional parameters for the request.
    * @return CompletableFuture&lt;ApiResponse&lt;IncidentSearchResponse&gt;&gt;
    */