Skip to content

Commit

Permalink
Update server client #725
Browse files Browse the repository at this point in the history
  • Loading branch information
ramanan-ravi committed Jan 18, 2023
1 parent ebc6504 commit 8416439
Show file tree
Hide file tree
Showing 16 changed files with 2,345 additions and 5 deletions.
10 changes: 10 additions & 0 deletions deepfence_server_client/.openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,15 @@ docs/ModelContainer.md
docs/ModelFetchWindow.md
docs/ModelHost.md
docs/ModelImage.md
docs/ModelInviteUserRequest.md
docs/ModelInviteUserResponse.md
docs/ModelLoginRequest.md
docs/ModelPasswordResetRequest.md
docs/ModelPasswordResetVerifyRequest.md
docs/ModelPod.md
docs/ModelProcess.md
docs/ModelRawReport.md
docs/ModelRegisterInvitedUserRequest.md
docs/ModelResponse.md
docs/ModelResponseAccessToken.md
docs/ModelScanInfo.md
Expand Down Expand Up @@ -110,10 +115,15 @@ model_model_container.go
model_model_fetch_window.go
model_model_host.go
model_model_image.go
model_model_invite_user_request.go
model_model_invite_user_response.go
model_model_login_request.go
model_model_password_reset_request.go
model_model_password_reset_verify_request.go
model_model_pod.go
model_model_process.go
model_model_raw_report.go
model_model_register_invited_user_request.go
model_model_response.go
model_model_response_access_token.go
model_model_scan_info.go
Expand Down
9 changes: 9 additions & 0 deletions deepfence_server_client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,8 +122,12 @@ Class | Method | HTTP request | Description
*UserApi* | [**DeleteCurrentUser**](docs/UserApi.md#deletecurrentuser) | **Delete** /deepfence/user | Delete Current User
*UserApi* | [**GetApiTokens**](docs/UserApi.md#getapitokens) | **Get** /deepfence/api-token | Get User's API Tokens
*UserApi* | [**GetCurrentUser**](docs/UserApi.md#getcurrentuser) | **Get** /deepfence/user | Get Current User
*UserApi* | [**InviteUser**](docs/UserApi.md#inviteuser) | **Post** /deepfence/user/invite | Invite User
*UserApi* | [**RegisterInvitedUser**](docs/UserApi.md#registerinviteduser) | **Post** /deepfence/user/invite/register | Register Invited User
*UserApi* | [**RegisterUser**](docs/UserApi.md#registeruser) | **Post** /deepfence/user/register | Register User
*UserApi* | [**ResetPasswordRequest**](docs/UserApi.md#resetpasswordrequest) | **Post** /deepfence/user/reset-password/request | Reset Password Request
*UserApi* | [**UpdateCurrentUser**](docs/UserApi.md#updatecurrentuser) | **Put** /deepfence/user | Update Current User
*UserApi* | [**VerifyResetPasswordRequest**](docs/UserApi.md#verifyresetpasswordrequest) | **Post** /deepfence/user/reset-password/verify | Verify and Reset Password
*VulnerabilityApi* | [**IngestVulnerabilities**](docs/VulnerabilityApi.md#ingestvulnerabilities) | **Post** /deepfence/ingest/vulnerabilities | Ingest Vulnerabilities
*VulnerabilityApi* | [**ListVulnerabilityScans**](docs/VulnerabilityApi.md#listvulnerabilityscans) | **Post** /deepfence/scan/list/vulnerability | Get Vulnerability Scans List
*VulnerabilityApi* | [**ResultsVulnerabilityScans**](docs/VulnerabilityApi.md#resultsvulnerabilityscans) | **Post** /deepfence/scan/results/vulnerability | Get Vulnerability Scans Results
Expand Down Expand Up @@ -159,10 +163,15 @@ Class | Method | HTTP request | Description
- [ModelFetchWindow](docs/ModelFetchWindow.md)
- [ModelHost](docs/ModelHost.md)
- [ModelImage](docs/ModelImage.md)
- [ModelInviteUserRequest](docs/ModelInviteUserRequest.md)
- [ModelInviteUserResponse](docs/ModelInviteUserResponse.md)
- [ModelLoginRequest](docs/ModelLoginRequest.md)
- [ModelPasswordResetRequest](docs/ModelPasswordResetRequest.md)
- [ModelPasswordResetVerifyRequest](docs/ModelPasswordResetVerifyRequest.md)
- [ModelPod](docs/ModelPod.md)
- [ModelProcess](docs/ModelProcess.md)
- [ModelRawReport](docs/ModelRawReport.md)
- [ModelRegisterInvitedUserRequest](docs/ModelRegisterInvitedUserRequest.md)
- [ModelResponse](docs/ModelResponse.md)
- [ModelResponseAccessToken](docs/ModelResponseAccessToken.md)
- [ModelScanInfo](docs/ModelScanInfo.md)
Expand Down
244 changes: 244 additions & 0 deletions deepfence_server_client/api/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2026,6 +2026,90 @@ paths:
summary: Update Current User
tags:
- User
/deepfence/user/invite:
post:
description: Invite a user
operationId: inviteUser
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ModelInviteUserRequest'
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ModelResponse'
description: OK
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/ApiDocsBadRequestResponse'
description: Bad Request
"401":
description: Unauthorized
"403":
description: Forbidden
"404":
content:
application/json:
schema:
$ref: '#/components/schemas/ApiDocsFailureResponse'
description: Not Found
"500":
content:
application/json:
schema:
$ref: '#/components/schemas/ApiDocsFailureResponse'
description: Internal Server Error
security:
- bearer_token: []
summary: Invite User
tags:
- User
/deepfence/user/invite/register:
post:
description: Register invited user
operationId: registerInvitedUser
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ModelRegisterInvitedUserRequest'
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ModelResponse'
description: OK
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/ApiDocsBadRequestResponse'
description: Bad Request
"401":
description: Unauthorized
"403":
description: Forbidden
"404":
content:
application/json:
schema:
$ref: '#/components/schemas/ApiDocsFailureResponse'
description: Not Found
"500":
content:
application/json:
schema:
$ref: '#/components/schemas/ApiDocsFailureResponse'
description: Internal Server Error
summary: Register Invited User
tags:
- User
/deepfence/user/login:
post:
description: Login API
Expand Down Expand Up @@ -2142,6 +2226,88 @@ paths:
summary: Register User
tags:
- User
/deepfence/user/reset-password/request:
post:
description: Request for resetting the password
operationId: resetPasswordRequest
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ModelPasswordResetRequest'
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ModelResponse'
description: OK
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/ApiDocsBadRequestResponse'
description: Bad Request
"401":
description: Unauthorized
"403":
description: Forbidden
"404":
content:
application/json:
schema:
$ref: '#/components/schemas/ApiDocsFailureResponse'
description: Not Found
"500":
content:
application/json:
schema:
$ref: '#/components/schemas/ApiDocsFailureResponse'
description: Internal Server Error
summary: Reset Password Request
tags:
- User
/deepfence/user/reset-password/verify:
post:
description: Verify code and reset the password
operationId: verifyResetPasswordRequest
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ModelPasswordResetVerifyRequest'
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ModelResponse'
description: OK
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/ApiDocsBadRequestResponse'
description: Bad Request
"401":
description: Unauthorized
"403":
description: Forbidden
"404":
content:
application/json:
schema:
$ref: '#/components/schemas/ApiDocsFailureResponse'
description: Not Found
"500":
content:
application/json:
schema:
$ref: '#/components/schemas/ApiDocsFailureResponse'
description: Internal Server Error
summary: Verify and Reset Password
tags:
- User
components:
schemas:
ApiDocsBadRequestResponse:
Expand Down Expand Up @@ -3437,6 +3603,37 @@ components:
- tag
- virtual_mb
type: object
ModelInviteUserRequest:
example:
role: admin
action: send-invite-email
email: email
properties:
action:
enum:
- send-invite-email
- get-invite-link
type: string
email:
type: string
role:
enum:
- admin
- standard-user
- read-only-user
type: string
required:
- action
- email
- role
type: object
ModelInviteUserResponse:
properties:
invite_expiry_hours:
type: integer
invite_url:
type: string
type: object
ModelLoginRequest:
example:
password: password
Expand All @@ -3453,6 +3650,28 @@ components:
ModelMetadata:
additionalProperties: {}
type: object
ModelPasswordResetRequest:
example:
email: email
properties:
email:
type: string
required:
- email
type: object
ModelPasswordResetVerifyRequest:
example:
password: password
code: code
properties:
code:
type: string
password:
type: string
required:
- code
- password
type: object
ModelPod:
example:
image: image
Expand Down Expand Up @@ -3656,6 +3875,31 @@ components:
required:
- payload
type: object
ModelRegisterInvitedUserRequest:
example:
password: password
code: code
last_name: last_name
first_name: first_name
is_temporary_password: true
properties:
code:
type: string
first_name:
type: string
is_temporary_password:
type: boolean
last_name:
type: string
password:
type: string
required:
- code
- first_name
- is_temporary_password
- last_name
- password
type: object
ModelResponse:
example:
data:
Expand Down
Loading

0 comments on commit 8416439

Please sign in to comment.