Skip to content

Commit

Permalink
Merge pull request #852 from deepfence/ui-v2-update-api-defs
Browse files Browse the repository at this point in the history
[V2][UI]update api spec
  • Loading branch information
manV authored Jan 30, 2023
2 parents 4b683ee + 6de66b2 commit 4fb58d4
Show file tree
Hide file tree
Showing 35 changed files with 2,557 additions and 394 deletions.
667 changes: 579 additions & 88 deletions deepfence_frontend/apps/dashboard/api-spec.json

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
.openapi-generator-ignore
apis/AuthenticationApi.ts
apis/CloudComplianceApi.ts
apis/CloudNodesApi.ts
apis/CloudResourcesApi.ts
apis/CloudScannerApi.ts
apis/ComplianceApi.ts
apis/ControlsApi.ts
apis/DiagnosisApi.ts
apis/KubernetesScannerApi.ts
apis/LookupApi.ts
apis/MalwareScanApi.ts
apis/RegisryApi.ts
apis/SecretScanApi.ts
apis/ThreatApi.ts
apis/TopologyApi.ts
Expand All @@ -20,13 +22,20 @@ models/ApiDocsFailureResponse.ts
models/ApiDocsGraphResult.ts
models/ControlsAction.ts
models/ControlsAgentControls.ts
models/ControlsKubernetesScannerControlResponse.ts
models/ControlsKubernetesScannerPendingScan.ts
models/ControlsKubernetesScannerPendingScans.ts
models/DetailedConnectionSummary.ts
models/DetailedNodeSummary.ts
models/DetailedParent.ts
models/DiagnosisDiagnosticNotification.ts
models/IngestersCloudCompliance.ts
models/IngestersCloudResource.ts
models/IngestersCompliance.ts
models/IngestersMalware.ts
models/IngestersMalwareScanStatus.ts
models/IngestersRegisterKubernetesScannerRequest.ts
models/IngestersReportIngestionData.ts
models/IngestersSecret.ts
models/IngestersSecretMatch.ts
models/IngestersSecretRule.ts
Expand All @@ -35,7 +44,7 @@ models/IngestersSecretSeverity.ts
models/IngestersVulnerability.ts
models/IngestersVulnerabilityScanStatus.ts
models/ModelAgentId.ts
models/ModelAgentImageMetadata.ts
models/ModelAgentUpgrade.ts
models/ModelApiAuthRequest.ts
models/ModelCloudComplianceScanDetails.ts
models/ModelCloudNodeAccountInfo.ts
Expand All @@ -54,12 +63,13 @@ models/ModelInviteUserRequest.ts
models/ModelInviteUserResponse.ts
models/ModelKubernetesCluster.ts
models/ModelLoginRequest.ts
models/ModelMessageResponse.ts
models/ModelPasswordResetRequest.ts
models/ModelPasswordResetVerifyRequest.ts
models/ModelPod.ts
models/ModelProcess.ts
models/ModelRegisterInvitedUserRequest.ts
models/ModelResponse.ts
models/ModelRegistryAddReq.ts
models/ModelResponseAccessToken.ts
models/ModelScanInfo.ts
models/ModelScanListReq.ts
Expand All @@ -71,8 +81,10 @@ models/ModelScanTriggerReq.ts
models/ModelScanTriggerResp.ts
models/ModelUser.ts
models/ModelUserRegisterRequest.ts
models/ModelVulnerabilityScanTriggerReq.ts
models/ReportColumn.ts
models/ReportMetadataRow.ts
models/ReportRawReport.ts
models/ReportRow.ts
models/ReportTable.ts
models/ReportersContainsFilter.ts
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import type {
ApiDocsFailureResponse,
ModelApiAuthRequest,
ModelLoginRequest,
ModelResponse,
ModelResponseAccessToken,
} from '../models';
import {
ApiDocsBadRequestResponseFromJSON,
Expand All @@ -30,8 +30,8 @@ import {
ModelApiAuthRequestToJSON,
ModelLoginRequestFromJSON,
ModelLoginRequestToJSON,
ModelResponseFromJSON,
ModelResponseToJSON,
ModelResponseAccessTokenFromJSON,
ModelResponseAccessTokenToJSON,
} from '../models';

export interface AuthTokenRequest {
Expand All @@ -57,13 +57,13 @@ export interface AuthenticationApiInterface {
* @throws {RequiredError}
* @memberof AuthenticationApiInterface
*/
authTokenRaw(requestParameters: AuthTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ModelResponse>>;
authTokenRaw(requestParameters: AuthTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ModelResponseAccessToken>>;

/**
* Get access token for programmatic API access, by providing API Token
* Get Access Token for API Token
*/
authToken(requestParameters: AuthTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ModelResponse>;
authToken(requestParameters: AuthTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ModelResponseAccessToken>;

/**
* Reissue access token using refresh token
Expand All @@ -72,13 +72,13 @@ export interface AuthenticationApiInterface {
* @throws {RequiredError}
* @memberof AuthenticationApiInterface
*/
authTokenRefreshRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ModelResponse>>;
authTokenRefreshRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ModelResponseAccessToken>>;

/**
* Reissue access token using refresh token
* Refresh access token
*/
authTokenRefresh(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ModelResponse>;
authTokenRefresh(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ModelResponseAccessToken>;

/**
* Login API
Expand All @@ -88,13 +88,13 @@ export interface AuthenticationApiInterface {
* @throws {RequiredError}
* @memberof AuthenticationApiInterface
*/
loginRaw(requestParameters: LoginRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ModelResponse>>;
loginRaw(requestParameters: LoginRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ModelResponseAccessToken>>;

/**
* Login API
* Login API
*/
login(requestParameters: LoginRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ModelResponse>;
login(requestParameters: LoginRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ModelResponseAccessToken>;

/**
* Logout API
Expand Down Expand Up @@ -122,7 +122,7 @@ export class AuthenticationApi extends runtime.BaseAPI implements Authentication
* Get access token for programmatic API access, by providing API Token
* Get Access Token for API Token
*/
async authTokenRaw(requestParameters: AuthTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ModelResponse>> {
async authTokenRaw(requestParameters: AuthTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ModelResponseAccessToken>> {
const queryParameters: any = {};

const headerParameters: runtime.HTTPHeaders = {};
Expand All @@ -137,14 +137,14 @@ export class AuthenticationApi extends runtime.BaseAPI implements Authentication
body: ModelApiAuthRequestToJSON(requestParameters.modelApiAuthRequest),
}, initOverrides);

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

/**
* Get access token for programmatic API access, by providing API Token
* Get Access Token for API Token
*/
async authToken(requestParameters: AuthTokenRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ModelResponse> {
async authToken(requestParameters: AuthTokenRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ModelResponseAccessToken> {
const response = await this.authTokenRaw(requestParameters, initOverrides);
return await response.value();
}
Expand All @@ -153,7 +153,7 @@ export class AuthenticationApi extends runtime.BaseAPI implements Authentication
* Reissue access token using refresh token
* Refresh access token
*/
async authTokenRefreshRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ModelResponse>> {
async authTokenRefreshRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ModelResponseAccessToken>> {
const queryParameters: any = {};

const headerParameters: runtime.HTTPHeaders = {};
Expand All @@ -173,14 +173,14 @@ export class AuthenticationApi extends runtime.BaseAPI implements Authentication
query: queryParameters,
}, initOverrides);

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

/**
* Reissue access token using refresh token
* Refresh access token
*/
async authTokenRefresh(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ModelResponse> {
async authTokenRefresh(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ModelResponseAccessToken> {
const response = await this.authTokenRefreshRaw(initOverrides);
return await response.value();
}
Expand All @@ -189,7 +189,7 @@ export class AuthenticationApi extends runtime.BaseAPI implements Authentication
* Login API
* Login API
*/
async loginRaw(requestParameters: LoginRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ModelResponse>> {
async loginRaw(requestParameters: LoginRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ModelResponseAccessToken>> {
const queryParameters: any = {};

const headerParameters: runtime.HTTPHeaders = {};
Expand All @@ -204,14 +204,14 @@ export class AuthenticationApi extends runtime.BaseAPI implements Authentication
body: ModelLoginRequestToJSON(requestParameters.modelLoginRequest),
}, initOverrides);

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

/**
* Login API
* Login API
*/
async login(requestParameters: LoginRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ModelResponse> {
async login(requestParameters: LoginRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ModelResponseAccessToken> {
const response = await this.loginRaw(requestParameters, initOverrides);
return await response.value();
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,19 +33,19 @@ export interface IngestCloudCompliancesRequest {
}

/**
* CloudComplianceApi - interface
* CloudScannerApi - interface
*
* @export
* @interface CloudComplianceApiInterface
* @interface CloudScannerApiInterface
*/
export interface CloudComplianceApiInterface {
export interface CloudScannerApiInterface {
/**
* Ingest Cloud compliances found while scanning cloud provider
* @summary Ingest Cloud Compliances
* @param {Array<IngestersCloudCompliance>} [ingestersCloudCompliance]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CloudComplianceApiInterface
* @memberof CloudScannerApiInterface
*/
ingestCloudCompliancesRaw(requestParameters: IngestCloudCompliancesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;

Expand All @@ -60,7 +60,7 @@ export interface CloudComplianceApiInterface {
/**
*
*/
export class CloudComplianceApi extends runtime.BaseAPI implements CloudComplianceApiInterface {
export class CloudScannerApi extends runtime.BaseAPI implements CloudScannerApiInterface {

/**
* Ingest Cloud compliances found while scanning cloud provider
Expand Down
Loading

0 comments on commit 4fb58d4

Please sign in to comment.