Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update client #272

Merged
merged 1 commit into from
Feb 19, 2024
Merged

Update client #272

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions docs/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"openapi": "3.0.0",
"info": {
"title": "Humanitec API",
"version": "0.25.4",
"version": "0.25.5",
"description": "# Introduction\nThe *Humanitec API* allows you to automate and integrate Humanitec into your developer and operational workflows.\nThe API is a REST based API. It is based around a set of concepts:\n\n* Core\n* External Resources\n* Sets and Deltas\n\n## Authentication\n\nAlmost all requests made to the Humanitec API require Authentication. See our [Developer Docs on API Authentication](https://developer.humanitec.com/platform-orchestrator/reference/api-references/#authentication) for instructions.\n\n## Content Types\nAll of the Humanitec API unless explicitly only accepts content types of `application/json` and will always return valid `application/json` or an empty response.\n\n## Response Codes\n### Success\nAny response code in the `2xx` range should be regarded as success.\n\n| **Code** | **Meaning** |\n| --- | --- |\n| `200` | Success |\n| `201` | Success (In future, `201` will be replaced by `200`) |\n| `204` | Success, but no content in response |\n\n_Note: We plan to simplify the interface by replacing 201 with 200 status codes._\n\n### Failure\nAny response code in the `4xx` should be regarded as an error which can be rectified by the client. `5xx` error codes indicate errors that cannot be corrected by the client.\n\n| **Code** | **Meaning** |\n| --- | --- |\n| `400` | General error. (Body will contain details) |\n| `401` | Attempt to access protected resource without `Authorization` Header. |\n| `403` | The `Bearer` or `JWT` does not grant access to the requested resource. |\n| `404` | Resource not found. |\n| `405` | Method not allowed |\n| `409` | Conflict. Usually indicated a resource with that ID already exists. |\n| `422` | Unprocessable Entity. The body was not valid JSON, was empty or contained an object different from what was expected. |\n| `429` | Too many requests - request rate limit has been reached. |\n| `500` | Internal Error. If it occurs repeatedly, contact support. |\n",
"contact": {
"name": "API Support",
Expand Down Expand Up @@ -6812,6 +6812,14 @@
"schema": {
"type": "string"
}
},
{
"name": "detach",
"in": "query",
"description": "If set to `true`, will detach an active resource. The resource continues to exist and is not deleted, but it is no longer connected to the Platform Orchestrator. \nDetaching can be done for any active resource. In case that the resource is an active one (i.e. not marked to be deleted), it would stay in use until the next deployment.\nDetaching active resources can cause inconsistent status (e.g. detaching a k8s-cluster might make it impossible to retrieve runtime information by or un-pause an environment)\nIf the resource has been provisioned via the Humanitec Operator, this does not delete the resource CR in the cluster. This must be done manually.\n",
"schema": {
"type": "boolean"
}
}
],
"responses": {
Expand Down Expand Up @@ -12670,7 +12678,6 @@
"required": [
"id",
"name",
"type",
"from_deploy_id"
],
"type": "object"
Expand Down
50 changes: 38 additions & 12 deletions src/generated/api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Humanitec API
* # Introduction The *Humanitec API* allows you to automate and integrate Humanitec into your developer and operational workflows. The API is a REST based API. It is based around a set of concepts: * Core * External Resources * Sets and Deltas ## Authentication Almost all requests made to the Humanitec API require Authentication. See our [Developer Docs on API Authentication](https://developer.humanitec.com/platform-orchestrator/reference/api-references/#authentication) for instructions. ## Content Types All of the Humanitec API unless explicitly only accepts content types of `application/json` and will always return valid `application/json` or an empty response. ## Response Codes ### Success Any response code in the `2xx` range should be regarded as success. | **Code** | **Meaning** | | --- | --- | | `200` | Success | | `201` | Success (In future, `201` will be replaced by `200`) | | `204` | Success, but no content in response | _Note: We plan to simplify the interface by replacing 201 with 200 status codes._ ### Failure Any response code in the `4xx` should be regarded as an error which can be rectified by the client. `5xx` error codes indicate errors that cannot be corrected by the client. | **Code** | **Meaning** | | --- | --- | | `400` | General error. (Body will contain details) | | `401` | Attempt to access protected resource without `Authorization` Header. | | `403` | The `Bearer` or `JWT` does not grant access to the requested resource. | | `404` | Resource not found. | | `405` | Method not allowed | | `409` | Conflict. Usually indicated a resource with that ID already exists. | | `422` | Unprocessable Entity. The body was not valid JSON, was empty or contained an object different from what was expected. | | `429` | Too many requests - request rate limit has been reached. | | `500` | Internal Error. If it occurs repeatedly, contact support. |
*
* The version of the OpenAPI document: 0.25.4
* The version of the OpenAPI document: 0.25.5
* Contact: [email protected]
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
Expand Down Expand Up @@ -2122,7 +2122,7 @@ export interface EnvironmentDefinitionRequest {
* @type {string}
* @memberof EnvironmentDefinitionRequest
*/
'type': string;
'type'?: string;
}
/**
* Environments are independent spaces where Applications can run. An Application is always deployed into an Environment.
Expand Down Expand Up @@ -6969,10 +6969,11 @@ export const ActiveResourceApiAxiosParamCreator = function (configuration?: Conf
* @param {string} envId The Environment ID.
* @param {string} type The Resource Type, may include a resource class: {type}.{class}.
* @param {string} resId The Resource ID.
* @param {boolean} [detach] If set to `true`, will detach an active resource. The resource continues to exist and is not deleted, but it is no longer connected to the Platform Orchestrator. Detaching can be done for any active resource. In case that the resource is an active one (i.e. not marked to be deleted), it would stay in use until the next deployment. Detaching active resources can cause inconsistent status (e.g. detaching a k8s-cluster might make it impossible to retrieve runtime information by or un-pause an environment) If the resource has been provisioned via the Humanitec Operator, this does not delete the resource CR in the cluster. This must be done manually.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteActiveResource: async (orgId: string, appId: string, envId: string, type: string, resId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
deleteActiveResource: async (orgId: string, appId: string, envId: string, type: string, resId: string, detach?: boolean, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'orgId' is not null or undefined
assertParamExists('deleteActiveResource', 'orgId', orgId)
// verify required parameter 'appId' is not null or undefined
Expand Down Expand Up @@ -7000,6 +7001,10 @@ export const ActiveResourceApiAxiosParamCreator = function (configuration?: Conf
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;

if (detach !== undefined) {
localVarQueryParameter['detach'] = detach;
}



setSearchParams(localVarUrlObj, localVarQueryParameter);
Expand Down Expand Up @@ -7109,11 +7114,12 @@ export const ActiveResourceApiFp = function(configuration?: Configuration) {
* @param {string} envId The Environment ID.
* @param {string} type The Resource Type, may include a resource class: {type}.{class}.
* @param {string} resId The Resource ID.
* @param {boolean} [detach] If set to &#x60;true&#x60;, will detach an active resource. The resource continues to exist and is not deleted, but it is no longer connected to the Platform Orchestrator. Detaching can be done for any active resource. In case that the resource is an active one (i.e. not marked to be deleted), it would stay in use until the next deployment. Detaching active resources can cause inconsistent status (e.g. detaching a k8s-cluster might make it impossible to retrieve runtime information by or un-pause an environment) If the resource has been provisioned via the Humanitec Operator, this does not delete the resource CR in the cluster. This must be done manually.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async deleteActiveResource(orgId: string, appId: string, envId: string, type: string, resId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteActiveResource(orgId, appId, envId, type, resId, options);
async deleteActiveResource(orgId: string, appId: string, envId: string, type: string, resId: string, detach?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteActiveResource(orgId, appId, envId, type, resId, detach, options);
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
},
/**
Expand Down Expand Up @@ -7159,7 +7165,7 @@ export const ActiveResourceApiFactory = function (configuration?: Configuration,
* @throws {RequiredError}
*/
deleteActiveResource(requestParameters: ActiveResourceApiDeleteActiveResourceRequest, options?: AxiosRequestConfig): AxiosPromise<void> {
return localVarFp.deleteActiveResource(requestParameters.orgId, requestParameters.appId, requestParameters.envId, requestParameters.type, requestParameters.resId, options).then((request) => request(axios, basePath));
return localVarFp.deleteActiveResource(requestParameters.orgId, requestParameters.appId, requestParameters.envId, requestParameters.type, requestParameters.resId, requestParameters.detach, options).then((request) => request(axios, basePath));
},
/**
*
Expand Down Expand Up @@ -7224,6 +7230,13 @@ export interface ActiveResourceApiDeleteActiveResourceRequest {
* @memberof ActiveResourceApiDeleteActiveResource
*/
readonly resId: string

/**
* If set to &#x60;true&#x60;, will detach an active resource. The resource continues to exist and is not deleted, but it is no longer connected to the Platform Orchestrator. Detaching can be done for any active resource. In case that the resource is an active one (i.e. not marked to be deleted), it would stay in use until the next deployment. Detaching active resources can cause inconsistent status (e.g. detaching a k8s-cluster might make it impossible to retrieve runtime information by or un-pause an environment) If the resource has been provisioned via the Humanitec Operator, this does not delete the resource CR in the cluster. This must be done manually.
* @type {boolean}
* @memberof ActiveResourceApiDeleteActiveResource
*/
readonly detach?: boolean
}

/**
Expand Down Expand Up @@ -7291,7 +7304,7 @@ export class ActiveResourceApi extends BaseAPI {
* @memberof ActiveResourceApi
*/
public deleteActiveResource(requestParameters: ActiveResourceApiDeleteActiveResourceRequest, options?: AxiosRequestConfig) {
return ActiveResourceApiFp(this.configuration).deleteActiveResource(requestParameters.orgId, requestParameters.appId, requestParameters.envId, requestParameters.type, requestParameters.resId, options).then((request) => request(this.axios, this.basePath));
return ActiveResourceApiFp(this.configuration).deleteActiveResource(requestParameters.orgId, requestParameters.appId, requestParameters.envId, requestParameters.type, requestParameters.resId, requestParameters.detach, options).then((request) => request(this.axios, this.basePath));
}

/**
Expand Down Expand Up @@ -20405,10 +20418,11 @@ export const PublicApiAxiosParamCreator = function (configuration?: Configuratio
* @param {string} envId The Environment ID.
* @param {string} type The Resource Type, may include a resource class: {type}.{class}.
* @param {string} resId The Resource ID.
* @param {boolean} [detach] If set to &#x60;true&#x60;, will detach an active resource. The resource continues to exist and is not deleted, but it is no longer connected to the Platform Orchestrator. Detaching can be done for any active resource. In case that the resource is an active one (i.e. not marked to be deleted), it would stay in use until the next deployment. Detaching active resources can cause inconsistent status (e.g. detaching a k8s-cluster might make it impossible to retrieve runtime information by or un-pause an environment) If the resource has been provisioned via the Humanitec Operator, this does not delete the resource CR in the cluster. This must be done manually.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteActiveResource: async (orgId: string, appId: string, envId: string, type: string, resId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
deleteActiveResource: async (orgId: string, appId: string, envId: string, type: string, resId: string, detach?: boolean, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'orgId' is not null or undefined
assertParamExists('deleteActiveResource', 'orgId', orgId)
// verify required parameter 'appId' is not null or undefined
Expand Down Expand Up @@ -20436,6 +20450,10 @@ export const PublicApiAxiosParamCreator = function (configuration?: Configuratio
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;

if (detach !== undefined) {
localVarQueryParameter['detach'] = detach;
}



setSearchParams(localVarUrlObj, localVarQueryParameter);
Expand Down Expand Up @@ -28034,11 +28052,12 @@ export const PublicApiFp = function(configuration?: Configuration) {
* @param {string} envId The Environment ID.
* @param {string} type The Resource Type, may include a resource class: {type}.{class}.
* @param {string} resId The Resource ID.
* @param {boolean} [detach] If set to &#x60;true&#x60;, will detach an active resource. The resource continues to exist and is not deleted, but it is no longer connected to the Platform Orchestrator. Detaching can be done for any active resource. In case that the resource is an active one (i.e. not marked to be deleted), it would stay in use until the next deployment. Detaching active resources can cause inconsistent status (e.g. detaching a k8s-cluster might make it impossible to retrieve runtime information by or un-pause an environment) If the resource has been provisioned via the Humanitec Operator, this does not delete the resource CR in the cluster. This must be done manually.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async deleteActiveResource(orgId: string, appId: string, envId: string, type: string, resId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteActiveResource(orgId, appId, envId, type, resId, options);
async deleteActiveResource(orgId: string, appId: string, envId: string, type: string, resId: string, detach?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteActiveResource(orgId, appId, envId, type, resId, detach, options);
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
},
/**
Expand Down Expand Up @@ -30490,7 +30509,7 @@ export const PublicApiFactory = function (configuration?: Configuration, basePat
* @throws {RequiredError}
*/
deleteActiveResource(requestParameters: PublicApiDeleteActiveResourceRequest, options?: AxiosRequestConfig): AxiosPromise<void> {
return localVarFp.deleteActiveResource(requestParameters.orgId, requestParameters.appId, requestParameters.envId, requestParameters.type, requestParameters.resId, options).then((request) => request(axios, basePath));
return localVarFp.deleteActiveResource(requestParameters.orgId, requestParameters.appId, requestParameters.envId, requestParameters.type, requestParameters.resId, requestParameters.detach, options).then((request) => request(axios, basePath));
},
/**
*
Expand Down Expand Up @@ -32916,6 +32935,13 @@ export interface PublicApiDeleteActiveResourceRequest {
* @memberof PublicApiDeleteActiveResource
*/
readonly resId: string

/**
* If set to &#x60;true&#x60;, will detach an active resource. The resource continues to exist and is not deleted, but it is no longer connected to the Platform Orchestrator. Detaching can be done for any active resource. In case that the resource is an active one (i.e. not marked to be deleted), it would stay in use until the next deployment. Detaching active resources can cause inconsistent status (e.g. detaching a k8s-cluster might make it impossible to retrieve runtime information by or un-pause an environment) If the resource has been provisioned via the Humanitec Operator, this does not delete the resource CR in the cluster. This must be done manually.
* @type {boolean}
* @memberof PublicApiDeleteActiveResource
*/
readonly detach?: boolean
}

/**
Expand Down Expand Up @@ -38090,7 +38116,7 @@ export class PublicApi extends BaseAPI {
* @memberof PublicApi
*/
public deleteActiveResource(requestParameters: PublicApiDeleteActiveResourceRequest, options?: AxiosRequestConfig) {
return PublicApiFp(this.configuration).deleteActiveResource(requestParameters.orgId, requestParameters.appId, requestParameters.envId, requestParameters.type, requestParameters.resId, options).then((request) => request(this.axios, this.basePath));
return PublicApiFp(this.configuration).deleteActiveResource(requestParameters.orgId, requestParameters.appId, requestParameters.envId, requestParameters.type, requestParameters.resId, requestParameters.detach, options).then((request) => request(this.axios, this.basePath));
}

/**
Expand Down
Loading