system-initiative-api-client 1.2.0 → 1.3.1
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/dist/cjs/api.d.ts +180 -0
- package/dist/cjs/api.js +114 -1
- package/dist/esm/api.d.ts +180 -0
- package/dist/esm/api.js +109 -0
- package/package.json +1 -1
package/dist/cjs/api.d.ts
CHANGED
|
@@ -356,6 +356,44 @@ export interface ComponentReferenceOneOf1 {
|
|
|
356
356
|
*/
|
|
357
357
|
'componentId': string;
|
|
358
358
|
}
|
|
359
|
+
/**
|
|
360
|
+
* Component data in search results.
|
|
361
|
+
* @export
|
|
362
|
+
* @interface ComponentSearchResult
|
|
363
|
+
*/
|
|
364
|
+
export interface ComponentSearchResult {
|
|
365
|
+
/**
|
|
366
|
+
*
|
|
367
|
+
* @type {string}
|
|
368
|
+
* @memberof ComponentSearchResult
|
|
369
|
+
*/
|
|
370
|
+
'id': string;
|
|
371
|
+
/**
|
|
372
|
+
*
|
|
373
|
+
* @type {string}
|
|
374
|
+
* @memberof ComponentSearchResult
|
|
375
|
+
*/
|
|
376
|
+
'name': string;
|
|
377
|
+
/**
|
|
378
|
+
*
|
|
379
|
+
* @type {ComponentSearchResultSchema}
|
|
380
|
+
* @memberof ComponentSearchResult
|
|
381
|
+
*/
|
|
382
|
+
'schema': ComponentSearchResultSchema;
|
|
383
|
+
}
|
|
384
|
+
/**
|
|
385
|
+
* The schema for a component in search results.
|
|
386
|
+
* @export
|
|
387
|
+
* @interface ComponentSearchResultSchema
|
|
388
|
+
*/
|
|
389
|
+
export interface ComponentSearchResultSchema {
|
|
390
|
+
/**
|
|
391
|
+
*
|
|
392
|
+
* @type {string}
|
|
393
|
+
* @memberof ComponentSearchResultSchema
|
|
394
|
+
*/
|
|
395
|
+
'name': string;
|
|
396
|
+
}
|
|
359
397
|
/**
|
|
360
398
|
*
|
|
361
399
|
* @export
|
|
@@ -1659,6 +1697,12 @@ export interface GetSchemaVariantV1Response {
|
|
|
1659
1697
|
* @memberof GetSchemaVariantV1Response
|
|
1660
1698
|
*/
|
|
1661
1699
|
'domainProps'?: PropSchemaV1 | null;
|
|
1700
|
+
/**
|
|
1701
|
+
*
|
|
1702
|
+
* @type {boolean}
|
|
1703
|
+
* @memberof GetSchemaVariantV1Response
|
|
1704
|
+
*/
|
|
1705
|
+
'installedFromUpstream': boolean;
|
|
1662
1706
|
/**
|
|
1663
1707
|
*
|
|
1664
1708
|
* @type {boolean}
|
|
@@ -2290,6 +2334,12 @@ export interface SchemaVariantV1RequestPath {
|
|
|
2290
2334
|
* @interface SearchComponentsV1Request
|
|
2291
2335
|
*/
|
|
2292
2336
|
export interface SearchComponentsV1Request {
|
|
2337
|
+
/**
|
|
2338
|
+
*
|
|
2339
|
+
* @type {string}
|
|
2340
|
+
* @memberof SearchComponentsV1Request
|
|
2341
|
+
*/
|
|
2342
|
+
'queryString'?: string | null;
|
|
2293
2343
|
/**
|
|
2294
2344
|
*
|
|
2295
2345
|
* @type {string}
|
|
@@ -2348,6 +2398,32 @@ export interface SearchSchemasV1Response {
|
|
|
2348
2398
|
*/
|
|
2349
2399
|
'schemas': Array<SchemaResponse>;
|
|
2350
2400
|
}
|
|
2401
|
+
/**
|
|
2402
|
+
*
|
|
2403
|
+
* @export
|
|
2404
|
+
* @interface SearchV1Request
|
|
2405
|
+
*/
|
|
2406
|
+
export interface SearchV1Request {
|
|
2407
|
+
/**
|
|
2408
|
+
*
|
|
2409
|
+
* @type {string}
|
|
2410
|
+
* @memberof SearchV1Request
|
|
2411
|
+
*/
|
|
2412
|
+
'q': string;
|
|
2413
|
+
}
|
|
2414
|
+
/**
|
|
2415
|
+
*
|
|
2416
|
+
* @export
|
|
2417
|
+
* @interface SearchV1Response
|
|
2418
|
+
*/
|
|
2419
|
+
export interface SearchV1Response {
|
|
2420
|
+
/**
|
|
2421
|
+
*
|
|
2422
|
+
* @type {Array<ComponentSearchResult>}
|
|
2423
|
+
* @memberof SearchV1Response
|
|
2424
|
+
*/
|
|
2425
|
+
'components': Array<ComponentSearchResult>;
|
|
2426
|
+
}
|
|
2351
2427
|
/**
|
|
2352
2428
|
*
|
|
2353
2429
|
* @export
|
|
@@ -6271,6 +6347,110 @@ export declare class SchemasApi extends BaseAPI implements SchemasApiInterface {
|
|
|
6271
6347
|
*/
|
|
6272
6348
|
updateSchemaVariant(requestParameters: SchemasApiUpdateSchemaVariantRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSchemaVariantV1Response, any, {}>>;
|
|
6273
6349
|
}
|
|
6350
|
+
/**
|
|
6351
|
+
* SearchApi - axios parameter creator
|
|
6352
|
+
* @export
|
|
6353
|
+
*/
|
|
6354
|
+
export declare const SearchApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
6355
|
+
/**
|
|
6356
|
+
*
|
|
6357
|
+
* @summary Complex search for components
|
|
6358
|
+
* @param {string} workspaceId Workspace identifier
|
|
6359
|
+
* @param {string} changeSetId Change Set identifier
|
|
6360
|
+
* @param {string} q Query string. See https://docs.systeminit.com/explanation/search-syntax for details.
|
|
6361
|
+
* @param {*} [options] Override http request option.
|
|
6362
|
+
* @throws {RequiredError}
|
|
6363
|
+
*/
|
|
6364
|
+
search: (workspaceId: string, changeSetId: string, q: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6365
|
+
};
|
|
6366
|
+
/**
|
|
6367
|
+
* SearchApi - functional programming interface
|
|
6368
|
+
* @export
|
|
6369
|
+
*/
|
|
6370
|
+
export declare const SearchApiFp: (configuration?: Configuration) => {
|
|
6371
|
+
/**
|
|
6372
|
+
*
|
|
6373
|
+
* @summary Complex search for components
|
|
6374
|
+
* @param {string} workspaceId Workspace identifier
|
|
6375
|
+
* @param {string} changeSetId Change Set identifier
|
|
6376
|
+
* @param {string} q Query string. See https://docs.systeminit.com/explanation/search-syntax for details.
|
|
6377
|
+
* @param {*} [options] Override http request option.
|
|
6378
|
+
* @throws {RequiredError}
|
|
6379
|
+
*/
|
|
6380
|
+
search(workspaceId: string, changeSetId: string, q: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchV1Response>>;
|
|
6381
|
+
};
|
|
6382
|
+
/**
|
|
6383
|
+
* SearchApi - factory interface
|
|
6384
|
+
* @export
|
|
6385
|
+
*/
|
|
6386
|
+
export declare const SearchApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
6387
|
+
/**
|
|
6388
|
+
*
|
|
6389
|
+
* @summary Complex search for components
|
|
6390
|
+
* @param {SearchApiSearchRequest} requestParameters Request parameters.
|
|
6391
|
+
* @param {*} [options] Override http request option.
|
|
6392
|
+
* @throws {RequiredError}
|
|
6393
|
+
*/
|
|
6394
|
+
search(requestParameters: SearchApiSearchRequest, options?: RawAxiosRequestConfig): AxiosPromise<SearchV1Response>;
|
|
6395
|
+
};
|
|
6396
|
+
/**
|
|
6397
|
+
* SearchApi - interface
|
|
6398
|
+
* @export
|
|
6399
|
+
* @interface SearchApi
|
|
6400
|
+
*/
|
|
6401
|
+
export interface SearchApiInterface {
|
|
6402
|
+
/**
|
|
6403
|
+
*
|
|
6404
|
+
* @summary Complex search for components
|
|
6405
|
+
* @param {SearchApiSearchRequest} requestParameters Request parameters.
|
|
6406
|
+
* @param {*} [options] Override http request option.
|
|
6407
|
+
* @throws {RequiredError}
|
|
6408
|
+
* @memberof SearchApiInterface
|
|
6409
|
+
*/
|
|
6410
|
+
search(requestParameters: SearchApiSearchRequest, options?: RawAxiosRequestConfig): AxiosPromise<SearchV1Response>;
|
|
6411
|
+
}
|
|
6412
|
+
/**
|
|
6413
|
+
* Request parameters for search operation in SearchApi.
|
|
6414
|
+
* @export
|
|
6415
|
+
* @interface SearchApiSearchRequest
|
|
6416
|
+
*/
|
|
6417
|
+
export interface SearchApiSearchRequest {
|
|
6418
|
+
/**
|
|
6419
|
+
* Workspace identifier
|
|
6420
|
+
* @type {string}
|
|
6421
|
+
* @memberof SearchApiSearch
|
|
6422
|
+
*/
|
|
6423
|
+
readonly workspaceId: string;
|
|
6424
|
+
/**
|
|
6425
|
+
* Change Set identifier
|
|
6426
|
+
* @type {string}
|
|
6427
|
+
* @memberof SearchApiSearch
|
|
6428
|
+
*/
|
|
6429
|
+
readonly changeSetId: string;
|
|
6430
|
+
/**
|
|
6431
|
+
* Query string. See https://docs.systeminit.com/explanation/search-syntax for details.
|
|
6432
|
+
* @type {string}
|
|
6433
|
+
* @memberof SearchApiSearch
|
|
6434
|
+
*/
|
|
6435
|
+
readonly q: string;
|
|
6436
|
+
}
|
|
6437
|
+
/**
|
|
6438
|
+
* SearchApi - object-oriented interface
|
|
6439
|
+
* @export
|
|
6440
|
+
* @class SearchApi
|
|
6441
|
+
* @extends {BaseAPI}
|
|
6442
|
+
*/
|
|
6443
|
+
export declare class SearchApi extends BaseAPI implements SearchApiInterface {
|
|
6444
|
+
/**
|
|
6445
|
+
*
|
|
6446
|
+
* @summary Complex search for components
|
|
6447
|
+
* @param {SearchApiSearchRequest} requestParameters Request parameters.
|
|
6448
|
+
* @param {*} [options] Override http request option.
|
|
6449
|
+
* @throws {RequiredError}
|
|
6450
|
+
* @memberof SearchApi
|
|
6451
|
+
*/
|
|
6452
|
+
search(requestParameters: SearchApiSearchRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SearchV1Response, any, {}>>;
|
|
6453
|
+
}
|
|
6274
6454
|
/**
|
|
6275
6455
|
* SecretsApi - axios parameter creator
|
|
6276
6456
|
* @export
|
package/dist/cjs/api.js
CHANGED
|
@@ -16,7 +16,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
16
16
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
17
17
|
};
|
|
18
18
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
19
|
-
exports.WhoamiApi = exports.WhoamiApiFactory = exports.WhoamiApiFp = exports.WhoamiApiAxiosParamCreator = exports.SecretsApi = exports.SecretsApiFactory = exports.SecretsApiFp = exports.SecretsApiAxiosParamCreator = exports.SchemasApi = exports.SchemasApiFactory = exports.SchemasApiFp = exports.SchemasApiAxiosParamCreator = exports.RootApi = exports.RootApiFactory = exports.RootApiFp = exports.RootApiAxiosParamCreator = exports.ManagementFuncsApi = exports.ManagementFuncsApiFactory = exports.ManagementFuncsApiFp = exports.ManagementFuncsApiAxiosParamCreator = exports.FuncsApi = exports.FuncsApiFactory = exports.FuncsApiFp = exports.FuncsApiAxiosParamCreator = exports.ComponentsApi = exports.ComponentsApiFactory = exports.ComponentsApiFp = exports.ComponentsApiAxiosParamCreator = exports.ChangeSetsApi = exports.ChangeSetsApiFactory = exports.ChangeSetsApiFp = exports.ChangeSetsApiAxiosParamCreator = exports.ActionsApi = exports.ActionsApiFactory = exports.ActionsApiFp = exports.ActionsApiAxiosParamCreator = exports.SchemaVariantFuncKindOneOf2KindEnum = exports.SchemaVariantFuncKindOneOf1KindEnum = exports.SchemaVariantFuncKindOneOfKindEnum = void 0;
|
|
19
|
+
exports.WhoamiApi = exports.WhoamiApiFactory = exports.WhoamiApiFp = exports.WhoamiApiAxiosParamCreator = exports.SecretsApi = exports.SecretsApiFactory = exports.SecretsApiFp = exports.SecretsApiAxiosParamCreator = exports.SearchApi = exports.SearchApiFactory = exports.SearchApiFp = exports.SearchApiAxiosParamCreator = exports.SchemasApi = exports.SchemasApiFactory = exports.SchemasApiFp = exports.SchemasApiAxiosParamCreator = exports.RootApi = exports.RootApiFactory = exports.RootApiFp = exports.RootApiAxiosParamCreator = exports.ManagementFuncsApi = exports.ManagementFuncsApiFactory = exports.ManagementFuncsApiFp = exports.ManagementFuncsApiAxiosParamCreator = exports.FuncsApi = exports.FuncsApiFactory = exports.FuncsApiFp = exports.FuncsApiAxiosParamCreator = exports.ComponentsApi = exports.ComponentsApiFactory = exports.ComponentsApiFp = exports.ComponentsApiAxiosParamCreator = exports.ChangeSetsApi = exports.ChangeSetsApiFactory = exports.ChangeSetsApiFp = exports.ChangeSetsApiAxiosParamCreator = exports.ActionsApi = exports.ActionsApiFactory = exports.ActionsApiFp = exports.ActionsApiAxiosParamCreator = exports.SchemaVariantFuncKindOneOf2KindEnum = exports.SchemaVariantFuncKindOneOf1KindEnum = exports.SchemaVariantFuncKindOneOfKindEnum = void 0;
|
|
20
20
|
const axios_1 = __importDefault(require("axios"));
|
|
21
21
|
// Some imports not used depending on template conditions
|
|
22
22
|
// @ts-ignore
|
|
@@ -3728,6 +3728,119 @@ class SchemasApi extends base_1.BaseAPI {
|
|
|
3728
3728
|
}
|
|
3729
3729
|
}
|
|
3730
3730
|
exports.SchemasApi = SchemasApi;
|
|
3731
|
+
/**
|
|
3732
|
+
* SearchApi - axios parameter creator
|
|
3733
|
+
* @export
|
|
3734
|
+
*/
|
|
3735
|
+
const SearchApiAxiosParamCreator = function (configuration) {
|
|
3736
|
+
return {
|
|
3737
|
+
/**
|
|
3738
|
+
*
|
|
3739
|
+
* @summary Complex search for components
|
|
3740
|
+
* @param {string} workspaceId Workspace identifier
|
|
3741
|
+
* @param {string} changeSetId Change Set identifier
|
|
3742
|
+
* @param {string} q Query string. See https://docs.systeminit.com/explanation/search-syntax for details.
|
|
3743
|
+
* @param {*} [options] Override http request option.
|
|
3744
|
+
* @throws {RequiredError}
|
|
3745
|
+
*/
|
|
3746
|
+
search: async (workspaceId, changeSetId, q, options = {}) => {
|
|
3747
|
+
// verify required parameter 'workspaceId' is not null or undefined
|
|
3748
|
+
(0, common_1.assertParamExists)('search', 'workspaceId', workspaceId);
|
|
3749
|
+
// verify required parameter 'changeSetId' is not null or undefined
|
|
3750
|
+
(0, common_1.assertParamExists)('search', 'changeSetId', changeSetId);
|
|
3751
|
+
// verify required parameter 'q' is not null or undefined
|
|
3752
|
+
(0, common_1.assertParamExists)('search', 'q', q);
|
|
3753
|
+
const localVarPath = `/v1/w/{workspace_id}/change-sets/{change_set_id}/search`
|
|
3754
|
+
.replace(`{${"workspace_id"}}`, encodeURIComponent(String(workspaceId)))
|
|
3755
|
+
.replace(`{${"change_set_id"}}`, encodeURIComponent(String(changeSetId)));
|
|
3756
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3757
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
3758
|
+
let baseOptions;
|
|
3759
|
+
if (configuration) {
|
|
3760
|
+
baseOptions = configuration.baseOptions;
|
|
3761
|
+
}
|
|
3762
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
3763
|
+
const localVarHeaderParameter = {};
|
|
3764
|
+
const localVarQueryParameter = {};
|
|
3765
|
+
if (q !== undefined) {
|
|
3766
|
+
localVarQueryParameter['q'] = q;
|
|
3767
|
+
}
|
|
3768
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
3769
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3770
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
3771
|
+
return {
|
|
3772
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
3773
|
+
options: localVarRequestOptions,
|
|
3774
|
+
};
|
|
3775
|
+
},
|
|
3776
|
+
};
|
|
3777
|
+
};
|
|
3778
|
+
exports.SearchApiAxiosParamCreator = SearchApiAxiosParamCreator;
|
|
3779
|
+
/**
|
|
3780
|
+
* SearchApi - functional programming interface
|
|
3781
|
+
* @export
|
|
3782
|
+
*/
|
|
3783
|
+
const SearchApiFp = function (configuration) {
|
|
3784
|
+
const localVarAxiosParamCreator = (0, exports.SearchApiAxiosParamCreator)(configuration);
|
|
3785
|
+
return {
|
|
3786
|
+
/**
|
|
3787
|
+
*
|
|
3788
|
+
* @summary Complex search for components
|
|
3789
|
+
* @param {string} workspaceId Workspace identifier
|
|
3790
|
+
* @param {string} changeSetId Change Set identifier
|
|
3791
|
+
* @param {string} q Query string. See https://docs.systeminit.com/explanation/search-syntax for details.
|
|
3792
|
+
* @param {*} [options] Override http request option.
|
|
3793
|
+
* @throws {RequiredError}
|
|
3794
|
+
*/
|
|
3795
|
+
async search(workspaceId, changeSetId, q, options) {
|
|
3796
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.search(workspaceId, changeSetId, q, options);
|
|
3797
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3798
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['SearchApi.search']?.[localVarOperationServerIndex]?.url;
|
|
3799
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3800
|
+
},
|
|
3801
|
+
};
|
|
3802
|
+
};
|
|
3803
|
+
exports.SearchApiFp = SearchApiFp;
|
|
3804
|
+
/**
|
|
3805
|
+
* SearchApi - factory interface
|
|
3806
|
+
* @export
|
|
3807
|
+
*/
|
|
3808
|
+
const SearchApiFactory = function (configuration, basePath, axios) {
|
|
3809
|
+
const localVarFp = (0, exports.SearchApiFp)(configuration);
|
|
3810
|
+
return {
|
|
3811
|
+
/**
|
|
3812
|
+
*
|
|
3813
|
+
* @summary Complex search for components
|
|
3814
|
+
* @param {SearchApiSearchRequest} requestParameters Request parameters.
|
|
3815
|
+
* @param {*} [options] Override http request option.
|
|
3816
|
+
* @throws {RequiredError}
|
|
3817
|
+
*/
|
|
3818
|
+
search(requestParameters, options) {
|
|
3819
|
+
return localVarFp.search(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.q, options).then((request) => request(axios, basePath));
|
|
3820
|
+
},
|
|
3821
|
+
};
|
|
3822
|
+
};
|
|
3823
|
+
exports.SearchApiFactory = SearchApiFactory;
|
|
3824
|
+
/**
|
|
3825
|
+
* SearchApi - object-oriented interface
|
|
3826
|
+
* @export
|
|
3827
|
+
* @class SearchApi
|
|
3828
|
+
* @extends {BaseAPI}
|
|
3829
|
+
*/
|
|
3830
|
+
class SearchApi extends base_1.BaseAPI {
|
|
3831
|
+
/**
|
|
3832
|
+
*
|
|
3833
|
+
* @summary Complex search for components
|
|
3834
|
+
* @param {SearchApiSearchRequest} requestParameters Request parameters.
|
|
3835
|
+
* @param {*} [options] Override http request option.
|
|
3836
|
+
* @throws {RequiredError}
|
|
3837
|
+
* @memberof SearchApi
|
|
3838
|
+
*/
|
|
3839
|
+
search(requestParameters, options) {
|
|
3840
|
+
return (0, exports.SearchApiFp)(this.configuration).search(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.q, options).then((request) => request(this.axios, this.basePath));
|
|
3841
|
+
}
|
|
3842
|
+
}
|
|
3843
|
+
exports.SearchApi = SearchApi;
|
|
3731
3844
|
/**
|
|
3732
3845
|
* SecretsApi - axios parameter creator
|
|
3733
3846
|
* @export
|
package/dist/esm/api.d.ts
CHANGED
|
@@ -356,6 +356,44 @@ export interface ComponentReferenceOneOf1 {
|
|
|
356
356
|
*/
|
|
357
357
|
'componentId': string;
|
|
358
358
|
}
|
|
359
|
+
/**
|
|
360
|
+
* Component data in search results.
|
|
361
|
+
* @export
|
|
362
|
+
* @interface ComponentSearchResult
|
|
363
|
+
*/
|
|
364
|
+
export interface ComponentSearchResult {
|
|
365
|
+
/**
|
|
366
|
+
*
|
|
367
|
+
* @type {string}
|
|
368
|
+
* @memberof ComponentSearchResult
|
|
369
|
+
*/
|
|
370
|
+
'id': string;
|
|
371
|
+
/**
|
|
372
|
+
*
|
|
373
|
+
* @type {string}
|
|
374
|
+
* @memberof ComponentSearchResult
|
|
375
|
+
*/
|
|
376
|
+
'name': string;
|
|
377
|
+
/**
|
|
378
|
+
*
|
|
379
|
+
* @type {ComponentSearchResultSchema}
|
|
380
|
+
* @memberof ComponentSearchResult
|
|
381
|
+
*/
|
|
382
|
+
'schema': ComponentSearchResultSchema;
|
|
383
|
+
}
|
|
384
|
+
/**
|
|
385
|
+
* The schema for a component in search results.
|
|
386
|
+
* @export
|
|
387
|
+
* @interface ComponentSearchResultSchema
|
|
388
|
+
*/
|
|
389
|
+
export interface ComponentSearchResultSchema {
|
|
390
|
+
/**
|
|
391
|
+
*
|
|
392
|
+
* @type {string}
|
|
393
|
+
* @memberof ComponentSearchResultSchema
|
|
394
|
+
*/
|
|
395
|
+
'name': string;
|
|
396
|
+
}
|
|
359
397
|
/**
|
|
360
398
|
*
|
|
361
399
|
* @export
|
|
@@ -1659,6 +1697,12 @@ export interface GetSchemaVariantV1Response {
|
|
|
1659
1697
|
* @memberof GetSchemaVariantV1Response
|
|
1660
1698
|
*/
|
|
1661
1699
|
'domainProps'?: PropSchemaV1 | null;
|
|
1700
|
+
/**
|
|
1701
|
+
*
|
|
1702
|
+
* @type {boolean}
|
|
1703
|
+
* @memberof GetSchemaVariantV1Response
|
|
1704
|
+
*/
|
|
1705
|
+
'installedFromUpstream': boolean;
|
|
1662
1706
|
/**
|
|
1663
1707
|
*
|
|
1664
1708
|
* @type {boolean}
|
|
@@ -2290,6 +2334,12 @@ export interface SchemaVariantV1RequestPath {
|
|
|
2290
2334
|
* @interface SearchComponentsV1Request
|
|
2291
2335
|
*/
|
|
2292
2336
|
export interface SearchComponentsV1Request {
|
|
2337
|
+
/**
|
|
2338
|
+
*
|
|
2339
|
+
* @type {string}
|
|
2340
|
+
* @memberof SearchComponentsV1Request
|
|
2341
|
+
*/
|
|
2342
|
+
'queryString'?: string | null;
|
|
2293
2343
|
/**
|
|
2294
2344
|
*
|
|
2295
2345
|
* @type {string}
|
|
@@ -2348,6 +2398,32 @@ export interface SearchSchemasV1Response {
|
|
|
2348
2398
|
*/
|
|
2349
2399
|
'schemas': Array<SchemaResponse>;
|
|
2350
2400
|
}
|
|
2401
|
+
/**
|
|
2402
|
+
*
|
|
2403
|
+
* @export
|
|
2404
|
+
* @interface SearchV1Request
|
|
2405
|
+
*/
|
|
2406
|
+
export interface SearchV1Request {
|
|
2407
|
+
/**
|
|
2408
|
+
*
|
|
2409
|
+
* @type {string}
|
|
2410
|
+
* @memberof SearchV1Request
|
|
2411
|
+
*/
|
|
2412
|
+
'q': string;
|
|
2413
|
+
}
|
|
2414
|
+
/**
|
|
2415
|
+
*
|
|
2416
|
+
* @export
|
|
2417
|
+
* @interface SearchV1Response
|
|
2418
|
+
*/
|
|
2419
|
+
export interface SearchV1Response {
|
|
2420
|
+
/**
|
|
2421
|
+
*
|
|
2422
|
+
* @type {Array<ComponentSearchResult>}
|
|
2423
|
+
* @memberof SearchV1Response
|
|
2424
|
+
*/
|
|
2425
|
+
'components': Array<ComponentSearchResult>;
|
|
2426
|
+
}
|
|
2351
2427
|
/**
|
|
2352
2428
|
*
|
|
2353
2429
|
* @export
|
|
@@ -6271,6 +6347,110 @@ export declare class SchemasApi extends BaseAPI implements SchemasApiInterface {
|
|
|
6271
6347
|
*/
|
|
6272
6348
|
updateSchemaVariant(requestParameters: SchemasApiUpdateSchemaVariantRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSchemaVariantV1Response, any, {}>>;
|
|
6273
6349
|
}
|
|
6350
|
+
/**
|
|
6351
|
+
* SearchApi - axios parameter creator
|
|
6352
|
+
* @export
|
|
6353
|
+
*/
|
|
6354
|
+
export declare const SearchApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
6355
|
+
/**
|
|
6356
|
+
*
|
|
6357
|
+
* @summary Complex search for components
|
|
6358
|
+
* @param {string} workspaceId Workspace identifier
|
|
6359
|
+
* @param {string} changeSetId Change Set identifier
|
|
6360
|
+
* @param {string} q Query string. See https://docs.systeminit.com/explanation/search-syntax for details.
|
|
6361
|
+
* @param {*} [options] Override http request option.
|
|
6362
|
+
* @throws {RequiredError}
|
|
6363
|
+
*/
|
|
6364
|
+
search: (workspaceId: string, changeSetId: string, q: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
6365
|
+
};
|
|
6366
|
+
/**
|
|
6367
|
+
* SearchApi - functional programming interface
|
|
6368
|
+
* @export
|
|
6369
|
+
*/
|
|
6370
|
+
export declare const SearchApiFp: (configuration?: Configuration) => {
|
|
6371
|
+
/**
|
|
6372
|
+
*
|
|
6373
|
+
* @summary Complex search for components
|
|
6374
|
+
* @param {string} workspaceId Workspace identifier
|
|
6375
|
+
* @param {string} changeSetId Change Set identifier
|
|
6376
|
+
* @param {string} q Query string. See https://docs.systeminit.com/explanation/search-syntax for details.
|
|
6377
|
+
* @param {*} [options] Override http request option.
|
|
6378
|
+
* @throws {RequiredError}
|
|
6379
|
+
*/
|
|
6380
|
+
search(workspaceId: string, changeSetId: string, q: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchV1Response>>;
|
|
6381
|
+
};
|
|
6382
|
+
/**
|
|
6383
|
+
* SearchApi - factory interface
|
|
6384
|
+
* @export
|
|
6385
|
+
*/
|
|
6386
|
+
export declare const SearchApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
6387
|
+
/**
|
|
6388
|
+
*
|
|
6389
|
+
* @summary Complex search for components
|
|
6390
|
+
* @param {SearchApiSearchRequest} requestParameters Request parameters.
|
|
6391
|
+
* @param {*} [options] Override http request option.
|
|
6392
|
+
* @throws {RequiredError}
|
|
6393
|
+
*/
|
|
6394
|
+
search(requestParameters: SearchApiSearchRequest, options?: RawAxiosRequestConfig): AxiosPromise<SearchV1Response>;
|
|
6395
|
+
};
|
|
6396
|
+
/**
|
|
6397
|
+
* SearchApi - interface
|
|
6398
|
+
* @export
|
|
6399
|
+
* @interface SearchApi
|
|
6400
|
+
*/
|
|
6401
|
+
export interface SearchApiInterface {
|
|
6402
|
+
/**
|
|
6403
|
+
*
|
|
6404
|
+
* @summary Complex search for components
|
|
6405
|
+
* @param {SearchApiSearchRequest} requestParameters Request parameters.
|
|
6406
|
+
* @param {*} [options] Override http request option.
|
|
6407
|
+
* @throws {RequiredError}
|
|
6408
|
+
* @memberof SearchApiInterface
|
|
6409
|
+
*/
|
|
6410
|
+
search(requestParameters: SearchApiSearchRequest, options?: RawAxiosRequestConfig): AxiosPromise<SearchV1Response>;
|
|
6411
|
+
}
|
|
6412
|
+
/**
|
|
6413
|
+
* Request parameters for search operation in SearchApi.
|
|
6414
|
+
* @export
|
|
6415
|
+
* @interface SearchApiSearchRequest
|
|
6416
|
+
*/
|
|
6417
|
+
export interface SearchApiSearchRequest {
|
|
6418
|
+
/**
|
|
6419
|
+
* Workspace identifier
|
|
6420
|
+
* @type {string}
|
|
6421
|
+
* @memberof SearchApiSearch
|
|
6422
|
+
*/
|
|
6423
|
+
readonly workspaceId: string;
|
|
6424
|
+
/**
|
|
6425
|
+
* Change Set identifier
|
|
6426
|
+
* @type {string}
|
|
6427
|
+
* @memberof SearchApiSearch
|
|
6428
|
+
*/
|
|
6429
|
+
readonly changeSetId: string;
|
|
6430
|
+
/**
|
|
6431
|
+
* Query string. See https://docs.systeminit.com/explanation/search-syntax for details.
|
|
6432
|
+
* @type {string}
|
|
6433
|
+
* @memberof SearchApiSearch
|
|
6434
|
+
*/
|
|
6435
|
+
readonly q: string;
|
|
6436
|
+
}
|
|
6437
|
+
/**
|
|
6438
|
+
* SearchApi - object-oriented interface
|
|
6439
|
+
* @export
|
|
6440
|
+
* @class SearchApi
|
|
6441
|
+
* @extends {BaseAPI}
|
|
6442
|
+
*/
|
|
6443
|
+
export declare class SearchApi extends BaseAPI implements SearchApiInterface {
|
|
6444
|
+
/**
|
|
6445
|
+
*
|
|
6446
|
+
* @summary Complex search for components
|
|
6447
|
+
* @param {SearchApiSearchRequest} requestParameters Request parameters.
|
|
6448
|
+
* @param {*} [options] Override http request option.
|
|
6449
|
+
* @throws {RequiredError}
|
|
6450
|
+
* @memberof SearchApi
|
|
6451
|
+
*/
|
|
6452
|
+
search(requestParameters: SearchApiSearchRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SearchV1Response, any, {}>>;
|
|
6453
|
+
}
|
|
6274
6454
|
/**
|
|
6275
6455
|
* SecretsApi - axios parameter creator
|
|
6276
6456
|
* @export
|
package/dist/esm/api.js
CHANGED
|
@@ -3694,6 +3694,115 @@ export class SchemasApi extends BaseAPI {
|
|
|
3694
3694
|
return SchemasApiFp(this.configuration).updateSchemaVariant(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.schemaId, requestParameters.schemaVariantId, requestParameters.updateSchemaVariantV1Request, options).then((request) => request(this.axios, this.basePath));
|
|
3695
3695
|
}
|
|
3696
3696
|
}
|
|
3697
|
+
/**
|
|
3698
|
+
* SearchApi - axios parameter creator
|
|
3699
|
+
* @export
|
|
3700
|
+
*/
|
|
3701
|
+
export const SearchApiAxiosParamCreator = function (configuration) {
|
|
3702
|
+
return {
|
|
3703
|
+
/**
|
|
3704
|
+
*
|
|
3705
|
+
* @summary Complex search for components
|
|
3706
|
+
* @param {string} workspaceId Workspace identifier
|
|
3707
|
+
* @param {string} changeSetId Change Set identifier
|
|
3708
|
+
* @param {string} q Query string. See https://docs.systeminit.com/explanation/search-syntax for details.
|
|
3709
|
+
* @param {*} [options] Override http request option.
|
|
3710
|
+
* @throws {RequiredError}
|
|
3711
|
+
*/
|
|
3712
|
+
search: async (workspaceId, changeSetId, q, options = {}) => {
|
|
3713
|
+
// verify required parameter 'workspaceId' is not null or undefined
|
|
3714
|
+
assertParamExists('search', 'workspaceId', workspaceId);
|
|
3715
|
+
// verify required parameter 'changeSetId' is not null or undefined
|
|
3716
|
+
assertParamExists('search', 'changeSetId', changeSetId);
|
|
3717
|
+
// verify required parameter 'q' is not null or undefined
|
|
3718
|
+
assertParamExists('search', 'q', q);
|
|
3719
|
+
const localVarPath = `/v1/w/{workspace_id}/change-sets/{change_set_id}/search`
|
|
3720
|
+
.replace(`{${"workspace_id"}}`, encodeURIComponent(String(workspaceId)))
|
|
3721
|
+
.replace(`{${"change_set_id"}}`, encodeURIComponent(String(changeSetId)));
|
|
3722
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3723
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3724
|
+
let baseOptions;
|
|
3725
|
+
if (configuration) {
|
|
3726
|
+
baseOptions = configuration.baseOptions;
|
|
3727
|
+
}
|
|
3728
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
3729
|
+
const localVarHeaderParameter = {};
|
|
3730
|
+
const localVarQueryParameter = {};
|
|
3731
|
+
if (q !== undefined) {
|
|
3732
|
+
localVarQueryParameter['q'] = q;
|
|
3733
|
+
}
|
|
3734
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3735
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3736
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
3737
|
+
return {
|
|
3738
|
+
url: toPathString(localVarUrlObj),
|
|
3739
|
+
options: localVarRequestOptions,
|
|
3740
|
+
};
|
|
3741
|
+
},
|
|
3742
|
+
};
|
|
3743
|
+
};
|
|
3744
|
+
/**
|
|
3745
|
+
* SearchApi - functional programming interface
|
|
3746
|
+
* @export
|
|
3747
|
+
*/
|
|
3748
|
+
export const SearchApiFp = function (configuration) {
|
|
3749
|
+
const localVarAxiosParamCreator = SearchApiAxiosParamCreator(configuration);
|
|
3750
|
+
return {
|
|
3751
|
+
/**
|
|
3752
|
+
*
|
|
3753
|
+
* @summary Complex search for components
|
|
3754
|
+
* @param {string} workspaceId Workspace identifier
|
|
3755
|
+
* @param {string} changeSetId Change Set identifier
|
|
3756
|
+
* @param {string} q Query string. See https://docs.systeminit.com/explanation/search-syntax for details.
|
|
3757
|
+
* @param {*} [options] Override http request option.
|
|
3758
|
+
* @throws {RequiredError}
|
|
3759
|
+
*/
|
|
3760
|
+
async search(workspaceId, changeSetId, q, options) {
|
|
3761
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.search(workspaceId, changeSetId, q, options);
|
|
3762
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3763
|
+
const localVarOperationServerBasePath = operationServerMap['SearchApi.search']?.[localVarOperationServerIndex]?.url;
|
|
3764
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3765
|
+
},
|
|
3766
|
+
};
|
|
3767
|
+
};
|
|
3768
|
+
/**
|
|
3769
|
+
* SearchApi - factory interface
|
|
3770
|
+
* @export
|
|
3771
|
+
*/
|
|
3772
|
+
export const SearchApiFactory = function (configuration, basePath, axios) {
|
|
3773
|
+
const localVarFp = SearchApiFp(configuration);
|
|
3774
|
+
return {
|
|
3775
|
+
/**
|
|
3776
|
+
*
|
|
3777
|
+
* @summary Complex search for components
|
|
3778
|
+
* @param {SearchApiSearchRequest} requestParameters Request parameters.
|
|
3779
|
+
* @param {*} [options] Override http request option.
|
|
3780
|
+
* @throws {RequiredError}
|
|
3781
|
+
*/
|
|
3782
|
+
search(requestParameters, options) {
|
|
3783
|
+
return localVarFp.search(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.q, options).then((request) => request(axios, basePath));
|
|
3784
|
+
},
|
|
3785
|
+
};
|
|
3786
|
+
};
|
|
3787
|
+
/**
|
|
3788
|
+
* SearchApi - object-oriented interface
|
|
3789
|
+
* @export
|
|
3790
|
+
* @class SearchApi
|
|
3791
|
+
* @extends {BaseAPI}
|
|
3792
|
+
*/
|
|
3793
|
+
export class SearchApi extends BaseAPI {
|
|
3794
|
+
/**
|
|
3795
|
+
*
|
|
3796
|
+
* @summary Complex search for components
|
|
3797
|
+
* @param {SearchApiSearchRequest} requestParameters Request parameters.
|
|
3798
|
+
* @param {*} [options] Override http request option.
|
|
3799
|
+
* @throws {RequiredError}
|
|
3800
|
+
* @memberof SearchApi
|
|
3801
|
+
*/
|
|
3802
|
+
search(requestParameters, options) {
|
|
3803
|
+
return SearchApiFp(this.configuration).search(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.q, options).then((request) => request(this.axios, this.basePath));
|
|
3804
|
+
}
|
|
3805
|
+
}
|
|
3697
3806
|
/**
|
|
3698
3807
|
* SecretsApi - axios parameter creator
|
|
3699
3808
|
* @export
|
package/package.json
CHANGED