@lincyaw/[email protected]

This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:

Environment

• Node.js
• Webpack
• Browserify

Language level

• ES5 - you must have a Promises/A+ library installed
• ES6

Module system

• CommonJS
• ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)

Building

To build and compile the typescript sources to javascript use:

npm install
npm run build

Publishing

First build the package then run npm publish

Consuming

navigate to the folder of your consuming project and run one of the following commands.

published:

npm install @lincyaw/[email protected] --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

Documentation for API Endpoints

All URIs are relative to http://localhost:8082

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- AuthenticationApi | changePassword | POST /api/v2/auth/change-password | Change user password AuthenticationApi | getCurrentUserProfile | GET /api/v2/auth/profile | Get current user profile AuthenticationApi | login | POST /api/v2/auth/login | User login AuthenticationApi | logout | POST /api/v2/auth/logout | User logout AuthenticationApi | refreshAuthToken | POST /api/v2/auth/refresh | Refresh JWT token AuthenticationApi | registerUser | POST /api/v2/auth/register | User registration BlobApi | blobBatchDelete | POST /api/v2/blob/buckets/{bucket}/delete-batch | Batch delete objects BlobApi | blobCopy | POST /api/v2/blob/buckets/{bucket}/copy | Copy or move object BlobApi | blobCreateBucket | POST /api/v2/blob/buckets | Create bucket BlobApi | blobDeleteBucket | DELETE /api/v2/blob/buckets/{bucket} | Delete bucket BlobApi | blobGetBucketLifecycle | GET /api/v2/blob/buckets/{bucket}/lifecycle | Get bucket lifecycle policy BlobApi | blobPutBucketLifecycle | PUT /api/v2/blob/buckets/{bucket}/lifecycle | Replace bucket lifecycle policy ConfigCenterApi | deleteConfigEntry | DELETE /api/v2/config/{namespace}/{key} | Delete config entry ConfigCenterApi | getConfigEntry | GET /api/v2/config/{namespace}/{key} | Get config entry ConfigCenterApi | getConfigEntryHistory | GET /api/v2/config/{namespace}/{key}/history | Get config entry history ConfigCenterApi | listConfigEntries | GET /api/v2/config/{namespace} | List config entries ConfigCenterApi | setConfigEntry | PUT /api/v2/config/{namespace}/{key} | Set config entry ConfigCenterApi | watchConfigNamespace | GET /api/v2/config/{namespace}/watch | Watch config namespace ConfigurationsApi | getConfigById | GET /api/v2/system/configs/{config_id} | Get configuration ConfigurationsApi | listConfigHistories | GET /api/v2/system/configs/{config_id}/histories | List configuration histories ConfigurationsApi | listConfigs | GET /api/v2/system/configs | List configurations ConfigurationsApi | rollbackConfigMetadata | POST /api/v2/system/configs/{config_id}/metadata/rollback | Rollback configuration metadata ConfigurationsApi | rollbackConfigValue | POST /api/v2/system/configs/{config_id}/value/rollback | Rollback configuration value ConfigurationsApi | updateConfigMetadata | PUT /api/v2/system/configs/{config_id}/metadata | Update configuration metadata ConfigurationsApi | updateConfigValue | PATCH /api/v2/system/configs/{config_id} | Update configuration value PedestalApi | getPedestalRelease | GET /api/v2/pedestals/{release} | Get pedestal release PedestalApi | installPedestalRelease | POST /api/v2/pedestals | Install pedestal release PedestalApi | listPedestalReleases | GET /api/v2/pedestals | List pedestal releases PedestalApi | restartPedestalRelease | POST /api/v2/pedestals/{release}/restart | Restart pedestal release PedestalApi | uninstallPedestalRelease | DELETE /api/v2/pedestals/{release} | Uninstall pedestal release PermissionsApi | getPermissionById | GET /api/v2/permissions/{id} | Get permission by ID PermissionsApi | listPermissions | GET /api/v2/permissions | List permissions PermissionsApi | listRolesWithPermission | GET /api/v2/permissions/{permission_id}/roles | List roles from permission RelationsApi | assignRoleToUser | POST /api/v2/users/{user_id}/role/{role_id} | Assign global role to user RelationsApi | removeRoleFromUser | DELETE /api/v2/users/{user_id}/roles/{role_id} | Remove role from user ResourcesApi | getResourceById | GET /api/v2/resources/{id} | Get resource by ID ResourcesApi | listResourcePermissions | GET /api/v2/resources/{id}/permissions | List permissions from resource ResourcesApi | listResources | GET /api/v2/resources | List resources RolesApi | createRole | POST /api/v2/roles | Create a new role RolesApi | deleteRole | DELETE /api/v2/roles/{id} | Delete role RolesApi | getRoleById | GET /api/v2/roles/{id} | Get role by ID RolesApi | grantPermissionsToRole | POST /api/v2/roles/{role_id}/permissions/assign | Assign permissions to role RolesApi | listRoles | GET /api/v2/roles | List roles RolesApi | listUsersByRole | GET /api/v2/roles/{role_id}/users | List users from role RolesApi | revokePermissionsFromRole | POST /api/v2/roles/{role_id}/permissions/remove | Remove permissions from role RolesApi | updateRole | PATCH /api/v2/roles/{id} | Update role SSOAdminApi | ssoAdminCheck | POST /v1/check | Check permission (SSO admin) SSOAdminApi | ssoAdminCheckBatch | POST /v1/check/batch | Batch check permissions (SSO admin) SSOAdminApi | ssoAdminGetUser | GET /v1/users/{id} | Get user (SSO admin) SSOAdminApi | ssoAdminGetUsersBatch | POST /v1/users/batch | Batch get users (SSO admin) SSOAdminApi | ssoAdminGrant | POST /v1/grants | Grant scoped role (SSO admin) SSOAdminApi | ssoAdminListScopeUsers | GET /v1/scopes/{scope_type}/{scope_id}/users | List scope members (SSO admin) SSOAdminApi | ssoAdminListUserGrants | GET /v1/users/{id}/grants | List user grants (SSO admin) SSOAdminApi | ssoAdminListUsers | POST /v1/users/list | List users (SSO admin) SSOAdminApi | ssoAdminRegisterPermissions | POST /v1/permissions/register | Register permissions (SSO admin) SSOAdminApi | ssoAdminRevoke | DELETE /v1/grants | Revoke scoped role (SSO admin) SSOClientsApi | ssoCreateClient | POST /v1/clients | Create OIDC client SSOClientsApi | ssoDeleteClient | DELETE /v1/clients/{id} | Delete OIDC client SSOClientsApi | ssoGetClient | GET /v1/clients/{id} | Get OIDC client SSOClientsApi | ssoListClients | GET /v1/clients | List OIDC clients SSOClientsApi | ssoRotateClientSecret | POST /v1/clients/{id}/rotate | Rotate OIDC client secret SSOClientsApi | ssoUpdateClient | PUT /v1/clients/{id} | Update OIDC client SystemApi | apiV2SystemAuditGet | GET /api/v2/system/audit | List audit logs SystemApi | apiV2SystemAuditIdGet | GET /api/v2/system/audit/{id} | Get audit log by ID SystemApi | apiV2SystemMonitorInfoGet | GET /api/v2/system/monitor/info | Get system information SystemApi | apiV2SystemMonitorMetricsPost | POST /api/v2/system/monitor/metrics | Get monitoring metrics SystemApi | apiV2SystemMonitorNamespacesLocksGet | GET /api/v2/system/monitor/namespaces/locks | List namespace locks SystemApi | apiV2SystemMonitorTasksQueuePost | POST /api/v2/system/monitor/tasks/queue | List queued tasks SystemApi | getSystemHealth | GET /api/v2/system/health | System health check SystemApi | getSystemMetrics | GET /api/v2/system/metrics | Get current system metrics SystemApi | getSystemMetricsHistory | GET /api/v2/system/metrics/history | Get historical system metrics SystemsApi | createChaosSystem | POST /api/v2/systems | Create chaos system SystemsApi | deleteChaosSystem | DELETE /api/v2/systems/{id} | Delete chaos system SystemsApi | getChaosSystem | GET /api/v2/systems/{id} | Get chaos system by ID SystemsApi | getChaosSystemChartByName | GET /api/v2/systems/by-name/{name}/chart | Get chart source for a chaos system by name SystemsApi | listChaosSystemMetadata | GET /api/v2/systems/{id}/metadata | List chaos system metadata SystemsApi | listChaosSystems | GET /api/v2/systems | List chaos systems SystemsApi | listSystemInjectCandidates | GET /api/v2/systems/by-name/{name}/inject-candidates | List inject candidates for a system (optionally scoped to one namespace) SystemsApi | listSystemPrerequisites | GET /api/v2/systems/by-name/{name}/prerequisites | List system prerequisites SystemsApi | markSystemPrerequisite | POST /api/v2/systems/by-name/{name}/prerequisites/{id}/mark | Mark a prerequisite status SystemsApi | reseedChaosSystems | POST /api/v2/systems/reseed | Reseed systems from data.yaml SystemsApi | updateChaosSystem | PUT /api/v2/systems/{id} | Update chaos system SystemsApi | upsertChaosSystemMetadata | POST /api/v2/systems/{id}/metadata | Upsert chaos system metadata UsersApi | assignUserToContainer | POST /api/v2/users/{user_id}/containers/{container_id}/roles/{role_id} | Assign user to container UsersApi | assignUserToDataset | POST /api/v2/users/{user_id}/datasets/{dataset_id}/roles/{role_id} | Assign user to dataset UsersApi | assignUserToProject | POST /api/v2/users/{user_id}/projects/{project_id}/roles/{role_id} | Assign user to project UsersApi | createUser | POST /api/v2/users | Create a new user UsersApi | deleteUser | DELETE /api/v2/users/{id} | Delete user UsersApi | getUserById | GET /api/v2/users/{id}/detail | Get user by ID UsersApi | grantUserPermissions | POST /api/v2/users/{user_id}/permissions/assign | Assign permission to user UsersApi | listUsers | GET /api/v2/users | List users UsersApi | removeUserFromContainer | DELETE /api/v2/users/{user_id}/containers/{container_id} | Remove user from container UsersApi | removeUserFromDataset | DELETE /api/v2/users/{user_id}/datasets/{dataset_id} | Remove user from dataset UsersApi | removeUserFromProject | DELETE /api/v2/users/{user_id}/projects/{project_id} | Remove user from project UsersApi | resetUserPassword | POST /api/v2/users/{user_id}/reset-password | Reset a user's password (admin) UsersApi | revokeUserPermissions | POST /api/v2/users/{user_id}/permissions/remove | Remove permission from user UsersApi | updateUser | PATCH /api/v2/users/{id} | Update user

Documentation For Models

• ActionName
• AuthChangePasswordReq
• AuthLoginReq
• AuthLoginResp
• AuthRegisterReq
• AuthTokenRefreshReq
• AuthTokenRefreshResp
• AuthUserInfo
• AuthUserProfileResp
• BlobBatchDeleteReq
• BlobBatchDeleteResult
• BlobBatchFailItem
• BlobBucketLifecycle
• BlobBucketLifecycleRule
• BlobBucketSummary
• BlobCopyReq
• BlobCreateBucketReq
• BlobDeleteBucketResp
• BlobObjectMeta
• ChaossystemBulkUpsertSystemMetadataReq
• ChaossystemChaosSystemResp
• ChaossystemCreateChaosSystemReq
• ChaossystemInjectCandidateResp
• ChaossystemInjectCandidatesResp
• ChaossystemMarkPrerequisiteReq
• ChaossystemReseedSystemReq
• ChaossystemSystemChartResp
• ChaossystemSystemMetadataResp
• ChaossystemSystemPrerequisiteResp
• ChaossystemTopologyServiceReq
• ChaossystemUpdateChaosSystemReq
• ChaossystemUpsertSystemMetadataReq
• ConfigcenterEntryResp
• ConfigcenterLayer
• ConfigcenterSetReq
• GenericResponseAny
• GenericResponseAuthLoginResp
• GenericResponseAuthTokenRefreshResp
• GenericResponseAuthUserInfo
• GenericResponseAuthUserProfileResp
• GenericResponseBlobBatchDeleteResult
• GenericResponseBlobBucketLifecycle
• GenericResponseBlobBucketSummary
• GenericResponseBlobDeleteBucketResp
• GenericResponseBlobObjectMeta
• GenericResponseChaossystemChaosSystemResp
• GenericResponseChaossystemInjectCandidatesResp
• GenericResponseChaossystemSystemChartResp
• GenericResponseChaossystemSystemMetadataResp
• GenericResponseChaossystemSystemPrerequisiteResp
• GenericResponseListchaossystemChaosSystemResp
• GenericResponseListrbacPermissionResp
• GenericResponseListrbacResourceResp
• GenericResponseListrbacRoleResp
• GenericResponseListsystemAuditLogResp
• GenericResponseListsystemConfigHistoryResp
• GenericResponseListsystemConfigResp
• GenericResponseListuserUserResp
• GenericResponsePedestalInstallPedestalResult
• GenericResponsePedestalPedestalRelease
• GenericResponsePedestalPedestalReleaseDetail
• GenericResponseRbacPermissionDetailResp
• GenericResponseRbacPermissionResp
• GenericResponseRbacResourceResp
• GenericResponseRbacRoleDetailResp
• GenericResponseRbacRoleResp
• GenericResponseRbacUserListItem
• GenericResponseSsoCheckResp
• GenericResponseSsoClientResp
• GenericResponseSsoCreateClientResp
• GenericResponseSsoGrantResp
• GenericResponseSsoListUsersResp
• GenericResponseSsoRegisterPermissionsResp
• GenericResponseSsoRevokeResp
• GenericResponseSsoRotateSecretResp
• GenericResponseSsoScopeUserResp
• GenericResponseSsoUserGrantResp
• GenericResponseSsoUserInfoResp
• GenericResponseSystemAuditLogDetailResp
• GenericResponseSystemConfigResp
• GenericResponseSystemHealthCheckResp
• GenericResponseSystemListNamespaceLockResp
• GenericResponseSystemMonitoringMetricsResp
• GenericResponseSystemQueuedTasksResp
• GenericResponseSystemSystemInfo
• GenericResponseSystemmetricSystemMetricsHistoryResp
• GenericResponseSystemmetricSystemMetricsResp
• GenericResponseUserResetPasswordResp
• GenericResponseUserUserDetailResp
• GenericResponseUserUserResp
• GrantType
• ListchaossystemChaosSystemResp
• ListrbacPermissionResp
• ListrbacResourceResp
• ListrbacRoleResp
• ListsystemAuditLogResp
• ListsystemConfigHistoryResp
• ListsystemConfigResp
• ListuserUserResp
• PaginationInfo
• PedestalInstallPedestalReq
• PedestalInstallPedestalResult
• PedestalPedestalRelease
• PedestalPedestalReleaseDetail
• PedestalRestartPedestalReq
• RbacAssignRolePermissionReq
• RbacCreateRoleReq
• RbacPermissionDetailResp
• RbacPermissionResp
• RbacRemoveRolePermissionReq
• RbacResourceResp
• RbacRoleDetailResp
• RbacRoleResp
• RbacUpdateRoleReq
• RbacUserListItem
• ResourceName
• SsoBatchCheckReq
• SsoBatchUsersReq
• SsoCheckReq
• SsoCheckResp
• SsoClientResp
• SsoCreateClientReq
• SsoCreateClientResp
• SsoGrantReq
• SsoGrantResp
• SsoListUsersReq
• SsoListUsersResp
• SsoPermissionSpec
• SsoRegisterPermissionsReq
• SsoRegisterPermissionsResp
• SsoRevokeResp
• SsoRotateSecretResp
• SsoScopeUserResp
• SsoUpdateClientReq
• SsoUserGrantResp
• SsoUserInfoResp
• StatusType
• SystemAuditLogDetailResp
• SystemAuditLogResp
• SystemConfigHistoryResp
• SystemConfigResp
• SystemHealthCheckResp
• SystemListNamespaceLockResp
• SystemMetricValue
• SystemMonitoringMetricsResp
• SystemMonitoringQueryReq
• SystemQueuedTasksResp
• SystemRollbackConfigReq
• SystemSystemInfo
• SystemUpdateConfigMetadataReq
• SystemUpdateConfigValueReq
• SystemmetricMetricValue
• SystemmetricSystemMetricsHistoryResp
• SystemmetricSystemMetricsResp
• TaskResp
• UserAssignUserPermissionItem
• UserAssignUserPermissionReq
• UserCreateUserReq
• UserRemoveUserPermissionReq
• UserResetPasswordReq
• UserResetPasswordResp
• UserUpdateUserReq
• UserUserContainerInfo
• UserUserDatasetInfo
• UserUserDetailResp
• UserUserProjectInfo
• UserUserResp

Documentation For Authorization

Authentication schemes defined for the API:

BearerAuth

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header