Skip to content

Commit

Permalink
Merge pull request #361 from humanitec/update-client
Browse files Browse the repository at this point in the history 
Update client
  • Loading branch information
@louisbennett
louisbennett authored Aug 20, 2024
2 parents 5c306e1 + b5785ea commit b5510ab
Show file tree
Hide file tree
Showing 210 changed files with 1,787 additions and 835 deletions.
361 changes: 336 additions & 25 deletions docs/openapi.json
View file

Large diffs are not rendered by default.

10 changes: 8 additions & 2 deletions src/generated/.openapi-generator/FILES
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,16 @@ models/AzureKVRequest.ts
models/AzureKVResponse.ts
models/Batch.ts
models/BatchItem.ts
models/CheckResourceAccountData.ts
models/CheckResourceAccountField.ts
models/ClusterSecretRequest.ts
models/ClusterSecretResponse.ts
models/ConflictingResourcesErrorResponse.ts
models/ConflictingResourcesErrorResponseDetails.ts
models/ConflictingResourcesErrorResponseDetailsResources.ts
models/ContainerArtefactVersion.ts
models/ControllerResponse.ts
models/ConvertScoreToSetBody.ts
models/CreateArtefactVersion.ts
models/CreateArtefactVersionBase.ts
models/CreateContainerArtefactVersion.ts
Expand All @@ -39,8 +45,6 @@ models/CreateResourceAccountRequestRequest.ts
models/CreateResourceDefinitionRequestRequest.ts
models/CreateSecretStorePayloadRequest.ts
models/CreateWorkloadArtefactVersion.ts
models/CreateWorkloadArtefactVersionExtensions.ts
models/CreateWorkloadArtefactVersionExtensionsDeploy.ts
models/DeltaMetadataRequest.ts
models/DeltaMetadataResponse.ts
models/DeltaRequest.ts
Expand Down Expand Up @@ -143,6 +147,8 @@ models/RuntimeInfoResponseV1.ts
models/RuntimeInfoResponseV2.ts
models/RuntimeInfoStatus.ts
models/RuntimeInfoStatusClass.ts
models/ScoreHumanitecExtensions.ts
models/ScoreHumanitecExtensionsDeploy.ts
models/SecretReference.ts
models/SecretStoreRequest.ts
models/SecretStoreResponse.ts
Expand Down
156 changes: 147 additions & 9 deletions src/generated/apis/PublicApi.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
/* eslint-disable */
/**
* 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. |
* # 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 The Humanitec API, unless explicitly specified, 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, a new resource was created | | `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` range should be regarded as an error that 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.26.6
* Contact: apiteam@humanitec.com
* The version of the OpenAPI document: 0.26.14
* Contact: support@humanitec.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
Expand All @@ -28,6 +28,9 @@ import type {
AutomationRuleRequest,
AutomationRuleResponse,
Batch,
CheckResourceAccountData,
ConflictingResourcesErrorResponse,
ConvertScoreToSetBody,
CreateArtefactVersion,
CreateDriverRequestRequest,
CreateResourceAccountRequestRequest,
Expand Down Expand Up @@ -154,6 +157,12 @@ import {
AutomationRuleResponseToJSON,
BatchFromJSON,
BatchToJSON,
CheckResourceAccountDataFromJSON,
CheckResourceAccountDataToJSON,
ConflictingResourcesErrorResponseFromJSON,
ConflictingResourcesErrorResponseToJSON,
ConvertScoreToSetBodyFromJSON,
ConvertScoreToSetBodyToJSON,
CreateArtefactVersionFromJSON,
CreateArtefactVersionToJSON,
CreateDriverRequestRequestFromJSON,
Expand Down Expand Up @@ -369,6 +378,16 @@ export interface CancelPipelineRunRequest {
If_Match?: string;
}

export interface CheckResourceAccountRequest {
orgId: string;
accId: string;
}

export interface ConvertScoreToSetRequest {
orgId: string;
ConvertScoreToSetBody: ConvertScoreToSetBody;
}

export interface CreateAgentRequest {
orgId: string;
AgentCreateBody: AgentCreateBody;
Expand Down Expand Up @@ -475,6 +494,8 @@ export interface CreatePublicKeyRequest {
export interface CreateResourceAccountRequest {
orgId: string;
CreateResourceAccountRequestRequest: CreateResourceAccountRequestRequest;
dry_run?: boolean;
check_credential?: boolean;
}

export interface CreateResourceClassRequest {
Expand Down Expand Up @@ -1493,6 +1514,8 @@ export interface PatchResourceAccountRequest {
orgId: string;
accId: string;
UpdateResourceAccountRequestRequest: UpdateResourceAccountRequestRequest;
dry_run?: boolean;
check_credential?: boolean;
}

export interface PatchResourceDefinitionRequest {
Expand Down Expand Up @@ -1756,6 +1779,91 @@ export class PublicApi extends runtime.BaseAPI {
await this.cancelPipelineRunRaw(requestParameters, initOverrides);
}

/**
* Check the validity of a Resource Account and return any problems that may cause it to not work as expected.
* Check the credentials of an existing Resource Account
*/
async checkResourceAccountRaw(requestParameters: CheckResourceAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CheckResourceAccountData>> {
if (requestParameters['orgId'] == null) {
throw new runtime.RequiredError(
'orgId',
'Required parameter "orgId" was null or undefined when calling checkResourceAccount().'
);
}

if (requestParameters['accId'] == null) {
throw new runtime.RequiredError(
'accId',
'Required parameter "accId" was null or undefined when calling checkResourceAccount().'
);
}

const queryParameters: any = {};

const headerParameters: runtime.HTTPHeaders = {};

const response = await this.request({
path: `/orgs/{orgId}/resources/accounts/{accId}/actions/check`.replace(`{${"orgId"}}`, encodeURIComponent(String(requestParameters['orgId']))).replace(`{${"accId"}}`, encodeURIComponent(String(requestParameters['accId']))),
method: 'POST',
headers: headerParameters,
query: queryParameters,
}, initOverrides);

return new runtime.JSONApiResponse(response, (jsonValue) => CheckResourceAccountDataFromJSON(jsonValue));
}

/**
* Check the validity of a Resource Account and return any problems that may cause it to not work as expected.
* Check the credentials of an existing Resource Account
*/
async checkResourceAccount(requestParameters: CheckResourceAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CheckResourceAccountData> {
const response = await this.checkResourceAccountRaw(requestParameters, initOverrides);
return await response.value();
}

/**
* Convert a Score specification, optional overrides, and extensions into the contents for a deployment set.
*/
async convertScoreToSetRaw(requestParameters: ConvertScoreToSetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkloadArtefactVersionDeploymentSet>> {
if (requestParameters['orgId'] == null) {
throw new runtime.RequiredError(
'orgId',
'Required parameter "orgId" was null or undefined when calling convertScoreToSet().'
);
}

if (requestParameters['ConvertScoreToSetBody'] == null) {
throw new runtime.RequiredError(
'ConvertScoreToSetBody',
'Required parameter "ConvertScoreToSetBody" was null or undefined when calling convertScoreToSet().'
);
}

const queryParameters: any = {};

const headerParameters: runtime.HTTPHeaders = {};

headerParameters['Content-Type'] = 'application/json';

const response = await this.request({
path: `/orgs/{orgId}/artefact-versions/convert-score`.replace(`{${"orgId"}}`, encodeURIComponent(String(requestParameters['orgId']))),
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: ConvertScoreToSetBodyToJSON(requestParameters['ConvertScoreToSetBody']),
}, initOverrides);

return new runtime.JSONApiResponse(response, (jsonValue) => WorkloadArtefactVersionDeploymentSetFromJSON(jsonValue));
}

/**
* Convert a Score specification, optional overrides, and extensions into the contents for a deployment set.
*/
async convertScoreToSet(requestParameters: ConvertScoreToSetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkloadArtefactVersionDeploymentSet> {
const response = await this.convertScoreToSetRaw(requestParameters, initOverrides);
return await response.value();
}

/**
* Register a new Agent under an Organization.
*/
Expand Down Expand Up @@ -2642,6 +2750,14 @@ export class PublicApi extends runtime.BaseAPI {

const queryParameters: any = {};

if (requestParameters['dry_run'] != null) {
queryParameters['dry_run'] = requestParameters['dry_run'];
}

if (requestParameters['check_credential'] != null) {
queryParameters['check_credential'] = requestParameters['check_credential'];
}

const headerParameters: runtime.HTTPHeaders = {};

headerParameters['Content-Type'] = 'application/json';
Expand All @@ -2660,9 +2776,16 @@ export class PublicApi extends runtime.BaseAPI {
/**
* Create a new Resource Account in the organization.
*/
async createResourceAccount(requestParameters: CreateResourceAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ResourceAccountResponse> {
async createResourceAccount(requestParameters: CreateResourceAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ResourceAccountResponse | null | undefined > {
const response = await this.createResourceAccountRaw(requestParameters, initOverrides);
return await response.value();
switch (response.raw.status) {
case 200:
return await response.value();
case 204:
return null;
default:
return await response.value();
}
}

/**
Expand Down Expand Up @@ -3141,7 +3264,7 @@ export class PublicApi extends runtime.BaseAPI {
}

/**
* Delete Active Resources.
* Delete Active Resource.
*/
async deleteActiveResourceRaw(requestParameters: DeleteActiveResourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
if (requestParameters['orgId'] == null) {
Expand Down Expand Up @@ -3198,7 +3321,7 @@ export class PublicApi extends runtime.BaseAPI {
}

/**
* Delete Active Resources.
* Delete Active Resource.
*/
async deleteActiveResource(requestParameters: DeleteActiveResourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
await this.deleteActiveResourceRaw(requestParameters, initOverrides);
Expand Down Expand Up @@ -10583,6 +10706,14 @@ export class PublicApi extends runtime.BaseAPI {

const queryParameters: any = {};

if (requestParameters['dry_run'] != null) {
queryParameters['dry_run'] = requestParameters['dry_run'];
}

if (requestParameters['check_credential'] != null) {
queryParameters['check_credential'] = requestParameters['check_credential'];
}

const headerParameters: runtime.HTTPHeaders = {};

headerParameters['Content-Type'] = 'application/json';
Expand All @@ -10601,9 +10732,16 @@ export class PublicApi extends runtime.BaseAPI {
/**
* Update a Resource Account.
*/
async patchResourceAccount(requestParameters: PatchResourceAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ResourceAccountResponse> {
async patchResourceAccount(requestParameters: PatchResourceAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ResourceAccountResponse | null | undefined > {
const response = await this.patchResourceAccountRaw(requestParameters, initOverrides);
return await response.value();
switch (response.raw.status) {
case 200:
return await response.value();
case 204:
return null;
default:
return await response.value();
}
}

/**
Expand Down
Loading

0 comments on commit b5510ab

Please sign in to comment.