qovery-typescript-axios 1.1.964 → 1.1.966
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/api.ts +339 -8
- package/dist/api.d.ts +238 -8
- package/dist/api.js +191 -21
- package/dist/esm/api.d.ts +238 -8
- package/dist/esm/api.js +178 -8
- package/package.json +1 -1
package/api.ts
CHANGED
|
@@ -4071,6 +4071,49 @@ export interface BlueprintCreateRequest {
|
|
|
4071
4071
|
*/
|
|
4072
4072
|
'spec_overrides'?: BlueprintSpecOverrides;
|
|
4073
4073
|
}
|
|
4074
|
+
/**
|
|
4075
|
+
* Answer to a blueprint creation: the blueprint exists and an engine dispatch was started. The service it should materialize does not exist yet.
|
|
4076
|
+
* @export
|
|
4077
|
+
* @interface BlueprintCreationResponse
|
|
4078
|
+
*/
|
|
4079
|
+
export interface BlueprintCreationResponse {
|
|
4080
|
+
/**
|
|
4081
|
+
*
|
|
4082
|
+
* @type {string}
|
|
4083
|
+
* @memberof BlueprintCreationResponse
|
|
4084
|
+
*/
|
|
4085
|
+
'id': string;
|
|
4086
|
+
/**
|
|
4087
|
+
* URL to the blueprint catalog entry
|
|
4088
|
+
* @type {string}
|
|
4089
|
+
* @memberof BlueprintCreationResponse
|
|
4090
|
+
*/
|
|
4091
|
+
'catalog_url': string;
|
|
4092
|
+
/**
|
|
4093
|
+
*
|
|
4094
|
+
* @type {string}
|
|
4095
|
+
* @memberof BlueprintCreationResponse
|
|
4096
|
+
*/
|
|
4097
|
+
'tag': string;
|
|
4098
|
+
/**
|
|
4099
|
+
*
|
|
4100
|
+
* @type {string}
|
|
4101
|
+
* @memberof BlueprintCreationResponse
|
|
4102
|
+
*/
|
|
4103
|
+
'environment_id': string;
|
|
4104
|
+
/**
|
|
4105
|
+
* Identifier of the dispatch started by this creation. Resolve its status with GET /blueprint/{blueprintId}, and match it against `latest_deployment.id` there to confirm that dispatch is this one rather than a later re-dispatch.
|
|
4106
|
+
* @type {string}
|
|
4107
|
+
* @memberof BlueprintCreationResponse
|
|
4108
|
+
*/
|
|
4109
|
+
'deployment_id': string;
|
|
4110
|
+
/**
|
|
4111
|
+
* Engine execution identifier for this dispatch
|
|
4112
|
+
* @type {string}
|
|
4113
|
+
* @memberof BlueprintCreationResponse
|
|
4114
|
+
*/
|
|
4115
|
+
'execution_id': string;
|
|
4116
|
+
}
|
|
4074
4117
|
/**
|
|
4075
4118
|
*
|
|
4076
4119
|
* @export
|
|
@@ -4090,6 +4133,125 @@ export interface BlueprintDeploymentAckResponse {
|
|
|
4090
4133
|
*/
|
|
4091
4134
|
'execution_id': string;
|
|
4092
4135
|
}
|
|
4136
|
+
/**
|
|
4137
|
+
*
|
|
4138
|
+
* @export
|
|
4139
|
+
* @interface BlueprintDeploymentStatusResponse
|
|
4140
|
+
*/
|
|
4141
|
+
export interface BlueprintDeploymentStatusResponse {
|
|
4142
|
+
/**
|
|
4143
|
+
*
|
|
4144
|
+
* @type {string}
|
|
4145
|
+
* @memberof BlueprintDeploymentStatusResponse
|
|
4146
|
+
*/
|
|
4147
|
+
'id': string;
|
|
4148
|
+
/**
|
|
4149
|
+
* Engine execution identifier for this dispatch
|
|
4150
|
+
* @type {string}
|
|
4151
|
+
* @memberof BlueprintDeploymentStatusResponse
|
|
4152
|
+
*/
|
|
4153
|
+
'execution_id': string;
|
|
4154
|
+
/**
|
|
4155
|
+
* Status of the dispatch. Only the states a blueprint dispatch can reach, which is a subset of the deployment statuses used elsewhere in the API.
|
|
4156
|
+
* @type {string}
|
|
4157
|
+
* @memberof BlueprintDeploymentStatusResponse
|
|
4158
|
+
*/
|
|
4159
|
+
'status': BlueprintDeploymentStatusResponseStatusEnum;
|
|
4160
|
+
/**
|
|
4161
|
+
*
|
|
4162
|
+
* @type {string}
|
|
4163
|
+
* @memberof BlueprintDeploymentStatusResponse
|
|
4164
|
+
*/
|
|
4165
|
+
'started_at': string;
|
|
4166
|
+
/**
|
|
4167
|
+
* When the dispatch reached a terminal state. Null while it is still running.
|
|
4168
|
+
* @type {string}
|
|
4169
|
+
* @memberof BlueprintDeploymentStatusResponse
|
|
4170
|
+
*/
|
|
4171
|
+
'terminated_at': string | null;
|
|
4172
|
+
/**
|
|
4173
|
+
* The engine\'s failure message. Null unless the dispatch failed.
|
|
4174
|
+
* @type {string}
|
|
4175
|
+
* @memberof BlueprintDeploymentStatusResponse
|
|
4176
|
+
*/
|
|
4177
|
+
'error_message': string | null;
|
|
4178
|
+
}
|
|
4179
|
+
|
|
4180
|
+
export const BlueprintDeploymentStatusResponseStatusEnum = {
|
|
4181
|
+
WAITING_RUNNING: 'WAITING_RUNNING',
|
|
4182
|
+
DEPLOYING: 'DEPLOYING',
|
|
4183
|
+
RUNNING: 'RUNNING',
|
|
4184
|
+
FAILED: 'FAILED',
|
|
4185
|
+
CANCELING: 'CANCELING',
|
|
4186
|
+
CANCELED: 'CANCELED',
|
|
4187
|
+
INTERNAL_ERROR: 'INTERNAL_ERROR'
|
|
4188
|
+
} as const;
|
|
4189
|
+
|
|
4190
|
+
export type BlueprintDeploymentStatusResponseStatusEnum = typeof BlueprintDeploymentStatusResponseStatusEnum[keyof typeof BlueprintDeploymentStatusResponseStatusEnum];
|
|
4191
|
+
|
|
4192
|
+
/**
|
|
4193
|
+
*
|
|
4194
|
+
* @export
|
|
4195
|
+
* @interface BlueprintDetailsResponse
|
|
4196
|
+
*/
|
|
4197
|
+
export interface BlueprintDetailsResponse {
|
|
4198
|
+
/**
|
|
4199
|
+
*
|
|
4200
|
+
* @type {string}
|
|
4201
|
+
* @memberof BlueprintDetailsResponse
|
|
4202
|
+
*/
|
|
4203
|
+
'id': string;
|
|
4204
|
+
/**
|
|
4205
|
+
*
|
|
4206
|
+
* @type {string}
|
|
4207
|
+
* @memberof BlueprintDetailsResponse
|
|
4208
|
+
*/
|
|
4209
|
+
'name': string;
|
|
4210
|
+
/**
|
|
4211
|
+
* URL to the blueprint catalog entry
|
|
4212
|
+
* @type {string}
|
|
4213
|
+
* @memberof BlueprintDetailsResponse
|
|
4214
|
+
*/
|
|
4215
|
+
'catalog_url': string;
|
|
4216
|
+
/**
|
|
4217
|
+
*
|
|
4218
|
+
* @type {string}
|
|
4219
|
+
* @memberof BlueprintDetailsResponse
|
|
4220
|
+
*/
|
|
4221
|
+
'tag': string;
|
|
4222
|
+
/**
|
|
4223
|
+
*
|
|
4224
|
+
* @type {string}
|
|
4225
|
+
* @memberof BlueprintDetailsResponse
|
|
4226
|
+
*/
|
|
4227
|
+
'environment_id': string;
|
|
4228
|
+
/**
|
|
4229
|
+
* Type of the underlying service backing this blueprint
|
|
4230
|
+
* @type {string}
|
|
4231
|
+
* @memberof BlueprintDetailsResponse
|
|
4232
|
+
*/
|
|
4233
|
+
'service_type': BlueprintDetailsResponseServiceTypeEnum;
|
|
4234
|
+
/**
|
|
4235
|
+
* The service the dispatch produced. Null while the dispatch is still running, and null if it failed.
|
|
4236
|
+
* @type {string}
|
|
4237
|
+
* @memberof BlueprintDetailsResponse
|
|
4238
|
+
*/
|
|
4239
|
+
'service_id': string | null;
|
|
4240
|
+
/**
|
|
4241
|
+
* Latest dispatch for this blueprint. Null if it was never dispatched.
|
|
4242
|
+
* @type {BlueprintDeploymentStatusResponse}
|
|
4243
|
+
* @memberof BlueprintDetailsResponse
|
|
4244
|
+
*/
|
|
4245
|
+
'latest_deployment': BlueprintDeploymentStatusResponse | null;
|
|
4246
|
+
}
|
|
4247
|
+
|
|
4248
|
+
export const BlueprintDetailsResponseServiceTypeEnum = {
|
|
4249
|
+
HELM: 'HELM',
|
|
4250
|
+
TERRAFORM: 'TERRAFORM'
|
|
4251
|
+
} as const;
|
|
4252
|
+
|
|
4253
|
+
export type BlueprintDetailsResponseServiceTypeEnum = typeof BlueprintDetailsResponseServiceTypeEnum[keyof typeof BlueprintDetailsResponseServiceTypeEnum];
|
|
4254
|
+
|
|
4093
4255
|
/**
|
|
4094
4256
|
*
|
|
4095
4257
|
* @export
|
|
@@ -36390,6 +36552,58 @@ export const BlueprintMainCallsApiAxiosParamCreator = function (configuration?:
|
|
|
36390
36552
|
|
|
36391
36553
|
|
|
36392
36554
|
|
|
36555
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
36556
|
+
|
|
36557
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
36558
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
36559
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
36560
|
+
localVarRequestOptions.data = serializeDataIfNeeded(blueprintCreateRequest, localVarRequestOptions, configuration)
|
|
36561
|
+
|
|
36562
|
+
return {
|
|
36563
|
+
url: toPathString(localVarUrlObj),
|
|
36564
|
+
options: localVarRequestOptions,
|
|
36565
|
+
};
|
|
36566
|
+
},
|
|
36567
|
+
/**
|
|
36568
|
+
* Instantiates a blueprint from the service catalog into the given environment and returns the ids of the engine dispatch it started. Pass `deploy=true` to trigger an immediate deployment after creation. Takes the same request as POST /environment/{environmentId}/blueprint. That endpoint answers 201, which claims a service that does not exist yet: the dispatch creating the underlying Helm/Terraform service runs on a background executor after the transaction commits. This one always answers 202 and hands back `deployment_id` and `execution_id`, which GET /blueprint/{blueprintId} resolves.
|
|
36569
|
+
* @summary Create a blueprint service and report the dispatch it started
|
|
36570
|
+
* @param {string} environmentId Environment ID
|
|
36571
|
+
* @param {BlueprintCreateRequest} blueprintCreateRequest
|
|
36572
|
+
* @param {boolean} [deploy] Trigger a deployment immediately after creation
|
|
36573
|
+
* @param {*} [options] Override http request option.
|
|
36574
|
+
* @throws {RequiredError}
|
|
36575
|
+
*/
|
|
36576
|
+
createBlueprintDeployment: async (environmentId: string, blueprintCreateRequest: BlueprintCreateRequest, deploy?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
36577
|
+
// verify required parameter 'environmentId' is not null or undefined
|
|
36578
|
+
assertParamExists('createBlueprintDeployment', 'environmentId', environmentId)
|
|
36579
|
+
// verify required parameter 'blueprintCreateRequest' is not null or undefined
|
|
36580
|
+
assertParamExists('createBlueprintDeployment', 'blueprintCreateRequest', blueprintCreateRequest)
|
|
36581
|
+
const localVarPath = `/environment/{environmentId}/blueprintDeployment`
|
|
36582
|
+
.replace(`{${"environmentId"}}`, encodeURIComponent(String(environmentId)));
|
|
36583
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
36584
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
36585
|
+
let baseOptions;
|
|
36586
|
+
if (configuration) {
|
|
36587
|
+
baseOptions = configuration.baseOptions;
|
|
36588
|
+
}
|
|
36589
|
+
|
|
36590
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
36591
|
+
const localVarHeaderParameter = {} as any;
|
|
36592
|
+
const localVarQueryParameter = {} as any;
|
|
36593
|
+
|
|
36594
|
+
// authentication ApiKeyAuth required
|
|
36595
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
36596
|
+
|
|
36597
|
+
// authentication bearerAuth required
|
|
36598
|
+
// http bearer authentication required
|
|
36599
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
36600
|
+
|
|
36601
|
+
if (deploy !== undefined) {
|
|
36602
|
+
localVarQueryParameter['deploy'] = deploy;
|
|
36603
|
+
}
|
|
36604
|
+
|
|
36605
|
+
|
|
36606
|
+
|
|
36393
36607
|
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
36394
36608
|
|
|
36395
36609
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -36434,6 +36648,47 @@ export const BlueprintMainCallsApiAxiosParamCreator = function (configuration?:
|
|
|
36434
36648
|
|
|
36435
36649
|
|
|
36436
36650
|
|
|
36651
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
36652
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
36653
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
36654
|
+
|
|
36655
|
+
return {
|
|
36656
|
+
url: toPathString(localVarUrlObj),
|
|
36657
|
+
options: localVarRequestOptions,
|
|
36658
|
+
};
|
|
36659
|
+
},
|
|
36660
|
+
/**
|
|
36661
|
+
* Returns the blueprint, the Helm/Terraform service its dispatch produced once that service exists, and the latest dispatch with its status and the engine\'s error message. This is the only way to learn that a dispatch failed. Success is pushed over the `/blueprint/service-created` websocket, but there is no failure counterpart, so a client that only listens on the websocket waits forever on a dispatch that errored.
|
|
36662
|
+
* @summary Get a blueprint service and the status of its latest dispatch
|
|
36663
|
+
* @param {string} blueprintId Blueprint ID
|
|
36664
|
+
* @param {*} [options] Override http request option.
|
|
36665
|
+
* @throws {RequiredError}
|
|
36666
|
+
*/
|
|
36667
|
+
getBlueprint: async (blueprintId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
36668
|
+
// verify required parameter 'blueprintId' is not null or undefined
|
|
36669
|
+
assertParamExists('getBlueprint', 'blueprintId', blueprintId)
|
|
36670
|
+
const localVarPath = `/blueprint/{blueprintId}`
|
|
36671
|
+
.replace(`{${"blueprintId"}}`, encodeURIComponent(String(blueprintId)));
|
|
36672
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
36673
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
36674
|
+
let baseOptions;
|
|
36675
|
+
if (configuration) {
|
|
36676
|
+
baseOptions = configuration.baseOptions;
|
|
36677
|
+
}
|
|
36678
|
+
|
|
36679
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
36680
|
+
const localVarHeaderParameter = {} as any;
|
|
36681
|
+
const localVarQueryParameter = {} as any;
|
|
36682
|
+
|
|
36683
|
+
// authentication ApiKeyAuth required
|
|
36684
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
36685
|
+
|
|
36686
|
+
// authentication bearerAuth required
|
|
36687
|
+
// http bearer authentication required
|
|
36688
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
36689
|
+
|
|
36690
|
+
|
|
36691
|
+
|
|
36437
36692
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
36438
36693
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
36439
36694
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -36616,6 +36871,21 @@ export const BlueprintMainCallsApiFp = function(configuration?: Configuration) {
|
|
|
36616
36871
|
const localVarOperationServerBasePath = operationServerMap['BlueprintMainCallsApi.createBlueprint']?.[localVarOperationServerIndex]?.url;
|
|
36617
36872
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
36618
36873
|
},
|
|
36874
|
+
/**
|
|
36875
|
+
* Instantiates a blueprint from the service catalog into the given environment and returns the ids of the engine dispatch it started. Pass `deploy=true` to trigger an immediate deployment after creation. Takes the same request as POST /environment/{environmentId}/blueprint. That endpoint answers 201, which claims a service that does not exist yet: the dispatch creating the underlying Helm/Terraform service runs on a background executor after the transaction commits. This one always answers 202 and hands back `deployment_id` and `execution_id`, which GET /blueprint/{blueprintId} resolves.
|
|
36876
|
+
* @summary Create a blueprint service and report the dispatch it started
|
|
36877
|
+
* @param {string} environmentId Environment ID
|
|
36878
|
+
* @param {BlueprintCreateRequest} blueprintCreateRequest
|
|
36879
|
+
* @param {boolean} [deploy] Trigger a deployment immediately after creation
|
|
36880
|
+
* @param {*} [options] Override http request option.
|
|
36881
|
+
* @throws {RequiredError}
|
|
36882
|
+
*/
|
|
36883
|
+
async createBlueprintDeployment(environmentId: string, blueprintCreateRequest: BlueprintCreateRequest, deploy?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BlueprintCreationResponse>> {
|
|
36884
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createBlueprintDeployment(environmentId, blueprintCreateRequest, deploy, options);
|
|
36885
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
36886
|
+
const localVarOperationServerBasePath = operationServerMap['BlueprintMainCallsApi.createBlueprintDeployment']?.[localVarOperationServerIndex]?.url;
|
|
36887
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
36888
|
+
},
|
|
36619
36889
|
/**
|
|
36620
36890
|
* Deploys the blueprint\'s currently saved settings to its service. Call this after saving changes with PATCH /blueprint/{blueprintId} (and, optionally, previewing them) to roll them out. No request body: it deploys whatever is currently saved on the blueprint.
|
|
36621
36891
|
* @summary Deploy (apply) the current blueprint spec
|
|
@@ -36629,6 +36899,19 @@ export const BlueprintMainCallsApiFp = function(configuration?: Configuration) {
|
|
|
36629
36899
|
const localVarOperationServerBasePath = operationServerMap['BlueprintMainCallsApi.deployBlueprint']?.[localVarOperationServerIndex]?.url;
|
|
36630
36900
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
36631
36901
|
},
|
|
36902
|
+
/**
|
|
36903
|
+
* Returns the blueprint, the Helm/Terraform service its dispatch produced once that service exists, and the latest dispatch with its status and the engine\'s error message. This is the only way to learn that a dispatch failed. Success is pushed over the `/blueprint/service-created` websocket, but there is no failure counterpart, so a client that only listens on the websocket waits forever on a dispatch that errored.
|
|
36904
|
+
* @summary Get a blueprint service and the status of its latest dispatch
|
|
36905
|
+
* @param {string} blueprintId Blueprint ID
|
|
36906
|
+
* @param {*} [options] Override http request option.
|
|
36907
|
+
* @throws {RequiredError}
|
|
36908
|
+
*/
|
|
36909
|
+
async getBlueprint(blueprintId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BlueprintDetailsResponse>> {
|
|
36910
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getBlueprint(blueprintId, options);
|
|
36911
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
36912
|
+
const localVarOperationServerBasePath = operationServerMap['BlueprintMainCallsApi.getBlueprint']?.[localVarOperationServerIndex]?.url;
|
|
36913
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
36914
|
+
},
|
|
36632
36915
|
/**
|
|
36633
36916
|
* Retrieves the Qovery service catalog from the public GitHub repository (Qovery/service-catalog). The catalog lists all available blueprints that can be deployed.
|
|
36634
36917
|
* @summary Get the blueprint service catalog
|
|
@@ -36702,6 +36985,18 @@ export const BlueprintMainCallsApiFactory = function (configuration?: Configurat
|
|
|
36702
36985
|
createBlueprint(environmentId: string, blueprintCreateRequest: BlueprintCreateRequest, deploy?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<BlueprintResponse> {
|
|
36703
36986
|
return localVarFp.createBlueprint(environmentId, blueprintCreateRequest, deploy, options).then((request) => request(axios, basePath));
|
|
36704
36987
|
},
|
|
36988
|
+
/**
|
|
36989
|
+
* Instantiates a blueprint from the service catalog into the given environment and returns the ids of the engine dispatch it started. Pass `deploy=true` to trigger an immediate deployment after creation. Takes the same request as POST /environment/{environmentId}/blueprint. That endpoint answers 201, which claims a service that does not exist yet: the dispatch creating the underlying Helm/Terraform service runs on a background executor after the transaction commits. This one always answers 202 and hands back `deployment_id` and `execution_id`, which GET /blueprint/{blueprintId} resolves.
|
|
36990
|
+
* @summary Create a blueprint service and report the dispatch it started
|
|
36991
|
+
* @param {string} environmentId Environment ID
|
|
36992
|
+
* @param {BlueprintCreateRequest} blueprintCreateRequest
|
|
36993
|
+
* @param {boolean} [deploy] Trigger a deployment immediately after creation
|
|
36994
|
+
* @param {*} [options] Override http request option.
|
|
36995
|
+
* @throws {RequiredError}
|
|
36996
|
+
*/
|
|
36997
|
+
createBlueprintDeployment(environmentId: string, blueprintCreateRequest: BlueprintCreateRequest, deploy?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<BlueprintCreationResponse> {
|
|
36998
|
+
return localVarFp.createBlueprintDeployment(environmentId, blueprintCreateRequest, deploy, options).then((request) => request(axios, basePath));
|
|
36999
|
+
},
|
|
36705
37000
|
/**
|
|
36706
37001
|
* Deploys the blueprint\'s currently saved settings to its service. Call this after saving changes with PATCH /blueprint/{blueprintId} (and, optionally, previewing them) to roll them out. No request body: it deploys whatever is currently saved on the blueprint.
|
|
36707
37002
|
* @summary Deploy (apply) the current blueprint spec
|
|
@@ -36712,6 +37007,16 @@ export const BlueprintMainCallsApiFactory = function (configuration?: Configurat
|
|
|
36712
37007
|
deployBlueprint(blueprintId: string, options?: RawAxiosRequestConfig): AxiosPromise<BlueprintDeploymentAckResponse> {
|
|
36713
37008
|
return localVarFp.deployBlueprint(blueprintId, options).then((request) => request(axios, basePath));
|
|
36714
37009
|
},
|
|
37010
|
+
/**
|
|
37011
|
+
* Returns the blueprint, the Helm/Terraform service its dispatch produced once that service exists, and the latest dispatch with its status and the engine\'s error message. This is the only way to learn that a dispatch failed. Success is pushed over the `/blueprint/service-created` websocket, but there is no failure counterpart, so a client that only listens on the websocket waits forever on a dispatch that errored.
|
|
37012
|
+
* @summary Get a blueprint service and the status of its latest dispatch
|
|
37013
|
+
* @param {string} blueprintId Blueprint ID
|
|
37014
|
+
* @param {*} [options] Override http request option.
|
|
37015
|
+
* @throws {RequiredError}
|
|
37016
|
+
*/
|
|
37017
|
+
getBlueprint(blueprintId: string, options?: RawAxiosRequestConfig): AxiosPromise<BlueprintDetailsResponse> {
|
|
37018
|
+
return localVarFp.getBlueprint(blueprintId, options).then((request) => request(axios, basePath));
|
|
37019
|
+
},
|
|
36715
37020
|
/**
|
|
36716
37021
|
* Retrieves the Qovery service catalog from the public GitHub repository (Qovery/service-catalog). The catalog lists all available blueprints that can be deployed.
|
|
36717
37022
|
* @summary Get the blueprint service catalog
|
|
@@ -36780,6 +37085,20 @@ export class BlueprintMainCallsApi extends BaseAPI {
|
|
|
36780
37085
|
return BlueprintMainCallsApiFp(this.configuration).createBlueprint(environmentId, blueprintCreateRequest, deploy, options).then((request) => request(this.axios, this.basePath));
|
|
36781
37086
|
}
|
|
36782
37087
|
|
|
37088
|
+
/**
|
|
37089
|
+
* Instantiates a blueprint from the service catalog into the given environment and returns the ids of the engine dispatch it started. Pass `deploy=true` to trigger an immediate deployment after creation. Takes the same request as POST /environment/{environmentId}/blueprint. That endpoint answers 201, which claims a service that does not exist yet: the dispatch creating the underlying Helm/Terraform service runs on a background executor after the transaction commits. This one always answers 202 and hands back `deployment_id` and `execution_id`, which GET /blueprint/{blueprintId} resolves.
|
|
37090
|
+
* @summary Create a blueprint service and report the dispatch it started
|
|
37091
|
+
* @param {string} environmentId Environment ID
|
|
37092
|
+
* @param {BlueprintCreateRequest} blueprintCreateRequest
|
|
37093
|
+
* @param {boolean} [deploy] Trigger a deployment immediately after creation
|
|
37094
|
+
* @param {*} [options] Override http request option.
|
|
37095
|
+
* @throws {RequiredError}
|
|
37096
|
+
* @memberof BlueprintMainCallsApi
|
|
37097
|
+
*/
|
|
37098
|
+
public createBlueprintDeployment(environmentId: string, blueprintCreateRequest: BlueprintCreateRequest, deploy?: boolean, options?: RawAxiosRequestConfig) {
|
|
37099
|
+
return BlueprintMainCallsApiFp(this.configuration).createBlueprintDeployment(environmentId, blueprintCreateRequest, deploy, options).then((request) => request(this.axios, this.basePath));
|
|
37100
|
+
}
|
|
37101
|
+
|
|
36783
37102
|
/**
|
|
36784
37103
|
* Deploys the blueprint\'s currently saved settings to its service. Call this after saving changes with PATCH /blueprint/{blueprintId} (and, optionally, previewing them) to roll them out. No request body: it deploys whatever is currently saved on the blueprint.
|
|
36785
37104
|
* @summary Deploy (apply) the current blueprint spec
|
|
@@ -36792,6 +37111,18 @@ export class BlueprintMainCallsApi extends BaseAPI {
|
|
|
36792
37111
|
return BlueprintMainCallsApiFp(this.configuration).deployBlueprint(blueprintId, options).then((request) => request(this.axios, this.basePath));
|
|
36793
37112
|
}
|
|
36794
37113
|
|
|
37114
|
+
/**
|
|
37115
|
+
* Returns the blueprint, the Helm/Terraform service its dispatch produced once that service exists, and the latest dispatch with its status and the engine\'s error message. This is the only way to learn that a dispatch failed. Success is pushed over the `/blueprint/service-created` websocket, but there is no failure counterpart, so a client that only listens on the websocket waits forever on a dispatch that errored.
|
|
37116
|
+
* @summary Get a blueprint service and the status of its latest dispatch
|
|
37117
|
+
* @param {string} blueprintId Blueprint ID
|
|
37118
|
+
* @param {*} [options] Override http request option.
|
|
37119
|
+
* @throws {RequiredError}
|
|
37120
|
+
* @memberof BlueprintMainCallsApi
|
|
37121
|
+
*/
|
|
37122
|
+
public getBlueprint(blueprintId: string, options?: RawAxiosRequestConfig) {
|
|
37123
|
+
return BlueprintMainCallsApiFp(this.configuration).getBlueprint(blueprintId, options).then((request) => request(this.axios, this.basePath));
|
|
37124
|
+
}
|
|
37125
|
+
|
|
36795
37126
|
/**
|
|
36796
37127
|
* Retrieves the Qovery service catalog from the public GitHub repository (Qovery/service-catalog). The catalog lists all available blueprints that can be deployed.
|
|
36797
37128
|
* @summary Get the blueprint service catalog
|
|
@@ -73993,7 +74324,7 @@ export const SecretManagerAccessApiAxiosParamCreator = function (configuration?:
|
|
|
73993
74324
|
/**
|
|
73994
74325
|
* List external secrets used by a secret manager access
|
|
73995
74326
|
* @summary List external secrets used by a secret manager access
|
|
73996
|
-
* @param {string} secretManagerAccessId Secret Manager Access
|
|
74327
|
+
* @param {string} secretManagerAccessId Secret Manager Access Id - Use the endpoint [`GET /organization/{organizationId}/cluster`](#operation/listOrganizationCluster) to retrieve your secret manager access
|
|
73997
74328
|
* @param {*} [options] Override http request option.
|
|
73998
74329
|
* @throws {RequiredError}
|
|
73999
74330
|
*/
|
|
@@ -74034,7 +74365,7 @@ export const SecretManagerAccessApiAxiosParamCreator = function (configuration?:
|
|
|
74034
74365
|
/**
|
|
74035
74366
|
* List upstream secrets from secret provider
|
|
74036
74367
|
* @summary List upstream secrets from secret provider
|
|
74037
|
-
* @param {string} secretManagerAccessId Secret Manager Access
|
|
74368
|
+
* @param {string} secretManagerAccessId Secret Manager Access Id - Use the endpoint [`GET /organization/{organizationId}/cluster`](#operation/listOrganizationCluster) to retrieve your secret manager access
|
|
74038
74369
|
* @param {string} [namePrefix]
|
|
74039
74370
|
* @param {*} [options] Override http request option.
|
|
74040
74371
|
* @throws {RequiredError}
|
|
@@ -74090,7 +74421,7 @@ export const SecretManagerAccessApiFp = function(configuration?: Configuration)
|
|
|
74090
74421
|
/**
|
|
74091
74422
|
* List external secrets used by a secret manager access
|
|
74092
74423
|
* @summary List external secrets used by a secret manager access
|
|
74093
|
-
* @param {string} secretManagerAccessId Secret Manager Access
|
|
74424
|
+
* @param {string} secretManagerAccessId Secret Manager Access Id - Use the endpoint [`GET /organization/{organizationId}/cluster`](#operation/listOrganizationCluster) to retrieve your secret manager access
|
|
74094
74425
|
* @param {*} [options] Override http request option.
|
|
74095
74426
|
* @throws {RequiredError}
|
|
74096
74427
|
*/
|
|
@@ -74103,7 +74434,7 @@ export const SecretManagerAccessApiFp = function(configuration?: Configuration)
|
|
|
74103
74434
|
/**
|
|
74104
74435
|
* List upstream secrets from secret provider
|
|
74105
74436
|
* @summary List upstream secrets from secret provider
|
|
74106
|
-
* @param {string} secretManagerAccessId Secret Manager Access
|
|
74437
|
+
* @param {string} secretManagerAccessId Secret Manager Access Id - Use the endpoint [`GET /organization/{organizationId}/cluster`](#operation/listOrganizationCluster) to retrieve your secret manager access
|
|
74107
74438
|
* @param {string} [namePrefix]
|
|
74108
74439
|
* @param {*} [options] Override http request option.
|
|
74109
74440
|
* @throws {RequiredError}
|
|
@@ -74127,7 +74458,7 @@ export const SecretManagerAccessApiFactory = function (configuration?: Configura
|
|
|
74127
74458
|
/**
|
|
74128
74459
|
* List external secrets used by a secret manager access
|
|
74129
74460
|
* @summary List external secrets used by a secret manager access
|
|
74130
|
-
* @param {string} secretManagerAccessId Secret Manager Access
|
|
74461
|
+
* @param {string} secretManagerAccessId Secret Manager Access Id - Use the endpoint [`GET /organization/{organizationId}/cluster`](#operation/listOrganizationCluster) to retrieve your secret manager access
|
|
74131
74462
|
* @param {*} [options] Override http request option.
|
|
74132
74463
|
* @throws {RequiredError}
|
|
74133
74464
|
*/
|
|
@@ -74137,7 +74468,7 @@ export const SecretManagerAccessApiFactory = function (configuration?: Configura
|
|
|
74137
74468
|
/**
|
|
74138
74469
|
* List upstream secrets from secret provider
|
|
74139
74470
|
* @summary List upstream secrets from secret provider
|
|
74140
|
-
* @param {string} secretManagerAccessId Secret Manager Access
|
|
74471
|
+
* @param {string} secretManagerAccessId Secret Manager Access Id - Use the endpoint [`GET /organization/{organizationId}/cluster`](#operation/listOrganizationCluster) to retrieve your secret manager access
|
|
74141
74472
|
* @param {string} [namePrefix]
|
|
74142
74473
|
* @param {*} [options] Override http request option.
|
|
74143
74474
|
* @throws {RequiredError}
|
|
@@ -74158,7 +74489,7 @@ export class SecretManagerAccessApi extends BaseAPI {
|
|
|
74158
74489
|
/**
|
|
74159
74490
|
* List external secrets used by a secret manager access
|
|
74160
74491
|
* @summary List external secrets used by a secret manager access
|
|
74161
|
-
* @param {string} secretManagerAccessId Secret Manager Access
|
|
74492
|
+
* @param {string} secretManagerAccessId Secret Manager Access Id - Use the endpoint [`GET /organization/{organizationId}/cluster`](#operation/listOrganizationCluster) to retrieve your secret manager access
|
|
74162
74493
|
* @param {*} [options] Override http request option.
|
|
74163
74494
|
* @throws {RequiredError}
|
|
74164
74495
|
* @memberof SecretManagerAccessApi
|
|
@@ -74170,7 +74501,7 @@ export class SecretManagerAccessApi extends BaseAPI {
|
|
|
74170
74501
|
/**
|
|
74171
74502
|
* List upstream secrets from secret provider
|
|
74172
74503
|
* @summary List upstream secrets from secret provider
|
|
74173
|
-
* @param {string} secretManagerAccessId Secret Manager Access
|
|
74504
|
+
* @param {string} secretManagerAccessId Secret Manager Access Id - Use the endpoint [`GET /organization/{organizationId}/cluster`](#operation/listOrganizationCluster) to retrieve your secret manager access
|
|
74174
74505
|
* @param {string} [namePrefix]
|
|
74175
74506
|
* @param {*} [options] Override http request option.
|
|
74176
74507
|
* @throws {RequiredError}
|