feat: add support for httpMethod on IHubSearchOptions (#1675)

All tests ran; last commit was a comment
Esri · Oct 1, 2024 · 3506956 · 3506956
1 parent c7a0a49
commit 3506956
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/packages/common/src/search/_internal/portalSearchItems.ts b/packages/common/src/search/_internal/portalSearchItems.ts
@@ -114,6 +114,7 @@ function processSearchParams(options: IHubSearchOptions, query: IQuery) {
     "sortOrder",
     "include",
     "start",
+    "httpMethod",
     "requestOptions", // although requestOptions is not needed on ISearchOption we send it through so downstream fns have access to it
   ];
   // copy the props over

diff --git a/packages/common/src/search/types/IHubSearchOptions.ts b/packages/common/src/search/types/IHubSearchOptions.ts
@@ -3,6 +3,7 @@ import { IHubRequestOptions } from "../../types";
 import { EntityType } from "./IHubCatalog";
 
 import { NamedApis, IApiDefinition, ISortOption } from "./types";
+import { HTTPMethods } from "@esri/arcgis-rest-request";
 
 // @private
 // TODO Deprecate in favor of Includable
@@ -93,4 +94,10 @@ export interface IHubSearchOptions extends IPagingOptions, ISortOptions {
    * LEGACY. Use `start` and `num` instead
    */
   page?: string;
+  /**
+   * Allow override of the default http method. Allows for
+   * POST requests to be made if the query is very large
+   * NOTE: The OGC API will ignore this property
+   */
+  httpMethod?: HTTPMethods;
 }