@openfilz-sdk/typescript-ee 1.11.0 → 1.12.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/openfilz-api-generate-typescript-sdk.sha256 +1 -1
- package/README.md +3 -2
- package/api/search-administration-api.ts +65 -0
- package/dist/api/search-administration-api.d.ts +28 -0
- package/dist/api/search-administration-api.js +62 -0
- package/dist/esm/api/search-administration-api.d.ts +28 -0
- package/dist/esm/api/search-administration-api.js +62 -0
- package/docs/SearchAdministrationApi.md +45 -0
- package/package.json +1 -1
|
@@ -1 +1 @@
|
|
|
1
|
-
|
|
1
|
+
2c24b3fdacf559e1f4b6efd5995db339719266806676cc522f739eff0921d4db
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @openfilz-sdk/typescript-ee@1.
|
|
1
|
+
## @openfilz-sdk/typescript-ee@1.12.0
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @openfilz-sdk/typescript-ee@1.
|
|
39
|
+
npm install @openfilz-sdk/typescript-ee@1.12.0 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -235,6 +235,7 @@ Class | Method | HTTP request | Description
|
|
|
235
235
|
*SearchAdministrationApi* | [**createIndex**](docs/SearchAdministrationApi.md#createindex) | **POST** /api/v1/admin/search | Create search index
|
|
236
236
|
*SearchAdministrationApi* | [**deleteIndex**](docs/SearchAdministrationApi.md#deleteindex) | **DELETE** /api/v1/admin/search | Delete search index
|
|
237
237
|
*SearchAdministrationApi* | [**getStatus**](docs/SearchAdministrationApi.md#getstatus) | **GET** /api/v1/admin/search/status | Get reindexation status
|
|
238
|
+
*SearchAdministrationApi* | [**refreshMetadata**](docs/SearchAdministrationApi.md#refreshmetadata) | **POST** /api/v1/admin/search/refresh-metadata | Refresh index metadata
|
|
238
239
|
*SearchAdministrationApi* | [**reindexAll**](docs/SearchAdministrationApi.md#reindexall) | **POST** /api/v1/admin/search/reindex | Reindex all documents
|
|
239
240
|
*SettingsApi* | [**get2**](docs/SettingsApi.md#get2) | **GET** /api/v1/settings/ai/preferences | The caller\'s smart-filing preferences
|
|
240
241
|
*SettingsApi* | [**getLicenseInfo**](docs/SettingsApi.md#getlicenseinfo) | **GET** /api/v1/settings/license | Coarse license info
|
|
@@ -128,6 +128,40 @@ export const SearchAdministrationApiAxiosParamCreator = function (configuration?
|
|
|
128
128
|
options: localVarRequestOptions,
|
|
129
129
|
};
|
|
130
130
|
},
|
|
131
|
+
/**
|
|
132
|
+
* Rewrites the metadata fields of every indexed document from the database — no text extraction, no AI, no downtime. Runs asynchronously in the background.
|
|
133
|
+
* @summary Refresh index metadata
|
|
134
|
+
* @param {*} [options] Override http request option.
|
|
135
|
+
* @throws {RequiredError}
|
|
136
|
+
*/
|
|
137
|
+
refreshMetadata: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
138
|
+
const localVarPath = `/api/v1/admin/search/refresh-metadata`;
|
|
139
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
140
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
141
|
+
let baseOptions;
|
|
142
|
+
if (configuration) {
|
|
143
|
+
baseOptions = configuration.baseOptions;
|
|
144
|
+
}
|
|
145
|
+
|
|
146
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
147
|
+
const localVarHeaderParameter = {} as any;
|
|
148
|
+
const localVarQueryParameter = {} as any;
|
|
149
|
+
|
|
150
|
+
// authentication keycloak_auth required
|
|
151
|
+
// http bearer authentication required
|
|
152
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
153
|
+
|
|
154
|
+
localVarHeaderParameter['Accept'] = '*/*';
|
|
155
|
+
|
|
156
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
157
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
158
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
159
|
+
|
|
160
|
+
return {
|
|
161
|
+
url: toPathString(localVarUrlObj),
|
|
162
|
+
options: localVarRequestOptions,
|
|
163
|
+
};
|
|
164
|
+
},
|
|
131
165
|
/**
|
|
132
166
|
* Triggers a full reindexation of all documents. Runs asynchronously in the background.
|
|
133
167
|
* @summary Reindex all documents
|
|
@@ -207,6 +241,18 @@ export const SearchAdministrationApiFp = function(configuration?: Configuration)
|
|
|
207
241
|
const localVarOperationServerBasePath = operationServerMap['SearchAdministrationApi.getStatus']?.[localVarOperationServerIndex]?.url;
|
|
208
242
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
209
243
|
},
|
|
244
|
+
/**
|
|
245
|
+
* Rewrites the metadata fields of every indexed document from the database — no text extraction, no AI, no downtime. Runs asynchronously in the background.
|
|
246
|
+
* @summary Refresh index metadata
|
|
247
|
+
* @param {*} [options] Override http request option.
|
|
248
|
+
* @throws {RequiredError}
|
|
249
|
+
*/
|
|
250
|
+
async refreshMetadata(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>> {
|
|
251
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.refreshMetadata(options);
|
|
252
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
253
|
+
const localVarOperationServerBasePath = operationServerMap['SearchAdministrationApi.refreshMetadata']?.[localVarOperationServerIndex]?.url;
|
|
254
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
255
|
+
},
|
|
210
256
|
/**
|
|
211
257
|
* Triggers a full reindexation of all documents. Runs asynchronously in the background.
|
|
212
258
|
* @summary Reindex all documents
|
|
@@ -255,6 +301,15 @@ export const SearchAdministrationApiFactory = function (configuration?: Configur
|
|
|
255
301
|
getStatus(options?: RawAxiosRequestConfig): AxiosPromise<object> {
|
|
256
302
|
return localVarFp.getStatus(options).then((request) => request(axios, basePath));
|
|
257
303
|
},
|
|
304
|
+
/**
|
|
305
|
+
* Rewrites the metadata fields of every indexed document from the database — no text extraction, no AI, no downtime. Runs asynchronously in the background.
|
|
306
|
+
* @summary Refresh index metadata
|
|
307
|
+
* @param {*} [options] Override http request option.
|
|
308
|
+
* @throws {RequiredError}
|
|
309
|
+
*/
|
|
310
|
+
refreshMetadata(options?: RawAxiosRequestConfig): AxiosPromise<object> {
|
|
311
|
+
return localVarFp.refreshMetadata(options).then((request) => request(axios, basePath));
|
|
312
|
+
},
|
|
258
313
|
/**
|
|
259
314
|
* Triggers a full reindexation of all documents. Runs asynchronously in the background.
|
|
260
315
|
* @summary Reindex all documents
|
|
@@ -301,6 +356,16 @@ export class SearchAdministrationApi extends BaseAPI {
|
|
|
301
356
|
return SearchAdministrationApiFp(this.configuration).getStatus(options).then((request) => request(this.axios, this.basePath));
|
|
302
357
|
}
|
|
303
358
|
|
|
359
|
+
/**
|
|
360
|
+
* Rewrites the metadata fields of every indexed document from the database — no text extraction, no AI, no downtime. Runs asynchronously in the background.
|
|
361
|
+
* @summary Refresh index metadata
|
|
362
|
+
* @param {*} [options] Override http request option.
|
|
363
|
+
* @throws {RequiredError}
|
|
364
|
+
*/
|
|
365
|
+
public refreshMetadata(options?: RawAxiosRequestConfig) {
|
|
366
|
+
return SearchAdministrationApiFp(this.configuration).refreshMetadata(options).then((request) => request(this.axios, this.basePath));
|
|
367
|
+
}
|
|
368
|
+
|
|
304
369
|
/**
|
|
305
370
|
* Triggers a full reindexation of all documents. Runs asynchronously in the background.
|
|
306
371
|
* @summary Reindex all documents
|
|
@@ -37,6 +37,13 @@ export declare const SearchAdministrationApiAxiosParamCreator: (configuration?:
|
|
|
37
37
|
* @throws {RequiredError}
|
|
38
38
|
*/
|
|
39
39
|
getStatus: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
40
|
+
/**
|
|
41
|
+
* Rewrites the metadata fields of every indexed document from the database — no text extraction, no AI, no downtime. Runs asynchronously in the background.
|
|
42
|
+
* @summary Refresh index metadata
|
|
43
|
+
* @param {*} [options] Override http request option.
|
|
44
|
+
* @throws {RequiredError}
|
|
45
|
+
*/
|
|
46
|
+
refreshMetadata: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
40
47
|
/**
|
|
41
48
|
* Triggers a full reindexation of all documents. Runs asynchronously in the background.
|
|
42
49
|
* @summary Reindex all documents
|
|
@@ -70,6 +77,13 @@ export declare const SearchAdministrationApiFp: (configuration?: Configuration)
|
|
|
70
77
|
* @throws {RequiredError}
|
|
71
78
|
*/
|
|
72
79
|
getStatus(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
80
|
+
/**
|
|
81
|
+
* Rewrites the metadata fields of every indexed document from the database — no text extraction, no AI, no downtime. Runs asynchronously in the background.
|
|
82
|
+
* @summary Refresh index metadata
|
|
83
|
+
* @param {*} [options] Override http request option.
|
|
84
|
+
* @throws {RequiredError}
|
|
85
|
+
*/
|
|
86
|
+
refreshMetadata(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
73
87
|
/**
|
|
74
88
|
* Triggers a full reindexation of all documents. Runs asynchronously in the background.
|
|
75
89
|
* @summary Reindex all documents
|
|
@@ -103,6 +117,13 @@ export declare const SearchAdministrationApiFactory: (configuration?: Configurat
|
|
|
103
117
|
* @throws {RequiredError}
|
|
104
118
|
*/
|
|
105
119
|
getStatus(options?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
120
|
+
/**
|
|
121
|
+
* Rewrites the metadata fields of every indexed document from the database — no text extraction, no AI, no downtime. Runs asynchronously in the background.
|
|
122
|
+
* @summary Refresh index metadata
|
|
123
|
+
* @param {*} [options] Override http request option.
|
|
124
|
+
* @throws {RequiredError}
|
|
125
|
+
*/
|
|
126
|
+
refreshMetadata(options?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
106
127
|
/**
|
|
107
128
|
* Triggers a full reindexation of all documents. Runs asynchronously in the background.
|
|
108
129
|
* @summary Reindex all documents
|
|
@@ -136,6 +157,13 @@ export declare class SearchAdministrationApi extends BaseAPI {
|
|
|
136
157
|
* @throws {RequiredError}
|
|
137
158
|
*/
|
|
138
159
|
getStatus(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}, any>>;
|
|
160
|
+
/**
|
|
161
|
+
* Rewrites the metadata fields of every indexed document from the database — no text extraction, no AI, no downtime. Runs asynchronously in the background.
|
|
162
|
+
* @summary Refresh index metadata
|
|
163
|
+
* @param {*} [options] Override http request option.
|
|
164
|
+
* @throws {RequiredError}
|
|
165
|
+
*/
|
|
166
|
+
refreshMetadata(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}, any>>;
|
|
139
167
|
/**
|
|
140
168
|
* Triggers a full reindexation of all documents. Runs asynchronously in the background.
|
|
141
169
|
* @summary Reindex all documents
|
|
@@ -121,6 +121,35 @@ const SearchAdministrationApiAxiosParamCreator = function (configuration) {
|
|
|
121
121
|
options: localVarRequestOptions,
|
|
122
122
|
};
|
|
123
123
|
}),
|
|
124
|
+
/**
|
|
125
|
+
* Rewrites the metadata fields of every indexed document from the database — no text extraction, no AI, no downtime. Runs asynchronously in the background.
|
|
126
|
+
* @summary Refresh index metadata
|
|
127
|
+
* @param {*} [options] Override http request option.
|
|
128
|
+
* @throws {RequiredError}
|
|
129
|
+
*/
|
|
130
|
+
refreshMetadata: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
|
|
131
|
+
const localVarPath = `/api/v1/admin/search/refresh-metadata`;
|
|
132
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
133
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
134
|
+
let baseOptions;
|
|
135
|
+
if (configuration) {
|
|
136
|
+
baseOptions = configuration.baseOptions;
|
|
137
|
+
}
|
|
138
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
139
|
+
const localVarHeaderParameter = {};
|
|
140
|
+
const localVarQueryParameter = {};
|
|
141
|
+
// authentication keycloak_auth required
|
|
142
|
+
// http bearer authentication required
|
|
143
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
144
|
+
localVarHeaderParameter['Accept'] = '*/*';
|
|
145
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
146
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
147
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
148
|
+
return {
|
|
149
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
150
|
+
options: localVarRequestOptions,
|
|
151
|
+
};
|
|
152
|
+
}),
|
|
124
153
|
/**
|
|
125
154
|
* Triggers a full reindexation of all documents. Runs asynchronously in the background.
|
|
126
155
|
* @summary Reindex all documents
|
|
@@ -204,6 +233,21 @@ const SearchAdministrationApiFp = function (configuration) {
|
|
|
204
233
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
205
234
|
});
|
|
206
235
|
},
|
|
236
|
+
/**
|
|
237
|
+
* Rewrites the metadata fields of every indexed document from the database — no text extraction, no AI, no downtime. Runs asynchronously in the background.
|
|
238
|
+
* @summary Refresh index metadata
|
|
239
|
+
* @param {*} [options] Override http request option.
|
|
240
|
+
* @throws {RequiredError}
|
|
241
|
+
*/
|
|
242
|
+
refreshMetadata(options) {
|
|
243
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
244
|
+
var _a, _b, _c;
|
|
245
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.refreshMetadata(options);
|
|
246
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
247
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['SearchAdministrationApi.refreshMetadata']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
248
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
249
|
+
});
|
|
250
|
+
},
|
|
207
251
|
/**
|
|
208
252
|
* Triggers a full reindexation of all documents. Runs asynchronously in the background.
|
|
209
253
|
* @summary Reindex all documents
|
|
@@ -255,6 +299,15 @@ const SearchAdministrationApiFactory = function (configuration, basePath, axios)
|
|
|
255
299
|
getStatus(options) {
|
|
256
300
|
return localVarFp.getStatus(options).then((request) => request(axios, basePath));
|
|
257
301
|
},
|
|
302
|
+
/**
|
|
303
|
+
* Rewrites the metadata fields of every indexed document from the database — no text extraction, no AI, no downtime. Runs asynchronously in the background.
|
|
304
|
+
* @summary Refresh index metadata
|
|
305
|
+
* @param {*} [options] Override http request option.
|
|
306
|
+
* @throws {RequiredError}
|
|
307
|
+
*/
|
|
308
|
+
refreshMetadata(options) {
|
|
309
|
+
return localVarFp.refreshMetadata(options).then((request) => request(axios, basePath));
|
|
310
|
+
},
|
|
258
311
|
/**
|
|
259
312
|
* Triggers a full reindexation of all documents. Runs asynchronously in the background.
|
|
260
313
|
* @summary Reindex all documents
|
|
@@ -298,6 +351,15 @@ class SearchAdministrationApi extends base_1.BaseAPI {
|
|
|
298
351
|
getStatus(options) {
|
|
299
352
|
return (0, exports.SearchAdministrationApiFp)(this.configuration).getStatus(options).then((request) => request(this.axios, this.basePath));
|
|
300
353
|
}
|
|
354
|
+
/**
|
|
355
|
+
* Rewrites the metadata fields of every indexed document from the database — no text extraction, no AI, no downtime. Runs asynchronously in the background.
|
|
356
|
+
* @summary Refresh index metadata
|
|
357
|
+
* @param {*} [options] Override http request option.
|
|
358
|
+
* @throws {RequiredError}
|
|
359
|
+
*/
|
|
360
|
+
refreshMetadata(options) {
|
|
361
|
+
return (0, exports.SearchAdministrationApiFp)(this.configuration).refreshMetadata(options).then((request) => request(this.axios, this.basePath));
|
|
362
|
+
}
|
|
301
363
|
/**
|
|
302
364
|
* Triggers a full reindexation of all documents. Runs asynchronously in the background.
|
|
303
365
|
* @summary Reindex all documents
|
|
@@ -37,6 +37,13 @@ export declare const SearchAdministrationApiAxiosParamCreator: (configuration?:
|
|
|
37
37
|
* @throws {RequiredError}
|
|
38
38
|
*/
|
|
39
39
|
getStatus: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
40
|
+
/**
|
|
41
|
+
* Rewrites the metadata fields of every indexed document from the database — no text extraction, no AI, no downtime. Runs asynchronously in the background.
|
|
42
|
+
* @summary Refresh index metadata
|
|
43
|
+
* @param {*} [options] Override http request option.
|
|
44
|
+
* @throws {RequiredError}
|
|
45
|
+
*/
|
|
46
|
+
refreshMetadata: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
40
47
|
/**
|
|
41
48
|
* Triggers a full reindexation of all documents. Runs asynchronously in the background.
|
|
42
49
|
* @summary Reindex all documents
|
|
@@ -70,6 +77,13 @@ export declare const SearchAdministrationApiFp: (configuration?: Configuration)
|
|
|
70
77
|
* @throws {RequiredError}
|
|
71
78
|
*/
|
|
72
79
|
getStatus(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
80
|
+
/**
|
|
81
|
+
* Rewrites the metadata fields of every indexed document from the database — no text extraction, no AI, no downtime. Runs asynchronously in the background.
|
|
82
|
+
* @summary Refresh index metadata
|
|
83
|
+
* @param {*} [options] Override http request option.
|
|
84
|
+
* @throws {RequiredError}
|
|
85
|
+
*/
|
|
86
|
+
refreshMetadata(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
73
87
|
/**
|
|
74
88
|
* Triggers a full reindexation of all documents. Runs asynchronously in the background.
|
|
75
89
|
* @summary Reindex all documents
|
|
@@ -103,6 +117,13 @@ export declare const SearchAdministrationApiFactory: (configuration?: Configurat
|
|
|
103
117
|
* @throws {RequiredError}
|
|
104
118
|
*/
|
|
105
119
|
getStatus(options?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
120
|
+
/**
|
|
121
|
+
* Rewrites the metadata fields of every indexed document from the database — no text extraction, no AI, no downtime. Runs asynchronously in the background.
|
|
122
|
+
* @summary Refresh index metadata
|
|
123
|
+
* @param {*} [options] Override http request option.
|
|
124
|
+
* @throws {RequiredError}
|
|
125
|
+
*/
|
|
126
|
+
refreshMetadata(options?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
106
127
|
/**
|
|
107
128
|
* Triggers a full reindexation of all documents. Runs asynchronously in the background.
|
|
108
129
|
* @summary Reindex all documents
|
|
@@ -136,6 +157,13 @@ export declare class SearchAdministrationApi extends BaseAPI {
|
|
|
136
157
|
* @throws {RequiredError}
|
|
137
158
|
*/
|
|
138
159
|
getStatus(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}, any>>;
|
|
160
|
+
/**
|
|
161
|
+
* Rewrites the metadata fields of every indexed document from the database — no text extraction, no AI, no downtime. Runs asynchronously in the background.
|
|
162
|
+
* @summary Refresh index metadata
|
|
163
|
+
* @param {*} [options] Override http request option.
|
|
164
|
+
* @throws {RequiredError}
|
|
165
|
+
*/
|
|
166
|
+
refreshMetadata(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}, any>>;
|
|
139
167
|
/**
|
|
140
168
|
* Triggers a full reindexation of all documents. Runs asynchronously in the background.
|
|
141
169
|
* @summary Reindex all documents
|
|
@@ -118,6 +118,35 @@ export const SearchAdministrationApiAxiosParamCreator = function (configuration)
|
|
|
118
118
|
options: localVarRequestOptions,
|
|
119
119
|
};
|
|
120
120
|
}),
|
|
121
|
+
/**
|
|
122
|
+
* Rewrites the metadata fields of every indexed document from the database — no text extraction, no AI, no downtime. Runs asynchronously in the background.
|
|
123
|
+
* @summary Refresh index metadata
|
|
124
|
+
* @param {*} [options] Override http request option.
|
|
125
|
+
* @throws {RequiredError}
|
|
126
|
+
*/
|
|
127
|
+
refreshMetadata: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
|
|
128
|
+
const localVarPath = `/api/v1/admin/search/refresh-metadata`;
|
|
129
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
130
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
131
|
+
let baseOptions;
|
|
132
|
+
if (configuration) {
|
|
133
|
+
baseOptions = configuration.baseOptions;
|
|
134
|
+
}
|
|
135
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
136
|
+
const localVarHeaderParameter = {};
|
|
137
|
+
const localVarQueryParameter = {};
|
|
138
|
+
// authentication keycloak_auth required
|
|
139
|
+
// http bearer authentication required
|
|
140
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
141
|
+
localVarHeaderParameter['Accept'] = '*/*';
|
|
142
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
143
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
144
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
145
|
+
return {
|
|
146
|
+
url: toPathString(localVarUrlObj),
|
|
147
|
+
options: localVarRequestOptions,
|
|
148
|
+
};
|
|
149
|
+
}),
|
|
121
150
|
/**
|
|
122
151
|
* Triggers a full reindexation of all documents. Runs asynchronously in the background.
|
|
123
152
|
* @summary Reindex all documents
|
|
@@ -200,6 +229,21 @@ export const SearchAdministrationApiFp = function (configuration) {
|
|
|
200
229
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
201
230
|
});
|
|
202
231
|
},
|
|
232
|
+
/**
|
|
233
|
+
* Rewrites the metadata fields of every indexed document from the database — no text extraction, no AI, no downtime. Runs asynchronously in the background.
|
|
234
|
+
* @summary Refresh index metadata
|
|
235
|
+
* @param {*} [options] Override http request option.
|
|
236
|
+
* @throws {RequiredError}
|
|
237
|
+
*/
|
|
238
|
+
refreshMetadata(options) {
|
|
239
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
240
|
+
var _a, _b, _c;
|
|
241
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.refreshMetadata(options);
|
|
242
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
243
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['SearchAdministrationApi.refreshMetadata']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
244
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
245
|
+
});
|
|
246
|
+
},
|
|
203
247
|
/**
|
|
204
248
|
* Triggers a full reindexation of all documents. Runs asynchronously in the background.
|
|
205
249
|
* @summary Reindex all documents
|
|
@@ -250,6 +294,15 @@ export const SearchAdministrationApiFactory = function (configuration, basePath,
|
|
|
250
294
|
getStatus(options) {
|
|
251
295
|
return localVarFp.getStatus(options).then((request) => request(axios, basePath));
|
|
252
296
|
},
|
|
297
|
+
/**
|
|
298
|
+
* Rewrites the metadata fields of every indexed document from the database — no text extraction, no AI, no downtime. Runs asynchronously in the background.
|
|
299
|
+
* @summary Refresh index metadata
|
|
300
|
+
* @param {*} [options] Override http request option.
|
|
301
|
+
* @throws {RequiredError}
|
|
302
|
+
*/
|
|
303
|
+
refreshMetadata(options) {
|
|
304
|
+
return localVarFp.refreshMetadata(options).then((request) => request(axios, basePath));
|
|
305
|
+
},
|
|
253
306
|
/**
|
|
254
307
|
* Triggers a full reindexation of all documents. Runs asynchronously in the background.
|
|
255
308
|
* @summary Reindex all documents
|
|
@@ -292,6 +345,15 @@ export class SearchAdministrationApi extends BaseAPI {
|
|
|
292
345
|
getStatus(options) {
|
|
293
346
|
return SearchAdministrationApiFp(this.configuration).getStatus(options).then((request) => request(this.axios, this.basePath));
|
|
294
347
|
}
|
|
348
|
+
/**
|
|
349
|
+
* Rewrites the metadata fields of every indexed document from the database — no text extraction, no AI, no downtime. Runs asynchronously in the background.
|
|
350
|
+
* @summary Refresh index metadata
|
|
351
|
+
* @param {*} [options] Override http request option.
|
|
352
|
+
* @throws {RequiredError}
|
|
353
|
+
*/
|
|
354
|
+
refreshMetadata(options) {
|
|
355
|
+
return SearchAdministrationApiFp(this.configuration).refreshMetadata(options).then((request) => request(this.axios, this.basePath));
|
|
356
|
+
}
|
|
295
357
|
/**
|
|
296
358
|
* Triggers a full reindexation of all documents. Runs asynchronously in the background.
|
|
297
359
|
* @summary Reindex all documents
|
|
@@ -7,6 +7,7 @@ All URIs are relative to *http://localhost:8081*
|
|
|
7
7
|
|[**createIndex**](#createindex) | **POST** /api/v1/admin/search | Create search index|
|
|
8
8
|
|[**deleteIndex**](#deleteindex) | **DELETE** /api/v1/admin/search | Delete search index|
|
|
9
9
|
|[**getStatus**](#getstatus) | **GET** /api/v1/admin/search/status | Get reindexation status|
|
|
10
|
+
|[**refreshMetadata**](#refreshmetadata) | **POST** /api/v1/admin/search/refresh-metadata | Refresh index metadata|
|
|
10
11
|
|[**reindexAll**](#reindexall) | **POST** /api/v1/admin/search/reindex | Reindex all documents|
|
|
11
12
|
|
|
12
13
|
# **createIndex**
|
|
@@ -120,6 +121,50 @@ const { status, data } = await apiInstance.getStatus();
|
|
|
120
121
|
This endpoint does not have any parameters.
|
|
121
122
|
|
|
122
123
|
|
|
124
|
+
### Return type
|
|
125
|
+
|
|
126
|
+
**object**
|
|
127
|
+
|
|
128
|
+
### Authorization
|
|
129
|
+
|
|
130
|
+
[keycloak_auth](../README.md#keycloak_auth)
|
|
131
|
+
|
|
132
|
+
### HTTP request headers
|
|
133
|
+
|
|
134
|
+
- **Content-Type**: Not defined
|
|
135
|
+
- **Accept**: */*
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
### HTTP response details
|
|
139
|
+
| Status code | Description | Response headers |
|
|
140
|
+
|-------------|-------------|------------------|
|
|
141
|
+
|**200** | OK | - |
|
|
142
|
+
|
|
143
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
144
|
+
|
|
145
|
+
# **refreshMetadata**
|
|
146
|
+
> object refreshMetadata()
|
|
147
|
+
|
|
148
|
+
Rewrites the metadata fields of every indexed document from the database — no text extraction, no AI, no downtime. Runs asynchronously in the background.
|
|
149
|
+
|
|
150
|
+
### Example
|
|
151
|
+
|
|
152
|
+
```typescript
|
|
153
|
+
import {
|
|
154
|
+
SearchAdministrationApi,
|
|
155
|
+
Configuration
|
|
156
|
+
} from '@openfilz-sdk/typescript-ee';
|
|
157
|
+
|
|
158
|
+
const configuration = new Configuration();
|
|
159
|
+
const apiInstance = new SearchAdministrationApi(configuration);
|
|
160
|
+
|
|
161
|
+
const { status, data } = await apiInstance.refreshMetadata();
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
### Parameters
|
|
165
|
+
This endpoint does not have any parameters.
|
|
166
|
+
|
|
167
|
+
|
|
123
168
|
### Return type
|
|
124
169
|
|
|
125
170
|
**object**
|