@globus/sdk 6.1.0 → 6.2.0-canary.12.8b74849

package/dist/esm/open-api/types/search.d.ts

@@ -22,6 +22,7 @@ export interface paths {
                     /** @description Set to true to allow this operation to return data with visibility which does not include the current user. Only allowed for index admins and owners. */
                     bypass_visible_to?: boolean;
                     filter_principal_sets?: string[];
+                    fields?: ("visible_to" | "principal_sets" | "content")[];
                     offset?: number;
                 };
                 header?: never;
@@ -32,15 +33,15 @@ export interface paths {
             };
             requestBody?: never;
             responses: {
-                /** @description
-                 *     A Search Result document.
+                /**
+                 * @description A Search Result document.
                  *
                  *     The offset, count, total, and has_next_page fields are computed based on the
                  *     number of results which were matched and which results were returned by the
                  *     search.
                  *     As long as `has_next_page` is True, you can add the count of results to the offset
                  *     of a prior query to fetch another page of results.
-                 *      */
+                 */
                 200: {
                     headers: {
                         [name: string]: unknown;
@@ -75,15 +76,15 @@ export interface paths {
                 };
             };
             responses: {
-                /** @description
-                 *     A Search Result document.
+                /**
+                 * @description A Search Result document.
                  *
                  *     The offset, count, total, and has_next_page fields are computed based on the
                  *     number of results which were matched and which results were returned by the
                  *     search.
                  *     As long as `has_next_page` is True, you can add the count of results to the offset
                  *     of a prior query to fetch another page of results.
-                 *      */
+                 */
                 200: {
                     headers: {
                         [name: string]: unknown;
@@ -131,15 +132,15 @@ export interface paths {
                 };
             };
             responses: {
-                /** @description
-                 *     A Scroll Result document.
+                /**
+                 * @description A Scroll Result document.
                  *
                  *     This is nearly identical to a Search Result, but includes the `marker` parameter.
                  *     `marker` is an opaque token which can be used on subsequent requests for pagination.
                  *
                  *     NOTE: In rare cases, `has_next_page` may be True until an empty page of results is
                  *     reached.
-                 *      */
+                 */
                 200: {
                     headers: {
                         [name: string]: unknown;
@@ -495,7 +496,38 @@ export interface paths {
         };
         options?: never;
         head?: never;
-        patch?: never;
+        /**
+         * Index Update Metadata
+         * @description Update an index's display_name and description. Only index owners and admins
+         *     can update an index's metadata. Only indexes with the open status can be updated.
+         *
+         *     Returns the updated index metadata in the response.
+         */
+        patch: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    index_id: string;
+                };
+                cookie?: never;
+            };
+            requestBody?: {
+                content: {
+                    "application/json": components["schemas"]["IndexUpdate"];
+                };
+            };
+            responses: {
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["IndexInfo"];
+                    };
+                };
+            };
+        };
         trace?: never;
     };
     "/v1/index_list": {
@@ -1074,6 +1106,8 @@ export interface components {
             };
             entry_id?: string;
             matched_principal_sets?: string[];
+            visible_to?: string[];
+            principal_sets?: string[];
         };
         GMetaResult: {
             /** @default 2019-08-27 */
@@ -1127,9 +1161,11 @@ export interface components {
              * @example my_field_name
              */
             field_name: string;
-            /** @description A name for this facet which is referenced in the results.
+            /**
+             * @description A name for this facet which is referenced in the results.
              *
-             *     If `name` is omitted, it will default to the value of the `field_name` property. If more than one facet in a single search request references the same field, a name *must* be provided. */
+             *     If `name` is omitted, it will default to the value of the `field_name` property. If more than one facet in a single search request references the same field, a name *must* be provided.
+             */
             name?: string;
             /**
              * @description discriminator enum property added by openapi-typescript
@@ -1148,9 +1184,11 @@ export interface components {
              * @example my_field_name
              */
             field_name: string;
-            /** @description A name for this facet which is referenced in the results.
+            /**
+             * @description A name for this facet which is referenced in the results.
              *
-             *     If `name` is omitted, it will default to the value of the `field_name` property. If more than one facet in a single search request references the same field, a name *must* be provided. */
+             *     If `name` is omitted, it will default to the value of the `field_name` property. If more than one facet in a single search request references the same field, a name *must* be provided.
+             */
             name?: string;
             /**
              * @description discriminator enum property added by openapi-typescript
@@ -1172,9 +1210,11 @@ export interface components {
              * @example my_field_name
              */
             field_name: string;
-            /** @description A name for this facet which is referenced in the results.
+            /**
+             * @description A name for this facet which is referenced in the results.
              *
-             *     If `name` is omitted, it will default to the value of the `field_name` property. If more than one facet in a single search request references the same field, a name *must* be provided. */
+             *     If `name` is omitted, it will default to the value of the `field_name` property. If more than one facet in a single search request references the same field, a name *must* be provided.
+             */
             name?: string;
             /**
              * @description discriminator enum property added by openapi-typescript
@@ -1198,9 +1238,11 @@ export interface components {
              * @example my_field_name
              */
             field_name: string;
-            /** @description A name for this facet which is referenced in the results.
+            /**
+             * @description A name for this facet which is referenced in the results.
              *
-             *     If `name` is omitted, it will default to the value of the `field_name` property. If more than one facet in a single search request references the same field, a name *must* be provided. */
+             *     If `name` is omitted, it will default to the value of the `field_name` property. If more than one facet in a single search request references the same field, a name *must* be provided.
+             */
             name?: string;
             /**
              * @description discriminator enum property added by openapi-typescript
@@ -1225,7 +1267,6 @@ export interface components {
              *     query results.
              *
              *     Defaults to True for all filters except `match_all`, where it defaults to False.
-             *
              * @default false
              */
             post_filter: boolean;
@@ -1247,7 +1288,6 @@ export interface components {
              *     query results.
              *
              *     Defaults to True for all filters except `match_all`, where it defaults to False.
-             *
              * @default true
              */
             post_filter: boolean;
@@ -1277,7 +1317,6 @@ export interface components {
              *     query results.
              *
              *     Defaults to True for all filters except `match_all`, where it defaults to False.
-             *
              * @default true
              */
             post_filter: boolean;
@@ -1303,7 +1342,6 @@ export interface components {
              *     query results.
              *
              *     Defaults to True for all filters except `match_all`, where it defaults to False.
-             *
              * @default true
              */
             post_filter: boolean;
@@ -1314,7 +1352,6 @@ export interface components {
              *     and `lon`, for latitude and longitude. The values must be floats, positive or negative,
              *     within the range of acceptable coordinate values: [-90.0, 90.0] for latitude, and
              *     [-180.0, 180.0] for longitude.
-             *
              * @example {
              *       "lat": 40.9,
              *       "lon": 87.5
@@ -1326,7 +1363,6 @@ export interface components {
              *     and `lon`, for latitude and longitude. The values must be floats, positive or negative,
              *     within the range of acceptable coordinate values: [-90.0, 90.0] for latitude, and
              *     [-180.0, 180.0] for longitude.
-             *
              * @example {
              *       "lat": 40.9,
              *       "lon": 87.5
@@ -1357,7 +1393,6 @@ export interface components {
              *     query results.
              *
              *     Defaults to True for all filters except `match_all`, where it defaults to False.
-             *
              * @default true
              */
             post_filter: boolean;
@@ -1369,7 +1404,6 @@ export interface components {
              *
              *     'intersects': (default) Return documents whose shape intersects the query shape.
              *     'within': Return documents whose shape is fully within the query shape.
-             *
              * @default intersects
              * @enum {string}
              */
@@ -1389,7 +1423,6 @@ export interface components {
              *     query results.
              *
              *     Defaults to True for all filters except `match_all`, where it defaults to False.
-             *
              * @default true
              */
             post_filter: boolean;
@@ -1410,7 +1443,6 @@ export interface components {
              *     query results.
              *
              *     Defaults to True for all filters except `match_all`, where it defaults to False.
-             *
              * @default true
              */
             post_filter: boolean;
@@ -1473,7 +1505,6 @@ export interface components {
              *     and `lon`, for latitude and longitude. The values must be floats, positive or negative,
              *     within the range of acceptable coordinate values: [-90.0, 90.0] for latitude, and
              *     [-180.0, 180.0] for longitude.
-             *
              * @example {
              *       "lat": 40.9,
              *       "lon": 87.5
@@ -1485,7 +1516,6 @@ export interface components {
              *     and `lon`, for latitude and longitude. The values must be floats, positive or negative,
              *     within the range of acceptable coordinate values: [-90.0, 90.0] for latitude, and
              *     [-180.0, 180.0] for longitude.
-             *
              * @example {
              *       "lat": 40.9,
              *       "lon": 87.5
@@ -1509,7 +1539,6 @@ export interface components {
              *
              *     'intersects': (default) Return documents whose shape intersects the query shape.
              *     'within': Return documents whose shape is fully within the query shape.
-             *
              * @default intersects
              * @enum {string}
              */
@@ -1587,7 +1616,6 @@ export interface components {
              *     query results.
              *
              *     Defaults to True for all filters except `match_all`, where it defaults to False.
-             *
              * @default true
              */
             post_filter: boolean;
@@ -1607,7 +1635,6 @@ export interface components {
              *     query results.
              *
              *     Defaults to True for all filters except `match_all`, where it defaults to False.
-             *
              * @default true
              */
             post_filter: boolean;
@@ -1627,7 +1654,6 @@ export interface components {
              *     query results.
              *
              *     Defaults to True for all filters except `match_all`, where it defaults to False.
-             *
              * @default true
              */
             post_filter: boolean;
@@ -1725,7 +1751,6 @@ export interface components {
              *     and `lon`, for latitude and longitude. The values must be floats, positive or negative,
              *     within the range of acceptable coordinate values: [-90.0, 90.0] for latitude, and
              *     [-180.0, 180.0] for longitude.
-             *
              * @example {
              *       "lat": 40.9,
              *       "lon": 87.5
@@ -1737,7 +1762,6 @@ export interface components {
              *     and `lon`, for latitude and longitude. The values must be floats, positive or negative,
              *     within the range of acceptable coordinate values: [-90.0, 90.0] for latitude, and
              *     [-180.0, 180.0] for longitude.
-             *
              * @example {
              *       "lat": 40.9,
              *       "lon": 87.5
@@ -1768,7 +1792,6 @@ export interface components {
              *
              *     'intersects': (default) Return documents whose shape intersects the query shape.
              *     'within': Return documents whose shape is fully within the query shape.
-             *
              * @default intersects
              * @enum {string}
              */
@@ -1829,9 +1852,11 @@ export interface components {
              * @example my_field_name
              */
             field_name: string;
-            /** @description A name for this facet which is referenced in the results.
+            /**
+             * @description A name for this facet which is referenced in the results.
              *
-             *     If `name` is omitted, it will default to the value of the `field_name` property. If more than one facet in a single search request references the same field, a name *must* be provided. */
+             *     If `name` is omitted, it will default to the value of the `field_name` property. If more than one facet in a single search request references the same field, a name *must* be provided.
+             */
             name?: string;
             /**
              * @description discriminator enum property added by openapi-typescript
@@ -1849,9 +1874,11 @@ export interface components {
              * @example my_field_name
              */
             field_name: string;
-            /** @description A name for this facet which is referenced in the results.
+            /**
+             * @description A name for this facet which is referenced in the results.
              *
-             *     If `name` is omitted, it will default to the value of the `field_name` property. If more than one facet in a single search request references the same field, a name *must* be provided. */
+             *     If `name` is omitted, it will default to the value of the `field_name` property. If more than one facet in a single search request references the same field, a name *must* be provided.
+             */
             name?: string;
             /**
              * @description discriminator enum property added by openapi-typescript
@@ -1868,9 +1895,11 @@ export interface components {
              * @example my_field_name
              */
             field_name: string;
-            /** @description A name for this facet which is referenced in the results.
+            /**
+             * @description A name for this facet which is referenced in the results.
              *
-             *     If `name` is omitted, it will default to the value of the `field_name` property. If more than one facet in a single search request references the same field, a name *must* be provided. */
+             *     If `name` is omitted, it will default to the value of the `field_name` property. If more than one facet in a single search request references the same field, a name *must* be provided.
+             */
             name?: string;
             /**
              * @description discriminator enum property added by openapi-typescript
@@ -1890,9 +1919,11 @@ export interface components {
              * @example my_field_name
              */
             field_name: string;
-            /** @description A name for this facet which is referenced in the results.
+            /**
+             * @description A name for this facet which is referenced in the results.
              *
-             *     If `name` is omitted, it will default to the value of the `field_name` property. If more than one facet in a single search request references the same field, a name *must* be provided. */
+             *     If `name` is omitted, it will default to the value of the `field_name` property. If more than one facet in a single search request references the same field, a name *must* be provided.
+             */
             name?: string;
             /**
              * @description discriminator enum property added by openapi-typescript
@@ -1915,9 +1946,11 @@ export interface components {
              * @example my_field_name
              */
             field_name: string;
-            /** @description A name for this facet which is referenced in the results.
+            /**
+             * @description A name for this facet which is referenced in the results.
              *
-             *     If `name` is omitted, it will default to the value of the `field_name` property. If more than one facet in a single search request references the same field, a name *must* be provided. */
+             *     If `name` is omitted, it will default to the value of the `field_name` property. If more than one facet in a single search request references the same field, a name *must* be provided.
+             */
             name?: string;
             /**
              * @description discriminator enum property added by openapi-typescript
@@ -1959,7 +1992,18 @@ export interface components {
             mode: "advanced_query_string";
             default_operator: string;
         };
-        QSettings: components["schemas"]["SimpleQSettings"] | components["schemas"]["AdvancedQSettings"];
+        TextMatchQSettings: {
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            mode: "text_match";
+            /** @default and */
+            default_operator: string;
+            /** @default 1 */
+            fuzziness: number;
+        };
+        QSettings: components["schemas"]["SimpleQSettings"] | components["schemas"]["AdvancedQSettings"] | components["schemas"]["TextMatchQSettings"];
         GSearchRequestBodyV1: {
             q?: string;
             /** @default 10 */
@@ -1976,6 +2020,12 @@ export interface components {
              * @enum {string}
              */
             "@version": "query#1.0.0";
+            /**
+             * @default [
+             *       "content"
+             *     ]
+             */
+            fields: ("visible_to" | "principal_sets" | "content")[];
             offset?: number;
             facets?: components["schemas"]["GFacetV1"][];
             filters?: components["schemas"]["GFilterV1"][];
@@ -2023,6 +2073,12 @@ export interface components {
             "@version": "scroll#1.0.0";
             filters?: components["schemas"]["GFilterV1"][];
             q_settings?: components["schemas"]["QSettings"];
+            /**
+             * @default [
+             *       "content"
+             *     ]
+             */
+            fields: ("visible_to" | "principal_sets" | "content")[];
         };
         GScrollRequest: components["schemas"]["GScrollRequest2017"] | components["schemas"]["GScrollRequestV1"];
         GScrollResponse: {
@@ -2063,7 +2119,6 @@ export interface components {
              *     backslash.
              *
              *     Currently, only geo datatypes are supported.
-             *
              * @example {
              *       "location.center": "geo_point",
              *       "location.boundary": "geo_shape"
@@ -2094,7 +2149,6 @@ export interface components {
              *     backslash.
              *
              *     Currently, only geo datatypes are supported.
-             *
              * @example {
              *       "location.center": "geo_point",
              *       "location.boundary": "geo_shape"
@@ -2162,23 +2216,17 @@ export interface components {
             available?: boolean;
             permissions?: ("owner" | "admin" | "writer")[];
         };
-        IndexDeleteResponse: {
-            /** @description Always true for successful index deletion. */
-            acknowledged?: boolean;
+        IndexUpdate: {
             /**
-             * Format: uuid
-             * @description The ID of the index which was marked for deletion.
+             * @description The name of the index
+             * @default null
              */
-            index_id?: string;
-        };
-        IndexListWPermissions: {
-            index_list?: components["schemas"]["IndexWithPermissions"][];
-        };
-        IndexCreate: {
-            /** @description The name of the index */
-            display_name: string;
-            /** @description A description of the index */
-            description: string;
+            display_name: string | null;
+            /**
+             * @description A description of the index
+             * @default null
+             */
+            description: string | null;
         };
         IndexInfo: {
             /** @default 2017-09-01 */
@@ -2205,6 +2253,24 @@ export interface components {
             /** @description The 'available' field indicates whether or not an index is available to serve queries and process tasks. It is `true` for active indices, but `false` when an index is being deleted or Globus Search is unable to access the index data. */
             available?: boolean;
         };
+        IndexDeleteResponse: {
+            /** @description Always true for successful index deletion. */
+            acknowledged?: boolean;
+            /**
+             * Format: uuid
+             * @description The ID of the index which was marked for deletion.
+             */
+            index_id?: string;
+        };
+        IndexListWPermissions: {
+            index_list?: components["schemas"]["IndexWithPermissions"][];
+        };
+        IndexCreate: {
+            /** @description The name of the index */
+            display_name: string;
+            /** @description A description of the index */
+            description: string;
+        };
         IndexReopenResponse: {
             /** @description Always true for successful index reopen. */
             acknowledged?: boolean;