@zlayer/api-client 0.10.86 → 0.11.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +58 -1
- package/README.md +48 -6
- package/dist/apis/AuthenticationApi.d.ts +43 -1
- package/dist/apis/AuthenticationApi.js +112 -0
- package/dist/apis/ContainerNetworksApi.d.ts +123 -0
- package/dist/apis/ContainerNetworksApi.js +331 -0
- package/dist/apis/ContainersApi.d.ts +7 -4
- package/dist/apis/ContainersApi.js +13 -4
- package/dist/apis/EventsApi.d.ts +35 -0
- package/dist/apis/EventsApi.js +81 -0
- package/dist/apis/PermissionsApi.d.ts +18 -0
- package/dist/apis/PermissionsApi.js +46 -0
- package/dist/apis/SecretsApi.d.ts +38 -1
- package/dist/apis/SecretsApi.js +109 -0
- package/dist/apis/VolumesApi.d.ts +41 -7
- package/dist/apis/VolumesApi.js +102 -5
- package/dist/apis/index.d.ts +2 -0
- package/dist/apis/index.js +2 -0
- package/dist/models/BridgeNetwork.d.ts +72 -0
- package/dist/models/BridgeNetwork.js +67 -0
- package/dist/models/BridgeNetworkAttachment.d.ts +50 -0
- package/dist/models/BridgeNetworkAttachment.js +56 -0
- package/dist/models/BridgeNetworkDetails.d.ts +79 -0
- package/dist/models/BridgeNetworkDetails.js +72 -0
- package/dist/models/BridgeNetworkDriver.d.ts +25 -0
- package/dist/models/BridgeNetworkDriver.js +51 -0
- package/dist/models/ConnectBridgeNetworkRequest.d.ts +45 -0
- package/dist/models/ConnectBridgeNetworkRequest.js +54 -0
- package/dist/models/ContainerEvent.d.ts +82 -0
- package/dist/models/ContainerEvent.js +67 -0
- package/dist/models/ContainerEventKind.d.ts +27 -0
- package/dist/models/ContainerEventKind.js +53 -0
- package/dist/models/ContainerHealthInfo.d.ts +53 -0
- package/dist/models/ContainerHealthInfo.js +54 -0
- package/dist/models/ContainerInfo.d.ts +40 -0
- package/dist/models/ContainerInfo.js +13 -0
- package/dist/models/ContainerRestartKind.d.ts +27 -0
- package/dist/models/ContainerRestartKind.js +53 -0
- package/dist/models/ContainerRestartPolicy.d.ts +53 -0
- package/dist/models/ContainerRestartPolicy.js +55 -0
- package/dist/models/ContainerWaitResponse.d.ts +30 -2
- package/dist/models/ContainerWaitResponse.js +6 -0
- package/dist/models/CreateBridgeNetworkRequest.d.ts +60 -0
- package/dist/models/CreateBridgeNetworkRequest.js +59 -0
- package/dist/models/CreateContainerRequest.d.ts +77 -0
- package/dist/models/CreateContainerRequest.js +23 -0
- package/dist/models/CreateVolumeRequest.d.ts +54 -0
- package/dist/models/CreateVolumeRequest.js +56 -0
- package/dist/models/DisconnectBridgeNetworkRequest.d.ts +38 -0
- package/dist/models/DisconnectBridgeNetworkRequest.js +52 -0
- package/dist/models/HealthCheckRequest.d.ts +94 -0
- package/dist/models/HealthCheckRequest.js +66 -0
- package/dist/models/NetworkAttachmentInfo.d.ts +49 -0
- package/dist/models/NetworkAttachmentInfo.js +54 -0
- package/dist/models/NetworkAttachmentRequest.d.ts +51 -0
- package/dist/models/NetworkAttachmentRequest.js +54 -0
- package/dist/models/OidcCallbackResponse.d.ts +47 -0
- package/dist/models/OidcCallbackResponse.js +59 -0
- package/dist/models/OidcProviderPublic.d.ts +39 -0
- package/dist/models/OidcProviderPublic.js +54 -0
- package/dist/models/PortMapping.d.ts +55 -0
- package/dist/models/PortMapping.js +57 -0
- package/dist/models/PortProtocol.d.ts +25 -0
- package/dist/models/PortProtocol.js +51 -0
- package/dist/models/PullImageRequest.d.ts +18 -0
- package/dist/models/PullImageRequest.js +5 -0
- package/dist/models/RegistryAuth.d.ts +52 -0
- package/dist/models/RegistryAuth.js +57 -0
- package/dist/models/RegistryAuthType.d.ts +25 -0
- package/dist/models/RegistryAuthType.js +51 -0
- package/dist/models/RevealAllSecretsResponse.d.ts +41 -0
- package/dist/models/RevealAllSecretsResponse.js +54 -0
- package/dist/models/RotateSecretRequest.d.ts +32 -0
- package/dist/models/RotateSecretRequest.js +50 -0
- package/dist/models/RotateSecretResponse.d.ts +46 -0
- package/dist/models/RotateSecretResponse.js +56 -0
- package/dist/models/VolumeInfo.d.ts +70 -0
- package/dist/models/VolumeInfo.js +64 -0
- package/dist/models/VolumeMount.d.ts +16 -3
- package/dist/models/VolumeMount.js +4 -3
- package/dist/models/VolumeMountType.d.ts +30 -0
- package/dist/models/VolumeMountType.js +56 -0
- package/dist/models/VolumeSummary.d.ts +7 -4
- package/dist/models/index.d.ts +27 -0
- package/dist/models/index.js +27 -0
- package/docs/AddMemberRequest.md +1 -1
- package/docs/AuditApi.md +3 -3
- package/docs/AuditEntry.md +1 -1
- package/docs/AuthenticationApi.md +212 -18
- package/docs/BackendGroupInfo.md +1 -1
- package/docs/BackendInfo.md +1 -1
- package/docs/BackendsResponse.md +1 -1
- package/docs/BootstrapRequest.md +1 -1
- package/docs/BridgeNetwork.md +47 -0
- package/docs/BridgeNetworkAttachment.md +41 -0
- package/docs/BridgeNetworkDetails.md +49 -0
- package/docs/BridgeNetworkDriver.md +33 -0
- package/docs/BuildApi.md +21 -21
- package/docs/BuildKind.md +1 -1
- package/docs/BuildRequest.md +1 -1
- package/docs/BuildRequestWithContext.md +1 -1
- package/docs/BuildStateEnum.md +1 -1
- package/docs/BuildStatus.md +1 -1
- package/docs/BulkImportResponse.md +1 -1
- package/docs/CertInfo.md +1 -1
- package/docs/ClusterApi.md +12 -12
- package/docs/ClusterJoinRequest.md +1 -1
- package/docs/ClusterJoinResponse.md +1 -1
- package/docs/ClusterNodeSummary.md +1 -1
- package/docs/ClusterPeer.md +1 -1
- package/docs/ConnectBridgeNetworkRequest.md +39 -0
- package/docs/ContainerEvent.md +47 -0
- package/docs/ContainerEventKind.md +33 -0
- package/docs/ContainerExecRequest.md +1 -1
- package/docs/ContainerExecResponse.md +1 -1
- package/docs/ContainerHealthInfo.md +39 -0
- package/docs/ContainerInfo.md +11 -1
- package/docs/ContainerNetworksApi.md +466 -0
- package/docs/ContainerResourceLimits.md +1 -1
- package/docs/ContainerRestartKind.md +33 -0
- package/docs/ContainerRestartPolicy.md +39 -0
- package/docs/ContainerStatsResponse.md +1 -1
- package/docs/ContainerWaitResponse.md +8 -2
- package/docs/ContainersApi.md +51 -42
- package/docs/CreateBridgeNetworkRequest.md +43 -0
- package/docs/CreateContainerRequest.md +19 -1
- package/docs/CreateDeploymentRequest.md +1 -1
- package/docs/CreateEnvironmentRequest.md +1 -1
- package/docs/CreateGitCredentialRequest.md +1 -1
- package/docs/CreateGroupRequest.md +1 -1
- package/docs/CreateNodeTunnelRequest.md +1 -1
- package/docs/CreateNodeTunnelResponse.md +1 -1
- package/docs/CreateNotifierRequest.md +1 -1
- package/docs/CreateProjectRequest.md +1 -1
- package/docs/CreateRegistryCredentialRequest.md +1 -1
- package/docs/CreateSecretRequest.md +1 -1
- package/docs/CreateSyncRequest.md +1 -1
- package/docs/CreateTaskRequest.md +1 -1
- package/docs/CreateTunnelRequest.md +1 -1
- package/docs/CreateTunnelResponse.md +1 -1
- package/docs/CreateUserRequest.md +1 -1
- package/docs/CreateVariableRequest.md +1 -1
- package/docs/CreateVolumeRequest.md +41 -0
- package/docs/CreateWorkflowRequest.md +1 -1
- package/docs/CredentialsApi.md +18 -18
- package/docs/CronApi.md +15 -15
- package/docs/CronJobResponse.md +1 -1
- package/docs/CronStatusResponse.md +1 -1
- package/docs/CsrfResponse.md +1 -1
- package/docs/DeploymentDetails.md +1 -1
- package/docs/DeploymentSummary.md +1 -1
- package/docs/DeploymentsApi.md +12 -12
- package/docs/DisconnectBridgeNetworkRequest.md +37 -0
- package/docs/DnsStatusResponse.md +1 -1
- package/docs/EnvironmentsApi.md +15 -15
- package/docs/EventsApi.md +85 -0
- package/docs/ForceLeaderRequest.md +1 -1
- package/docs/ForceLeaderResponse.md +1 -1
- package/docs/GitCredentialKindSchema.md +1 -1
- package/docs/GitCredentialResponse.md +1 -1
- package/docs/GpuInfoSummary.md +1 -1
- package/docs/GpuUtilizationReport.md +1 -1
- package/docs/GrantPermissionRequest.md +1 -1
- package/docs/GroupMembersResponse.md +1 -1
- package/docs/GroupsApi.md +21 -21
- package/docs/HealthApi.md +6 -6
- package/docs/HealthCheckRequest.md +51 -0
- package/docs/HealthResponse.md +1 -1
- package/docs/HeartbeatRequest.md +1 -1
- package/docs/ImageInfoDto.md +1 -1
- package/docs/ImagesApi.md +15 -15
- package/docs/InternalApi.md +6 -6
- package/docs/InternalScaleRequest.md +1 -1
- package/docs/InternalScaleResponse.md +1 -1
- package/docs/IpAllocationResponse.md +1 -1
- package/docs/JobExecutionResponse.md +1 -1
- package/docs/JobsApi.md +12 -12
- package/docs/JoinTokenResponse.md +1 -1
- package/docs/KillContainerRequest.md +1 -1
- package/docs/LinkDeploymentRequest.md +1 -1
- package/docs/LoginRequest.md +1 -1
- package/docs/LoginResponse.md +1 -1
- package/docs/NetworkAttachmentInfo.md +39 -0
- package/docs/NetworkAttachmentRequest.md +39 -0
- package/docs/NetworkSummary.md +1 -1
- package/docs/NetworksApi.md +15 -15
- package/docs/NodeDetails.md +1 -1
- package/docs/NodeResourceInfo.md +1 -1
- package/docs/NodeSummary.md +1 -1
- package/docs/NodesApi.md +12 -12
- package/docs/NotifierConfig.md +1 -1
- package/docs/NotifierConfigOneOf.md +1 -1
- package/docs/NotifierConfigOneOf1.md +1 -1
- package/docs/NotifierConfigOneOf2.md +1 -1
- package/docs/NotifierConfigOneOf3.md +1 -1
- package/docs/NotifierKind.md +1 -1
- package/docs/NotifiersApi.md +18 -18
- package/docs/OidcCallbackResponse.md +39 -0
- package/docs/OidcProviderPublic.md +37 -0
- package/docs/OverlayApi.md +12 -12
- package/docs/OverlayStatusResponse.md +1 -1
- package/docs/PeerInfo.md +1 -1
- package/docs/PeerListResponse.md +1 -1
- package/docs/PermissionLevel.md +1 -1
- package/docs/PermissionsApi.md +80 -9
- package/docs/PortMapping.md +41 -0
- package/docs/PortProtocol.md +33 -0
- package/docs/ProjectPullResponse.md +1 -1
- package/docs/ProjectsApi.md +27 -27
- package/docs/ProxyApi.md +12 -12
- package/docs/PruneResultDto.md +1 -1
- package/docs/PullImageRequest.md +5 -1
- package/docs/PullImageResponse.md +1 -1
- package/docs/RegisteredServiceInfo.md +1 -1
- package/docs/RegistryAuth.md +39 -0
- package/docs/RegistryAuthType.md +33 -0
- package/docs/RegistryAuthTypeSchema.md +1 -1
- package/docs/RegistryCredentialResponse.md +1 -1
- package/docs/ReplicationInfo.md +1 -1
- package/docs/RestartContainerRequest.md +1 -1
- package/docs/RevealAllSecretsResponse.md +37 -0
- package/docs/RotateSecretRequest.md +35 -0
- package/docs/RotateSecretResponse.md +39 -0
- package/docs/RouteInfo.md +1 -1
- package/docs/RoutesResponse.md +1 -1
- package/docs/ScaleRequest.md +1 -1
- package/docs/SecretMetadataResponse.md +1 -1
- package/docs/SecretsApi.md +175 -15
- package/docs/ServiceDetails.md +1 -1
- package/docs/ServiceEndpoint.md +1 -1
- package/docs/ServiceHealthInfo.md +1 -1
- package/docs/ServiceMetrics.md +1 -1
- package/docs/ServiceSummary.md +1 -1
- package/docs/ServicesApi.md +12 -12
- package/docs/SetPasswordRequest.md +1 -1
- package/docs/StepResult.md +1 -1
- package/docs/StopContainerRequest.md +1 -1
- package/docs/StorageApi.md +3 -3
- package/docs/StorageStatusResponse.md +1 -1
- package/docs/StoredEnvironment.md +1 -1
- package/docs/StoredNotifier.md +1 -1
- package/docs/StoredPermission.md +1 -1
- package/docs/StoredProject.md +1 -1
- package/docs/StoredSync.md +1 -1
- package/docs/StoredTask.md +1 -1
- package/docs/StoredUserGroup.md +1 -1
- package/docs/StoredVariable.md +1 -1
- package/docs/StoredWorkflow.md +1 -1
- package/docs/StreamBackendInfo.md +1 -1
- package/docs/StreamInfo.md +1 -1
- package/docs/StreamsResponse.md +1 -1
- package/docs/SubjectKind.md +1 -1
- package/docs/SuccessResponse.md +1 -1
- package/docs/SyncApplyResponse.md +1 -1
- package/docs/SyncDiffResponse.md +1 -1
- package/docs/SyncResourceResponse.md +1 -1
- package/docs/SyncResourceResult.md +1 -1
- package/docs/SyncsApi.md +15 -15
- package/docs/TagImageRequest.md +1 -1
- package/docs/TaskKind.md +1 -1
- package/docs/TaskRun.md +1 -1
- package/docs/TasksApi.md +18 -18
- package/docs/TemplateInfo.md +1 -1
- package/docs/TestNotifierResponse.md +1 -1
- package/docs/TlsResponse.md +1 -1
- package/docs/TokenRequest.md +1 -1
- package/docs/TokenResponse.md +1 -1
- package/docs/TriggerBuildResponse.md +1 -1
- package/docs/TriggerCronResponse.md +1 -1
- package/docs/TriggerJobResponse.md +1 -1
- package/docs/TunnelStatus.md +1 -1
- package/docs/TunnelSummary.md +1 -1
- package/docs/TunnelsApi.md +18 -18
- package/docs/UpdateEnvironmentRequest.md +1 -1
- package/docs/UpdateGroupRequest.md +1 -1
- package/docs/UpdateLabelsRequest.md +1 -1
- package/docs/UpdateLabelsResponse.md +1 -1
- package/docs/UpdateNotifierRequest.md +1 -1
- package/docs/UpdateProjectRequest.md +1 -1
- package/docs/UpdateUserRequest.md +1 -1
- package/docs/UpdateVariableRequest.md +1 -1
- package/docs/UserRole.md +1 -1
- package/docs/UserView.md +1 -1
- package/docs/UsersApi.md +18 -18
- package/docs/VariablesApi.md +15 -15
- package/docs/VolumeInfo.md +45 -0
- package/docs/VolumeMount.md +4 -2
- package/docs/VolumeMountType.md +33 -0
- package/docs/VolumeSummary.md +2 -2
- package/docs/VolumesApi.md +163 -13
- package/docs/WebhookInfoResponse.md +1 -1
- package/docs/WebhookResponse.md +1 -1
- package/docs/WebhooksApi.md +9 -9
- package/docs/WorkflowAction.md +1 -1
- package/docs/WorkflowActionOneOf.md +1 -1
- package/docs/WorkflowActionOneOf1.md +1 -1
- package/docs/WorkflowActionOneOf2.md +1 -1
- package/docs/WorkflowActionOneOf3.md +1 -1
- package/docs/WorkflowRun.md +1 -1
- package/docs/WorkflowRunStatus.md +1 -1
- package/docs/WorkflowStep.md +1 -1
- package/docs/WorkflowsApi.md +18 -18
- package/package.json +1 -1
- package/src/apis/AuthenticationApi.ts +140 -0
- package/src/apis/ContainerNetworksApi.ts +418 -0
- package/src/apis/ContainersApi.ts +19 -4
- package/src/apis/EventsApi.ts +82 -0
- package/src/apis/PermissionsApi.ts +59 -0
- package/src/apis/SecretsApi.ts +151 -0
- package/src/apis/VolumesApi.ts +133 -10
- package/src/apis/index.ts +2 -0
- package/src/models/BridgeNetwork.ts +127 -0
- package/src/models/BridgeNetworkAttachment.ts +90 -0
- package/src/models/BridgeNetworkDetails.ts +143 -0
- package/src/models/BridgeNetworkDriver.ts +53 -0
- package/src/models/ConnectBridgeNetworkRequest.ts +83 -0
- package/src/models/ContainerEvent.ts +137 -0
- package/src/models/ContainerEventKind.ts +55 -0
- package/src/models/ContainerHealthInfo.ts +91 -0
- package/src/models/ContainerInfo.ts +69 -0
- package/src/models/ContainerRestartKind.ts +55 -0
- package/src/models/ContainerRestartPolicy.ts +100 -0
- package/src/models/ContainerWaitResponse.ts +36 -2
- package/src/models/CreateBridgeNetworkRequest.ts +109 -0
- package/src/models/CreateContainerRequest.ts +125 -0
- package/src/models/CreateVolumeRequest.ts +92 -0
- package/src/models/DisconnectBridgeNetworkRequest.ts +74 -0
- package/src/models/HealthCheckRequest.ts +144 -0
- package/src/models/NetworkAttachmentInfo.ts +87 -0
- package/src/models/NetworkAttachmentRequest.ts +89 -0
- package/src/models/OidcCallbackResponse.ts +94 -0
- package/src/models/OidcProviderPublic.ts +76 -0
- package/src/models/PortMapping.ts +104 -0
- package/src/models/PortProtocol.ts +53 -0
- package/src/models/PullImageRequest.ts +29 -0
- package/src/models/RegistryAuth.ts +100 -0
- package/src/models/RegistryAuthType.ts +53 -0
- package/src/models/RevealAllSecretsResponse.ts +76 -0
- package/src/models/RotateSecretRequest.ts +66 -0
- package/src/models/RotateSecretResponse.ts +85 -0
- package/src/models/VolumeInfo.ts +114 -0
- package/src/models/VolumeMount.ts +28 -5
- package/src/models/VolumeMountType.ts +58 -0
- package/src/models/VolumeSummary.ts +7 -4
- package/src/models/index.ts +27 -0
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* ZLayer API
|
|
3
|
+
* Container orchestration API for ZLayer
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 0.1.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* Volume mount kind discriminator.
|
|
14
|
+
*
|
|
15
|
+
* Selects which [`zlayer_spec::StorageSpec`] variant [`VolumeMount`] is
|
|
16
|
+
* translated into by [`build_service_spec`]. When omitted on the wire,
|
|
17
|
+
* defaults to [`VolumeMountType::Bind`] (legacy behavior).
|
|
18
|
+
* @export
|
|
19
|
+
*/
|
|
20
|
+
export declare const VolumeMountType: {
|
|
21
|
+
readonly Bind: "bind";
|
|
22
|
+
readonly Volume: "volume";
|
|
23
|
+
readonly Tmpfs: "tmpfs";
|
|
24
|
+
};
|
|
25
|
+
export type VolumeMountType = typeof VolumeMountType[keyof typeof VolumeMountType];
|
|
26
|
+
export declare function instanceOfVolumeMountType(value: any): boolean;
|
|
27
|
+
export declare function VolumeMountTypeFromJSON(json: any): VolumeMountType;
|
|
28
|
+
export declare function VolumeMountTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): VolumeMountType;
|
|
29
|
+
export declare function VolumeMountTypeToJSON(value?: VolumeMountType | null): any;
|
|
30
|
+
export declare function VolumeMountTypeToJSONTyped(value: any, ignoreDiscriminator: boolean): VolumeMountType;
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* ZLayer API
|
|
6
|
+
* Container orchestration API for ZLayer
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 0.1.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.VolumeMountType = void 0;
|
|
17
|
+
exports.instanceOfVolumeMountType = instanceOfVolumeMountType;
|
|
18
|
+
exports.VolumeMountTypeFromJSON = VolumeMountTypeFromJSON;
|
|
19
|
+
exports.VolumeMountTypeFromJSONTyped = VolumeMountTypeFromJSONTyped;
|
|
20
|
+
exports.VolumeMountTypeToJSON = VolumeMountTypeToJSON;
|
|
21
|
+
exports.VolumeMountTypeToJSONTyped = VolumeMountTypeToJSONTyped;
|
|
22
|
+
/**
|
|
23
|
+
* Volume mount kind discriminator.
|
|
24
|
+
*
|
|
25
|
+
* Selects which [`zlayer_spec::StorageSpec`] variant [`VolumeMount`] is
|
|
26
|
+
* translated into by [`build_service_spec`]. When omitted on the wire,
|
|
27
|
+
* defaults to [`VolumeMountType::Bind`] (legacy behavior).
|
|
28
|
+
* @export
|
|
29
|
+
*/
|
|
30
|
+
exports.VolumeMountType = {
|
|
31
|
+
Bind: 'bind',
|
|
32
|
+
Volume: 'volume',
|
|
33
|
+
Tmpfs: 'tmpfs'
|
|
34
|
+
};
|
|
35
|
+
function instanceOfVolumeMountType(value) {
|
|
36
|
+
for (const key in exports.VolumeMountType) {
|
|
37
|
+
if (Object.prototype.hasOwnProperty.call(exports.VolumeMountType, key)) {
|
|
38
|
+
if (exports.VolumeMountType[key] === value) {
|
|
39
|
+
return true;
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
return false;
|
|
44
|
+
}
|
|
45
|
+
function VolumeMountTypeFromJSON(json) {
|
|
46
|
+
return VolumeMountTypeFromJSONTyped(json, false);
|
|
47
|
+
}
|
|
48
|
+
function VolumeMountTypeFromJSONTyped(json, ignoreDiscriminator) {
|
|
49
|
+
return json;
|
|
50
|
+
}
|
|
51
|
+
function VolumeMountTypeToJSON(value) {
|
|
52
|
+
return value;
|
|
53
|
+
}
|
|
54
|
+
function VolumeMountTypeToJSONTyped(value, ignoreDiscriminator) {
|
|
55
|
+
return value;
|
|
56
|
+
}
|
|
@@ -10,25 +10,28 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
/**
|
|
13
|
-
*
|
|
13
|
+
* Legacy response shape kept for backwards compatibility with older SDK
|
|
14
|
+
* consumers that deserialize strictly. New consumers should use
|
|
15
|
+
* [`VolumeInfo`]. `list_volumes` now returns [`VolumeInfo`] which is a
|
|
16
|
+
* strict superset of the fields in `VolumeSummary`.
|
|
14
17
|
* @export
|
|
15
18
|
* @interface VolumeSummary
|
|
16
19
|
*/
|
|
17
20
|
export interface VolumeSummary {
|
|
18
21
|
/**
|
|
19
|
-
* Volume name (directory name)
|
|
22
|
+
* Volume name (directory name).
|
|
20
23
|
* @type {string}
|
|
21
24
|
* @memberof VolumeSummary
|
|
22
25
|
*/
|
|
23
26
|
name: string;
|
|
24
27
|
/**
|
|
25
|
-
* Host filesystem path
|
|
28
|
+
* Host filesystem path.
|
|
26
29
|
* @type {string}
|
|
27
30
|
* @memberof VolumeSummary
|
|
28
31
|
*/
|
|
29
32
|
path: string;
|
|
30
33
|
/**
|
|
31
|
-
* Approximate size in bytes
|
|
34
|
+
* Approximate size in bytes.
|
|
32
35
|
* @type {number}
|
|
33
36
|
* @memberof VolumeSummary
|
|
34
37
|
*/
|
package/dist/models/index.d.ts
CHANGED
|
@@ -4,6 +4,10 @@ export * from './BackendGroupInfo';
|
|
|
4
4
|
export * from './BackendInfo';
|
|
5
5
|
export * from './BackendsResponse';
|
|
6
6
|
export * from './BootstrapRequest';
|
|
7
|
+
export * from './BridgeNetwork';
|
|
8
|
+
export * from './BridgeNetworkAttachment';
|
|
9
|
+
export * from './BridgeNetworkDetails';
|
|
10
|
+
export * from './BridgeNetworkDriver';
|
|
7
11
|
export * from './BuildKind';
|
|
8
12
|
export * from './BuildRequest';
|
|
9
13
|
export * from './BuildRequestWithContext';
|
|
@@ -15,12 +19,19 @@ export * from './ClusterJoinRequest';
|
|
|
15
19
|
export * from './ClusterJoinResponse';
|
|
16
20
|
export * from './ClusterNodeSummary';
|
|
17
21
|
export * from './ClusterPeer';
|
|
22
|
+
export * from './ConnectBridgeNetworkRequest';
|
|
23
|
+
export * from './ContainerEvent';
|
|
24
|
+
export * from './ContainerEventKind';
|
|
18
25
|
export * from './ContainerExecRequest';
|
|
19
26
|
export * from './ContainerExecResponse';
|
|
27
|
+
export * from './ContainerHealthInfo';
|
|
20
28
|
export * from './ContainerInfo';
|
|
21
29
|
export * from './ContainerResourceLimits';
|
|
30
|
+
export * from './ContainerRestartKind';
|
|
31
|
+
export * from './ContainerRestartPolicy';
|
|
22
32
|
export * from './ContainerStatsResponse';
|
|
23
33
|
export * from './ContainerWaitResponse';
|
|
34
|
+
export * from './CreateBridgeNetworkRequest';
|
|
24
35
|
export * from './CreateContainerRequest';
|
|
25
36
|
export * from './CreateDeploymentRequest';
|
|
26
37
|
export * from './CreateEnvironmentRequest';
|
|
@@ -38,12 +49,14 @@ export * from './CreateTunnelRequest';
|
|
|
38
49
|
export * from './CreateTunnelResponse';
|
|
39
50
|
export * from './CreateUserRequest';
|
|
40
51
|
export * from './CreateVariableRequest';
|
|
52
|
+
export * from './CreateVolumeRequest';
|
|
41
53
|
export * from './CreateWorkflowRequest';
|
|
42
54
|
export * from './CronJobResponse';
|
|
43
55
|
export * from './CronStatusResponse';
|
|
44
56
|
export * from './CsrfResponse';
|
|
45
57
|
export * from './DeploymentDetails';
|
|
46
58
|
export * from './DeploymentSummary';
|
|
59
|
+
export * from './DisconnectBridgeNetworkRequest';
|
|
47
60
|
export * from './DnsStatusResponse';
|
|
48
61
|
export * from './ForceLeaderRequest';
|
|
49
62
|
export * from './ForceLeaderResponse';
|
|
@@ -53,6 +66,7 @@ export * from './GpuInfoSummary';
|
|
|
53
66
|
export * from './GpuUtilizationReport';
|
|
54
67
|
export * from './GrantPermissionRequest';
|
|
55
68
|
export * from './GroupMembersResponse';
|
|
69
|
+
export * from './HealthCheckRequest';
|
|
56
70
|
export * from './HealthResponse';
|
|
57
71
|
export * from './HeartbeatRequest';
|
|
58
72
|
export * from './ImageInfoDto';
|
|
@@ -65,6 +79,8 @@ export * from './KillContainerRequest';
|
|
|
65
79
|
export * from './LinkDeploymentRequest';
|
|
66
80
|
export * from './LoginRequest';
|
|
67
81
|
export * from './LoginResponse';
|
|
82
|
+
export * from './NetworkAttachmentInfo';
|
|
83
|
+
export * from './NetworkAttachmentRequest';
|
|
68
84
|
export * from './NetworkSummary';
|
|
69
85
|
export * from './NodeDetails';
|
|
70
86
|
export * from './NodeResourceInfo';
|
|
@@ -75,19 +91,28 @@ export * from './NotifierConfigOneOf1';
|
|
|
75
91
|
export * from './NotifierConfigOneOf2';
|
|
76
92
|
export * from './NotifierConfigOneOf3';
|
|
77
93
|
export * from './NotifierKind';
|
|
94
|
+
export * from './OidcCallbackResponse';
|
|
95
|
+
export * from './OidcProviderPublic';
|
|
78
96
|
export * from './OverlayStatusResponse';
|
|
79
97
|
export * from './PeerInfo';
|
|
80
98
|
export * from './PeerListResponse';
|
|
81
99
|
export * from './PermissionLevel';
|
|
100
|
+
export * from './PortMapping';
|
|
101
|
+
export * from './PortProtocol';
|
|
82
102
|
export * from './ProjectPullResponse';
|
|
83
103
|
export * from './PruneResultDto';
|
|
84
104
|
export * from './PullImageRequest';
|
|
85
105
|
export * from './PullImageResponse';
|
|
86
106
|
export * from './RegisteredServiceInfo';
|
|
107
|
+
export * from './RegistryAuth';
|
|
108
|
+
export * from './RegistryAuthType';
|
|
87
109
|
export * from './RegistryAuthTypeSchema';
|
|
88
110
|
export * from './RegistryCredentialResponse';
|
|
89
111
|
export * from './ReplicationInfo';
|
|
90
112
|
export * from './RestartContainerRequest';
|
|
113
|
+
export * from './RevealAllSecretsResponse';
|
|
114
|
+
export * from './RotateSecretRequest';
|
|
115
|
+
export * from './RotateSecretResponse';
|
|
91
116
|
export * from './RouteInfo';
|
|
92
117
|
export * from './RoutesResponse';
|
|
93
118
|
export * from './ScaleRequest';
|
|
@@ -142,7 +167,9 @@ export * from './UpdateUserRequest';
|
|
|
142
167
|
export * from './UpdateVariableRequest';
|
|
143
168
|
export * from './UserRole';
|
|
144
169
|
export * from './UserView';
|
|
170
|
+
export * from './VolumeInfo';
|
|
145
171
|
export * from './VolumeMount';
|
|
172
|
+
export * from './VolumeMountType';
|
|
146
173
|
export * from './VolumeSummary';
|
|
147
174
|
export * from './WebhookInfoResponse';
|
|
148
175
|
export * from './WebhookResponse';
|
package/dist/models/index.js
CHANGED
|
@@ -22,6 +22,10 @@ __exportStar(require("./BackendGroupInfo"), exports);
|
|
|
22
22
|
__exportStar(require("./BackendInfo"), exports);
|
|
23
23
|
__exportStar(require("./BackendsResponse"), exports);
|
|
24
24
|
__exportStar(require("./BootstrapRequest"), exports);
|
|
25
|
+
__exportStar(require("./BridgeNetwork"), exports);
|
|
26
|
+
__exportStar(require("./BridgeNetworkAttachment"), exports);
|
|
27
|
+
__exportStar(require("./BridgeNetworkDetails"), exports);
|
|
28
|
+
__exportStar(require("./BridgeNetworkDriver"), exports);
|
|
25
29
|
__exportStar(require("./BuildKind"), exports);
|
|
26
30
|
__exportStar(require("./BuildRequest"), exports);
|
|
27
31
|
__exportStar(require("./BuildRequestWithContext"), exports);
|
|
@@ -33,12 +37,19 @@ __exportStar(require("./ClusterJoinRequest"), exports);
|
|
|
33
37
|
__exportStar(require("./ClusterJoinResponse"), exports);
|
|
34
38
|
__exportStar(require("./ClusterNodeSummary"), exports);
|
|
35
39
|
__exportStar(require("./ClusterPeer"), exports);
|
|
40
|
+
__exportStar(require("./ConnectBridgeNetworkRequest"), exports);
|
|
41
|
+
__exportStar(require("./ContainerEvent"), exports);
|
|
42
|
+
__exportStar(require("./ContainerEventKind"), exports);
|
|
36
43
|
__exportStar(require("./ContainerExecRequest"), exports);
|
|
37
44
|
__exportStar(require("./ContainerExecResponse"), exports);
|
|
45
|
+
__exportStar(require("./ContainerHealthInfo"), exports);
|
|
38
46
|
__exportStar(require("./ContainerInfo"), exports);
|
|
39
47
|
__exportStar(require("./ContainerResourceLimits"), exports);
|
|
48
|
+
__exportStar(require("./ContainerRestartKind"), exports);
|
|
49
|
+
__exportStar(require("./ContainerRestartPolicy"), exports);
|
|
40
50
|
__exportStar(require("./ContainerStatsResponse"), exports);
|
|
41
51
|
__exportStar(require("./ContainerWaitResponse"), exports);
|
|
52
|
+
__exportStar(require("./CreateBridgeNetworkRequest"), exports);
|
|
42
53
|
__exportStar(require("./CreateContainerRequest"), exports);
|
|
43
54
|
__exportStar(require("./CreateDeploymentRequest"), exports);
|
|
44
55
|
__exportStar(require("./CreateEnvironmentRequest"), exports);
|
|
@@ -56,12 +67,14 @@ __exportStar(require("./CreateTunnelRequest"), exports);
|
|
|
56
67
|
__exportStar(require("./CreateTunnelResponse"), exports);
|
|
57
68
|
__exportStar(require("./CreateUserRequest"), exports);
|
|
58
69
|
__exportStar(require("./CreateVariableRequest"), exports);
|
|
70
|
+
__exportStar(require("./CreateVolumeRequest"), exports);
|
|
59
71
|
__exportStar(require("./CreateWorkflowRequest"), exports);
|
|
60
72
|
__exportStar(require("./CronJobResponse"), exports);
|
|
61
73
|
__exportStar(require("./CronStatusResponse"), exports);
|
|
62
74
|
__exportStar(require("./CsrfResponse"), exports);
|
|
63
75
|
__exportStar(require("./DeploymentDetails"), exports);
|
|
64
76
|
__exportStar(require("./DeploymentSummary"), exports);
|
|
77
|
+
__exportStar(require("./DisconnectBridgeNetworkRequest"), exports);
|
|
65
78
|
__exportStar(require("./DnsStatusResponse"), exports);
|
|
66
79
|
__exportStar(require("./ForceLeaderRequest"), exports);
|
|
67
80
|
__exportStar(require("./ForceLeaderResponse"), exports);
|
|
@@ -71,6 +84,7 @@ __exportStar(require("./GpuInfoSummary"), exports);
|
|
|
71
84
|
__exportStar(require("./GpuUtilizationReport"), exports);
|
|
72
85
|
__exportStar(require("./GrantPermissionRequest"), exports);
|
|
73
86
|
__exportStar(require("./GroupMembersResponse"), exports);
|
|
87
|
+
__exportStar(require("./HealthCheckRequest"), exports);
|
|
74
88
|
__exportStar(require("./HealthResponse"), exports);
|
|
75
89
|
__exportStar(require("./HeartbeatRequest"), exports);
|
|
76
90
|
__exportStar(require("./ImageInfoDto"), exports);
|
|
@@ -83,6 +97,8 @@ __exportStar(require("./KillContainerRequest"), exports);
|
|
|
83
97
|
__exportStar(require("./LinkDeploymentRequest"), exports);
|
|
84
98
|
__exportStar(require("./LoginRequest"), exports);
|
|
85
99
|
__exportStar(require("./LoginResponse"), exports);
|
|
100
|
+
__exportStar(require("./NetworkAttachmentInfo"), exports);
|
|
101
|
+
__exportStar(require("./NetworkAttachmentRequest"), exports);
|
|
86
102
|
__exportStar(require("./NetworkSummary"), exports);
|
|
87
103
|
__exportStar(require("./NodeDetails"), exports);
|
|
88
104
|
__exportStar(require("./NodeResourceInfo"), exports);
|
|
@@ -93,19 +109,28 @@ __exportStar(require("./NotifierConfigOneOf1"), exports);
|
|
|
93
109
|
__exportStar(require("./NotifierConfigOneOf2"), exports);
|
|
94
110
|
__exportStar(require("./NotifierConfigOneOf3"), exports);
|
|
95
111
|
__exportStar(require("./NotifierKind"), exports);
|
|
112
|
+
__exportStar(require("./OidcCallbackResponse"), exports);
|
|
113
|
+
__exportStar(require("./OidcProviderPublic"), exports);
|
|
96
114
|
__exportStar(require("./OverlayStatusResponse"), exports);
|
|
97
115
|
__exportStar(require("./PeerInfo"), exports);
|
|
98
116
|
__exportStar(require("./PeerListResponse"), exports);
|
|
99
117
|
__exportStar(require("./PermissionLevel"), exports);
|
|
118
|
+
__exportStar(require("./PortMapping"), exports);
|
|
119
|
+
__exportStar(require("./PortProtocol"), exports);
|
|
100
120
|
__exportStar(require("./ProjectPullResponse"), exports);
|
|
101
121
|
__exportStar(require("./PruneResultDto"), exports);
|
|
102
122
|
__exportStar(require("./PullImageRequest"), exports);
|
|
103
123
|
__exportStar(require("./PullImageResponse"), exports);
|
|
104
124
|
__exportStar(require("./RegisteredServiceInfo"), exports);
|
|
125
|
+
__exportStar(require("./RegistryAuth"), exports);
|
|
126
|
+
__exportStar(require("./RegistryAuthType"), exports);
|
|
105
127
|
__exportStar(require("./RegistryAuthTypeSchema"), exports);
|
|
106
128
|
__exportStar(require("./RegistryCredentialResponse"), exports);
|
|
107
129
|
__exportStar(require("./ReplicationInfo"), exports);
|
|
108
130
|
__exportStar(require("./RestartContainerRequest"), exports);
|
|
131
|
+
__exportStar(require("./RevealAllSecretsResponse"), exports);
|
|
132
|
+
__exportStar(require("./RotateSecretRequest"), exports);
|
|
133
|
+
__exportStar(require("./RotateSecretResponse"), exports);
|
|
109
134
|
__exportStar(require("./RouteInfo"), exports);
|
|
110
135
|
__exportStar(require("./RoutesResponse"), exports);
|
|
111
136
|
__exportStar(require("./ScaleRequest"), exports);
|
|
@@ -160,7 +185,9 @@ __exportStar(require("./UpdateUserRequest"), exports);
|
|
|
160
185
|
__exportStar(require("./UpdateVariableRequest"), exports);
|
|
161
186
|
__exportStar(require("./UserRole"), exports);
|
|
162
187
|
__exportStar(require("./UserView"), exports);
|
|
188
|
+
__exportStar(require("./VolumeInfo"), exports);
|
|
163
189
|
__exportStar(require("./VolumeMount"), exports);
|
|
190
|
+
__exportStar(require("./VolumeMountType"), exports);
|
|
164
191
|
__exportStar(require("./VolumeSummary"), exports);
|
|
165
192
|
__exportStar(require("./WebhookInfoResponse"), exports);
|
|
166
193
|
__exportStar(require("./WebhookResponse"), exports);
|
package/docs/AddMemberRequest.md
CHANGED
package/docs/AuditApi.md
CHANGED
|
@@ -22,11 +22,11 @@ List audit log entries. Admin only.
|
|
|
22
22
|
import {
|
|
23
23
|
Configuration,
|
|
24
24
|
AuditApi,
|
|
25
|
-
} from '@zlayer/client';
|
|
26
|
-
import type { ListAuditRequest } from '@zlayer/client';
|
|
25
|
+
} from '@zlayer/api-client';
|
|
26
|
+
import type { ListAuditRequest } from '@zlayer/api-client';
|
|
27
27
|
|
|
28
28
|
async function example() {
|
|
29
|
-
console.log("🚀 Testing @zlayer/client SDK...");
|
|
29
|
+
console.log("🚀 Testing @zlayer/api-client SDK...");
|
|
30
30
|
const api = new AuditApi();
|
|
31
31
|
|
|
32
32
|
const body = {
|
package/docs/AuditEntry.md
CHANGED
|
@@ -5,11 +5,14 @@ All URIs are relative to *http://localhost*
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
| [**bootstrap**](AuthenticationApi.md#bootstrapoperation) | **POST** /auth/bootstrap | Bootstrap the very first admin user. Returns 409 if any user exists. |
|
|
8
|
+
| [**callback**](AuthenticationApi.md#callback) | **GET** /auth/oidc/{provider}/callback | `GET /auth/oidc/:provider/callback`. |
|
|
8
9
|
| [**csrf**](AuthenticationApi.md#csrf) | **GET** /auth/csrf | Rotate the CSRF double-submit token for the current session. |
|
|
9
10
|
| [**getToken**](AuthenticationApi.md#gettoken) | **POST** /auth/token | Get an access token. |
|
|
11
|
+
| [**listProviders**](AuthenticationApi.md#listproviders) | **GET** /auth/oidc/providers | `GET /auth/oidc/providers`. |
|
|
10
12
|
| [**login**](AuthenticationApi.md#loginoperation) | **POST** /auth/login | Sign in an existing user. |
|
|
11
13
|
| [**logout**](AuthenticationApi.md#logout) | **POST** /auth/logout | Clear the session + CSRF cookies. |
|
|
12
14
|
| [**me**](AuthenticationApi.md#me) | **GET** /auth/me | Return the currently signed-in user. |
|
|
15
|
+
| [**start**](AuthenticationApi.md#start) | **GET** /auth/oidc/{provider}/start | `GET /auth/oidc/:provider/start` — 302 to the provider\'s authorize URL. |
|
|
13
16
|
|
|
14
17
|
|
|
15
18
|
|
|
@@ -27,11 +30,11 @@ Bootstrap the very first admin user. Returns 409 if any user exists.
|
|
|
27
30
|
import {
|
|
28
31
|
Configuration,
|
|
29
32
|
AuthenticationApi,
|
|
30
|
-
} from '@zlayer/client';
|
|
31
|
-
import type { BootstrapOperationRequest } from '@zlayer/client';
|
|
33
|
+
} from '@zlayer/api-client';
|
|
34
|
+
import type { BootstrapOperationRequest } from '@zlayer/api-client';
|
|
32
35
|
|
|
33
36
|
async function example() {
|
|
34
|
-
console.log("🚀 Testing @zlayer/client SDK...");
|
|
37
|
+
console.log("🚀 Testing @zlayer/api-client SDK...");
|
|
35
38
|
const api = new AuthenticationApi();
|
|
36
39
|
|
|
37
40
|
const body = {
|
|
@@ -83,6 +86,74 @@ No authorization required
|
|
|
83
86
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
84
87
|
|
|
85
88
|
|
|
89
|
+
## callback
|
|
90
|
+
|
|
91
|
+
> OidcCallbackResponse callback(provider)
|
|
92
|
+
|
|
93
|
+
`GET /auth/oidc/:provider/callback`.
|
|
94
|
+
|
|
95
|
+
### Example
|
|
96
|
+
|
|
97
|
+
```ts
|
|
98
|
+
import {
|
|
99
|
+
Configuration,
|
|
100
|
+
AuthenticationApi,
|
|
101
|
+
} from '@zlayer/api-client';
|
|
102
|
+
import type { CallbackRequest } from '@zlayer/api-client';
|
|
103
|
+
|
|
104
|
+
async function example() {
|
|
105
|
+
console.log("🚀 Testing @zlayer/api-client SDK...");
|
|
106
|
+
const api = new AuthenticationApi();
|
|
107
|
+
|
|
108
|
+
const body = {
|
|
109
|
+
// string | Provider slug
|
|
110
|
+
provider: provider_example,
|
|
111
|
+
} satisfies CallbackRequest;
|
|
112
|
+
|
|
113
|
+
try {
|
|
114
|
+
const data = await api.callback(body);
|
|
115
|
+
console.log(data);
|
|
116
|
+
} catch (error) {
|
|
117
|
+
console.error(error);
|
|
118
|
+
}
|
|
119
|
+
}
|
|
120
|
+
|
|
121
|
+
// Run the test
|
|
122
|
+
example().catch(console.error);
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
### Parameters
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
| Name | Type | Description | Notes |
|
|
129
|
+
|------------- | ------------- | ------------- | -------------|
|
|
130
|
+
| **provider** | `string` | Provider slug | [Defaults to `undefined`] |
|
|
131
|
+
|
|
132
|
+
### Return type
|
|
133
|
+
|
|
134
|
+
[**OidcCallbackResponse**](OidcCallbackResponse.md)
|
|
135
|
+
|
|
136
|
+
### Authorization
|
|
137
|
+
|
|
138
|
+
No authorization required
|
|
139
|
+
|
|
140
|
+
### HTTP request headers
|
|
141
|
+
|
|
142
|
+
- **Content-Type**: Not defined
|
|
143
|
+
- **Accept**: `application/json`
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
### HTTP response details
|
|
147
|
+
| Status code | Description | Response headers |
|
|
148
|
+
|-------------|-------------|------------------|
|
|
149
|
+
| **200** | Signed in via OIDC | - |
|
|
150
|
+
| **400** | Invalid callback parameters | - |
|
|
151
|
+
| **401** | Provider returned an error | - |
|
|
152
|
+
| **404** | Unknown provider | - |
|
|
153
|
+
|
|
154
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
155
|
+
|
|
156
|
+
|
|
86
157
|
## csrf
|
|
87
158
|
|
|
88
159
|
> CsrfResponse csrf()
|
|
@@ -95,11 +166,11 @@ Rotate the CSRF double-submit token for the current session.
|
|
|
95
166
|
import {
|
|
96
167
|
Configuration,
|
|
97
168
|
AuthenticationApi,
|
|
98
|
-
} from '@zlayer/client';
|
|
99
|
-
import type { CsrfRequest } from '@zlayer/client';
|
|
169
|
+
} from '@zlayer/api-client';
|
|
170
|
+
import type { CsrfRequest } from '@zlayer/api-client';
|
|
100
171
|
|
|
101
172
|
async function example() {
|
|
102
|
-
console.log("🚀 Testing @zlayer/client SDK...");
|
|
173
|
+
console.log("🚀 Testing @zlayer/api-client SDK...");
|
|
103
174
|
const api = new AuthenticationApi();
|
|
104
175
|
|
|
105
176
|
try {
|
|
@@ -154,11 +225,11 @@ Get an access token.
|
|
|
154
225
|
import {
|
|
155
226
|
Configuration,
|
|
156
227
|
AuthenticationApi,
|
|
157
|
-
} from '@zlayer/client';
|
|
158
|
-
import type { GetTokenRequest } from '@zlayer/client';
|
|
228
|
+
} from '@zlayer/api-client';
|
|
229
|
+
import type { GetTokenRequest } from '@zlayer/api-client';
|
|
159
230
|
|
|
160
231
|
async function example() {
|
|
161
|
-
console.log("🚀 Testing @zlayer/client SDK...");
|
|
232
|
+
console.log("🚀 Testing @zlayer/api-client SDK...");
|
|
162
233
|
const api = new AuthenticationApi();
|
|
163
234
|
|
|
164
235
|
const body = {
|
|
@@ -208,6 +279,63 @@ No authorization required
|
|
|
208
279
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
209
280
|
|
|
210
281
|
|
|
282
|
+
## listProviders
|
|
283
|
+
|
|
284
|
+
> Array<OidcProviderPublic> listProviders()
|
|
285
|
+
|
|
286
|
+
`GET /auth/oidc/providers`.
|
|
287
|
+
|
|
288
|
+
### Example
|
|
289
|
+
|
|
290
|
+
```ts
|
|
291
|
+
import {
|
|
292
|
+
Configuration,
|
|
293
|
+
AuthenticationApi,
|
|
294
|
+
} from '@zlayer/api-client';
|
|
295
|
+
import type { ListProvidersRequest } from '@zlayer/api-client';
|
|
296
|
+
|
|
297
|
+
async function example() {
|
|
298
|
+
console.log("🚀 Testing @zlayer/api-client SDK...");
|
|
299
|
+
const api = new AuthenticationApi();
|
|
300
|
+
|
|
301
|
+
try {
|
|
302
|
+
const data = await api.listProviders();
|
|
303
|
+
console.log(data);
|
|
304
|
+
} catch (error) {
|
|
305
|
+
console.error(error);
|
|
306
|
+
}
|
|
307
|
+
}
|
|
308
|
+
|
|
309
|
+
// Run the test
|
|
310
|
+
example().catch(console.error);
|
|
311
|
+
```
|
|
312
|
+
|
|
313
|
+
### Parameters
|
|
314
|
+
|
|
315
|
+
This endpoint does not need any parameter.
|
|
316
|
+
|
|
317
|
+
### Return type
|
|
318
|
+
|
|
319
|
+
[**Array<OidcProviderPublic>**](OidcProviderPublic.md)
|
|
320
|
+
|
|
321
|
+
### Authorization
|
|
322
|
+
|
|
323
|
+
No authorization required
|
|
324
|
+
|
|
325
|
+
### HTTP request headers
|
|
326
|
+
|
|
327
|
+
- **Content-Type**: Not defined
|
|
328
|
+
- **Accept**: `application/json`
|
|
329
|
+
|
|
330
|
+
|
|
331
|
+
### HTTP response details
|
|
332
|
+
| Status code | Description | Response headers |
|
|
333
|
+
|-------------|-------------|------------------|
|
|
334
|
+
| **200** | List of configured OIDC providers | - |
|
|
335
|
+
|
|
336
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
337
|
+
|
|
338
|
+
|
|
211
339
|
## login
|
|
212
340
|
|
|
213
341
|
> LoginResponse login(loginRequest)
|
|
@@ -222,11 +350,11 @@ Sign in an existing user.
|
|
|
222
350
|
import {
|
|
223
351
|
Configuration,
|
|
224
352
|
AuthenticationApi,
|
|
225
|
-
} from '@zlayer/client';
|
|
226
|
-
import type { LoginOperationRequest } from '@zlayer/client';
|
|
353
|
+
} from '@zlayer/api-client';
|
|
354
|
+
import type { LoginOperationRequest } from '@zlayer/api-client';
|
|
227
355
|
|
|
228
356
|
async function example() {
|
|
229
|
-
console.log("🚀 Testing @zlayer/client SDK...");
|
|
357
|
+
console.log("🚀 Testing @zlayer/api-client SDK...");
|
|
230
358
|
const api = new AuthenticationApi();
|
|
231
359
|
|
|
232
360
|
const body = {
|
|
@@ -289,11 +417,11 @@ Clear the session + CSRF cookies.
|
|
|
289
417
|
import {
|
|
290
418
|
Configuration,
|
|
291
419
|
AuthenticationApi,
|
|
292
|
-
} from '@zlayer/client';
|
|
293
|
-
import type { LogoutRequest } from '@zlayer/client';
|
|
420
|
+
} from '@zlayer/api-client';
|
|
421
|
+
import type { LogoutRequest } from '@zlayer/api-client';
|
|
294
422
|
|
|
295
423
|
async function example() {
|
|
296
|
-
console.log("🚀 Testing @zlayer/client SDK...");
|
|
424
|
+
console.log("🚀 Testing @zlayer/api-client SDK...");
|
|
297
425
|
const api = new AuthenticationApi();
|
|
298
426
|
|
|
299
427
|
try {
|
|
@@ -348,11 +476,11 @@ Return the currently signed-in user.
|
|
|
348
476
|
import {
|
|
349
477
|
Configuration,
|
|
350
478
|
AuthenticationApi,
|
|
351
|
-
} from '@zlayer/client';
|
|
352
|
-
import type { MeRequest } from '@zlayer/client';
|
|
479
|
+
} from '@zlayer/api-client';
|
|
480
|
+
import type { MeRequest } from '@zlayer/api-client';
|
|
353
481
|
|
|
354
482
|
async function example() {
|
|
355
|
-
console.log("🚀 Testing @zlayer/client SDK...");
|
|
483
|
+
console.log("🚀 Testing @zlayer/api-client SDK...");
|
|
356
484
|
const api = new AuthenticationApi();
|
|
357
485
|
|
|
358
486
|
try {
|
|
@@ -393,3 +521,69 @@ No authorization required
|
|
|
393
521
|
|
|
394
522
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
395
523
|
|
|
524
|
+
|
|
525
|
+
## start
|
|
526
|
+
|
|
527
|
+
> start(provider)
|
|
528
|
+
|
|
529
|
+
`GET /auth/oidc/:provider/start` — 302 to the provider\'s authorize URL.
|
|
530
|
+
|
|
531
|
+
### Example
|
|
532
|
+
|
|
533
|
+
```ts
|
|
534
|
+
import {
|
|
535
|
+
Configuration,
|
|
536
|
+
AuthenticationApi,
|
|
537
|
+
} from '@zlayer/api-client';
|
|
538
|
+
import type { StartRequest } from '@zlayer/api-client';
|
|
539
|
+
|
|
540
|
+
async function example() {
|
|
541
|
+
console.log("🚀 Testing @zlayer/api-client SDK...");
|
|
542
|
+
const api = new AuthenticationApi();
|
|
543
|
+
|
|
544
|
+
const body = {
|
|
545
|
+
// string | Provider slug
|
|
546
|
+
provider: provider_example,
|
|
547
|
+
} satisfies StartRequest;
|
|
548
|
+
|
|
549
|
+
try {
|
|
550
|
+
const data = await api.start(body);
|
|
551
|
+
console.log(data);
|
|
552
|
+
} catch (error) {
|
|
553
|
+
console.error(error);
|
|
554
|
+
}
|
|
555
|
+
}
|
|
556
|
+
|
|
557
|
+
// Run the test
|
|
558
|
+
example().catch(console.error);
|
|
559
|
+
```
|
|
560
|
+
|
|
561
|
+
### Parameters
|
|
562
|
+
|
|
563
|
+
|
|
564
|
+
| Name | Type | Description | Notes |
|
|
565
|
+
|------------- | ------------- | ------------- | -------------|
|
|
566
|
+
| **provider** | `string` | Provider slug | [Defaults to `undefined`] |
|
|
567
|
+
|
|
568
|
+
### Return type
|
|
569
|
+
|
|
570
|
+
`void` (Empty response body)
|
|
571
|
+
|
|
572
|
+
### Authorization
|
|
573
|
+
|
|
574
|
+
No authorization required
|
|
575
|
+
|
|
576
|
+
### HTTP request headers
|
|
577
|
+
|
|
578
|
+
- **Content-Type**: Not defined
|
|
579
|
+
- **Accept**: Not defined
|
|
580
|
+
|
|
581
|
+
|
|
582
|
+
### HTTP response details
|
|
583
|
+
| Status code | Description | Response headers |
|
|
584
|
+
|-------------|-------------|------------------|
|
|
585
|
+
| **302** | Redirect to provider\'s authorize URL | - |
|
|
586
|
+
| **404** | Unknown provider | - |
|
|
587
|
+
|
|
588
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
589
|
+
|
package/docs/BackendGroupInfo.md
CHANGED