@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
package/docs/PruneResultDto.md
CHANGED
package/docs/PullImageRequest.md
CHANGED
|
@@ -9,16 +9,20 @@ Name | Type
|
|
|
9
9
|
------------ | -------------
|
|
10
10
|
`pullPolicy` | string
|
|
11
11
|
`reference` | string
|
|
12
|
+
`registryAuth` | [RegistryAuth](RegistryAuth.md)
|
|
13
|
+
`registryCredentialId` | string
|
|
12
14
|
|
|
13
15
|
## Example
|
|
14
16
|
|
|
15
17
|
```typescript
|
|
16
|
-
import type { PullImageRequest } from '@zlayer/client'
|
|
18
|
+
import type { PullImageRequest } from '@zlayer/api-client'
|
|
17
19
|
|
|
18
20
|
// TODO: Update the object below with actual values
|
|
19
21
|
const example = {
|
|
20
22
|
"pullPolicy": null,
|
|
21
23
|
"reference": null,
|
|
24
|
+
"registryAuth": null,
|
|
25
|
+
"registryCredentialId": null,
|
|
22
26
|
} satisfies PullImageRequest
|
|
23
27
|
|
|
24
28
|
console.log(example)
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
|
|
2
|
+
# RegistryAuth
|
|
3
|
+
|
|
4
|
+
Inline Docker/OCI registry credentials attached to a single pull request. Prefer persistent credentials via `/api/v1/credentials/registry` for long-lived services. Use this inline form for one-off pulls (e.g. CI runners fetching a private image for a single job) where persisting a credential is undesirable.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`authType` | [RegistryAuthType](RegistryAuthType.md)
|
|
11
|
+
`password` | string
|
|
12
|
+
`username` | string
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import type { RegistryAuth } from '@zlayer/api-client'
|
|
18
|
+
|
|
19
|
+
// TODO: Update the object below with actual values
|
|
20
|
+
const example = {
|
|
21
|
+
"authType": null,
|
|
22
|
+
"password": null,
|
|
23
|
+
"username": null,
|
|
24
|
+
} satisfies RegistryAuth
|
|
25
|
+
|
|
26
|
+
console.log(example)
|
|
27
|
+
|
|
28
|
+
// Convert the instance to a JSON string
|
|
29
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
30
|
+
console.log(exampleJSON)
|
|
31
|
+
|
|
32
|
+
// Parse the JSON string back to an object
|
|
33
|
+
const exampleParsed = JSON.parse(exampleJSON) as RegistryAuth
|
|
34
|
+
console.log(exampleParsed)
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
38
|
+
|
|
39
|
+
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
|
|
2
|
+
# RegistryAuthType
|
|
3
|
+
|
|
4
|
+
Authentication scheme for a [`RegistryAuth`].
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { RegistryAuthType } from '@zlayer/api-client'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
} satisfies RegistryAuthType
|
|
19
|
+
|
|
20
|
+
console.log(example)
|
|
21
|
+
|
|
22
|
+
// Convert the instance to a JSON string
|
|
23
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
24
|
+
console.log(exampleJSON)
|
|
25
|
+
|
|
26
|
+
// Parse the JSON string back to an object
|
|
27
|
+
const exampleParsed = JSON.parse(exampleJSON) as RegistryAuthType
|
|
28
|
+
console.log(exampleParsed)
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
32
|
+
|
|
33
|
+
|
|
@@ -15,7 +15,7 @@ Name | Type
|
|
|
15
15
|
## Example
|
|
16
16
|
|
|
17
17
|
```typescript
|
|
18
|
-
import type { RegistryCredentialResponse } from '@zlayer/client'
|
|
18
|
+
import type { RegistryCredentialResponse } from '@zlayer/api-client'
|
|
19
19
|
|
|
20
20
|
// TODO: Update the object below with actual values
|
|
21
21
|
const example = {
|
package/docs/ReplicationInfo.md
CHANGED
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
|
|
2
|
+
# RevealAllSecretsResponse
|
|
3
|
+
|
|
4
|
+
Response for the batch reveal endpoint — returns every secret in an env as plaintext. Admin-only for now (Phase 3 will gate this on per-env Read permission instead).
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`environment` | string
|
|
11
|
+
`secrets` | { [key: string]: string; }
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import type { RevealAllSecretsResponse } from '@zlayer/api-client'
|
|
17
|
+
|
|
18
|
+
// TODO: Update the object below with actual values
|
|
19
|
+
const example = {
|
|
20
|
+
"environment": null,
|
|
21
|
+
"secrets": null,
|
|
22
|
+
} satisfies RevealAllSecretsResponse
|
|
23
|
+
|
|
24
|
+
console.log(example)
|
|
25
|
+
|
|
26
|
+
// Convert the instance to a JSON string
|
|
27
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
28
|
+
console.log(exampleJSON)
|
|
29
|
+
|
|
30
|
+
// Parse the JSON string back to an object
|
|
31
|
+
const exampleParsed = JSON.parse(exampleJSON) as RevealAllSecretsResponse
|
|
32
|
+
console.log(exampleParsed)
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
36
|
+
|
|
37
|
+
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
|
|
2
|
+
# RotateSecretRequest
|
|
3
|
+
|
|
4
|
+
Request body for secret rotation.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`value` | string
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { RotateSecretRequest } from '@zlayer/api-client'
|
|
16
|
+
|
|
17
|
+
// TODO: Update the object below with actual values
|
|
18
|
+
const example = {
|
|
19
|
+
"value": null,
|
|
20
|
+
} satisfies RotateSecretRequest
|
|
21
|
+
|
|
22
|
+
console.log(example)
|
|
23
|
+
|
|
24
|
+
// Convert the instance to a JSON string
|
|
25
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
26
|
+
console.log(exampleJSON)
|
|
27
|
+
|
|
28
|
+
// Parse the JSON string back to an object
|
|
29
|
+
const exampleParsed = JSON.parse(exampleJSON) as RotateSecretRequest
|
|
30
|
+
console.log(exampleParsed)
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
34
|
+
|
|
35
|
+
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
|
|
2
|
+
# RotateSecretResponse
|
|
3
|
+
|
|
4
|
+
Response returned by the rotate endpoint.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`name` | string
|
|
11
|
+
`newVersion` | number
|
|
12
|
+
`previousVersion` | number
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import type { RotateSecretResponse } from '@zlayer/api-client'
|
|
18
|
+
|
|
19
|
+
// TODO: Update the object below with actual values
|
|
20
|
+
const example = {
|
|
21
|
+
"name": null,
|
|
22
|
+
"newVersion": null,
|
|
23
|
+
"previousVersion": null,
|
|
24
|
+
} satisfies RotateSecretResponse
|
|
25
|
+
|
|
26
|
+
console.log(example)
|
|
27
|
+
|
|
28
|
+
// Convert the instance to a JSON string
|
|
29
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
30
|
+
console.log(exampleJSON)
|
|
31
|
+
|
|
32
|
+
// Parse the JSON string back to an object
|
|
33
|
+
const exampleParsed = JSON.parse(exampleJSON) as RotateSecretResponse
|
|
34
|
+
console.log(exampleParsed)
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
38
|
+
|
|
39
|
+
|
package/docs/RouteInfo.md
CHANGED
package/docs/RoutesResponse.md
CHANGED
package/docs/ScaleRequest.md
CHANGED
package/docs/SecretsApi.md
CHANGED
|
@@ -9,6 +9,8 @@ All URIs are relative to *http://localhost*
|
|
|
9
9
|
| [**deleteSecret**](SecretsApi.md#deletesecret) | **DELETE** /api/v1/secrets/{name} | Delete a secret. |
|
|
10
10
|
| [**getSecretMetadata**](SecretsApi.md#getsecretmetadata) | **GET** /api/v1/secrets/{name} | Get metadata for a specific secret. With `?reveal=true` (admin only), the response also includes the plaintext `value`. |
|
|
11
11
|
| [**listSecrets**](SecretsApi.md#listsecrets) | **GET** /api/v1/secrets | List secrets in a scope. |
|
|
12
|
+
| [**revealAllSecrets**](SecretsApi.md#revealallsecrets) | **GET** /api/v1/secrets/reveal-all | Reveal every secret in an environment at once (admin only). |
|
|
13
|
+
| [**rotateSecret**](SecretsApi.md#rotatesecretoperation) | **POST** /api/v1/secrets/{name}/rotate | Rotate a secret — overwrite with a new value and return the version before+after. |
|
|
12
14
|
|
|
13
15
|
|
|
14
16
|
|
|
@@ -26,11 +28,11 @@ Each non-empty, non-comment line is parsed into a (name, value) pair and written
|
|
|
26
28
|
import {
|
|
27
29
|
Configuration,
|
|
28
30
|
SecretsApi,
|
|
29
|
-
} from '@zlayer/client';
|
|
30
|
-
import type { BulkImportSecretsRequest } from '@zlayer/client';
|
|
31
|
+
} from '@zlayer/api-client';
|
|
32
|
+
import type { BulkImportSecretsRequest } from '@zlayer/api-client';
|
|
31
33
|
|
|
32
34
|
async function example() {
|
|
33
|
-
console.log("🚀 Testing @zlayer/client SDK...");
|
|
35
|
+
console.log("🚀 Testing @zlayer/api-client SDK...");
|
|
34
36
|
const config = new Configuration({
|
|
35
37
|
// Configure HTTP bearer authorization: bearer_auth
|
|
36
38
|
accessToken: "YOUR BEARER TOKEN",
|
|
@@ -103,11 +105,11 @@ Stores a new secret or updates an existing one. The secret value is encrypted at
|
|
|
103
105
|
import {
|
|
104
106
|
Configuration,
|
|
105
107
|
SecretsApi,
|
|
106
|
-
} from '@zlayer/client';
|
|
107
|
-
import type { CreateSecretOperationRequest } from '@zlayer/client';
|
|
108
|
+
} from '@zlayer/api-client';
|
|
109
|
+
import type { CreateSecretOperationRequest } from '@zlayer/api-client';
|
|
108
110
|
|
|
109
111
|
async function example() {
|
|
110
|
-
console.log("🚀 Testing @zlayer/client SDK...");
|
|
112
|
+
console.log("🚀 Testing @zlayer/api-client SDK...");
|
|
111
113
|
const config = new Configuration({
|
|
112
114
|
// Configure HTTP bearer authorization: bearer_auth
|
|
113
115
|
accessToken: "YOUR BEARER TOKEN",
|
|
@@ -185,11 +187,11 @@ Scope resolution: see [`resolve_scope_get`] (the same query type is re
|
|
|
185
187
|
import {
|
|
186
188
|
Configuration,
|
|
187
189
|
SecretsApi,
|
|
188
|
-
} from '@zlayer/client';
|
|
189
|
-
import type { DeleteSecretRequest } from '@zlayer/client';
|
|
190
|
+
} from '@zlayer/api-client';
|
|
191
|
+
import type { DeleteSecretRequest } from '@zlayer/api-client';
|
|
190
192
|
|
|
191
193
|
async function example() {
|
|
192
|
-
console.log("🚀 Testing @zlayer/client SDK...");
|
|
194
|
+
console.log("🚀 Testing @zlayer/api-client SDK...");
|
|
193
195
|
const config = new Configuration({
|
|
194
196
|
// Configure HTTP bearer authorization: bearer_auth
|
|
195
197
|
accessToken: "YOUR BEARER TOKEN",
|
|
@@ -265,11 +267,11 @@ Scope resolution: see [`resolve_scope_get`]. # Errors Returns an err
|
|
|
265
267
|
import {
|
|
266
268
|
Configuration,
|
|
267
269
|
SecretsApi,
|
|
268
|
-
} from '@zlayer/client';
|
|
269
|
-
import type { GetSecretMetadataRequest } from '@zlayer/client';
|
|
270
|
+
} from '@zlayer/api-client';
|
|
271
|
+
import type { GetSecretMetadataRequest } from '@zlayer/api-client';
|
|
270
272
|
|
|
271
273
|
async function example() {
|
|
272
|
-
console.log("🚀 Testing @zlayer/client SDK...");
|
|
274
|
+
console.log("🚀 Testing @zlayer/api-client SDK...");
|
|
273
275
|
const config = new Configuration({
|
|
274
276
|
// Configure HTTP bearer authorization: bearer_auth
|
|
275
277
|
accessToken: "YOUR BEARER TOKEN",
|
|
@@ -348,11 +350,11 @@ Scope resolution: see [`resolve_scope`]. # Errors Returns an error i
|
|
|
348
350
|
import {
|
|
349
351
|
Configuration,
|
|
350
352
|
SecretsApi,
|
|
351
|
-
} from '@zlayer/client';
|
|
352
|
-
import type { ListSecretsRequest } from '@zlayer/client';
|
|
353
|
+
} from '@zlayer/api-client';
|
|
354
|
+
import type { ListSecretsRequest } from '@zlayer/api-client';
|
|
353
355
|
|
|
354
356
|
async function example() {
|
|
355
|
-
console.log("🚀 Testing @zlayer/client SDK...");
|
|
357
|
+
console.log("🚀 Testing @zlayer/api-client SDK...");
|
|
356
358
|
const config = new Configuration({
|
|
357
359
|
// Configure HTTP bearer authorization: bearer_auth
|
|
358
360
|
accessToken: "YOUR BEARER TOKEN",
|
|
@@ -409,3 +411,161 @@ example().catch(console.error);
|
|
|
409
411
|
|
|
410
412
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
411
413
|
|
|
414
|
+
|
|
415
|
+
## revealAllSecrets
|
|
416
|
+
|
|
417
|
+
> RevealAllSecretsResponse revealAllSecrets(environment)
|
|
418
|
+
|
|
419
|
+
Reveal every secret in an environment at once (admin only).
|
|
420
|
+
|
|
421
|
+
Used by `zlayer run` to build the child-process env in a single round-trip. # Errors Returns `ApiError::Forbidden` if the caller is not admin, `ApiError::NotFound` if the environment is unknown, and `ApiError::Internal` for storage failures.
|
|
422
|
+
|
|
423
|
+
### Example
|
|
424
|
+
|
|
425
|
+
```ts
|
|
426
|
+
import {
|
|
427
|
+
Configuration,
|
|
428
|
+
SecretsApi,
|
|
429
|
+
} from '@zlayer/api-client';
|
|
430
|
+
import type { RevealAllSecretsRequest } from '@zlayer/api-client';
|
|
431
|
+
|
|
432
|
+
async function example() {
|
|
433
|
+
console.log("🚀 Testing @zlayer/api-client SDK...");
|
|
434
|
+
const config = new Configuration({
|
|
435
|
+
// Configure HTTP bearer authorization: bearer_auth
|
|
436
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
437
|
+
});
|
|
438
|
+
const api = new SecretsApi(config);
|
|
439
|
+
|
|
440
|
+
const body = {
|
|
441
|
+
// string | Environment id (required)
|
|
442
|
+
environment: environment_example,
|
|
443
|
+
} satisfies RevealAllSecretsRequest;
|
|
444
|
+
|
|
445
|
+
try {
|
|
446
|
+
const data = await api.revealAllSecrets(body);
|
|
447
|
+
console.log(data);
|
|
448
|
+
} catch (error) {
|
|
449
|
+
console.error(error);
|
|
450
|
+
}
|
|
451
|
+
}
|
|
452
|
+
|
|
453
|
+
// Run the test
|
|
454
|
+
example().catch(console.error);
|
|
455
|
+
```
|
|
456
|
+
|
|
457
|
+
### Parameters
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
| Name | Type | Description | Notes |
|
|
461
|
+
|------------- | ------------- | ------------- | -------------|
|
|
462
|
+
| **environment** | `string` | Environment id (required) | [Defaults to `undefined`] |
|
|
463
|
+
|
|
464
|
+
### Return type
|
|
465
|
+
|
|
466
|
+
[**RevealAllSecretsResponse**](RevealAllSecretsResponse.md)
|
|
467
|
+
|
|
468
|
+
### Authorization
|
|
469
|
+
|
|
470
|
+
[bearer_auth](../README.md#bearer_auth)
|
|
471
|
+
|
|
472
|
+
### HTTP request headers
|
|
473
|
+
|
|
474
|
+
- **Content-Type**: Not defined
|
|
475
|
+
- **Accept**: `application/json`
|
|
476
|
+
|
|
477
|
+
|
|
478
|
+
### HTTP response details
|
|
479
|
+
| Status code | Description | Response headers |
|
|
480
|
+
|-------------|-------------|------------------|
|
|
481
|
+
| **200** | Every secret revealed | - |
|
|
482
|
+
| **401** | Unauthorized | - |
|
|
483
|
+
| **403** | Admin required | - |
|
|
484
|
+
| **404** | Environment not found | - |
|
|
485
|
+
|
|
486
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
487
|
+
|
|
488
|
+
|
|
489
|
+
## rotateSecret
|
|
490
|
+
|
|
491
|
+
> RotateSecretResponse rotateSecret(name, rotateSecretRequest, environment, scope)
|
|
492
|
+
|
|
493
|
+
Rotate a secret — overwrite with a new value and return the version before+after.
|
|
494
|
+
|
|
495
|
+
Admin-only in v1. Mutually exclusive scope query like the other endpoints. # Errors Returns `ApiError::BadRequest` for empty names or conflicting scope params, `ApiError::Forbidden` for non-admin callers, `ApiError::NotFound` when the secret or environment is unknown, and `ApiError::Internal` for storage failures.
|
|
496
|
+
|
|
497
|
+
### Example
|
|
498
|
+
|
|
499
|
+
```ts
|
|
500
|
+
import {
|
|
501
|
+
Configuration,
|
|
502
|
+
SecretsApi,
|
|
503
|
+
} from '@zlayer/api-client';
|
|
504
|
+
import type { RotateSecretOperationRequest } from '@zlayer/api-client';
|
|
505
|
+
|
|
506
|
+
async function example() {
|
|
507
|
+
console.log("🚀 Testing @zlayer/api-client SDK...");
|
|
508
|
+
const config = new Configuration({
|
|
509
|
+
// Configure HTTP bearer authorization: bearer_auth
|
|
510
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
511
|
+
});
|
|
512
|
+
const api = new SecretsApi(config);
|
|
513
|
+
|
|
514
|
+
const body = {
|
|
515
|
+
// string | Secret name
|
|
516
|
+
name: name_example,
|
|
517
|
+
// RotateSecretRequest
|
|
518
|
+
rotateSecretRequest: ...,
|
|
519
|
+
// string | Environment id (optional)
|
|
520
|
+
environment: environment_example,
|
|
521
|
+
// string | Explicit scope (legacy) (optional)
|
|
522
|
+
scope: scope_example,
|
|
523
|
+
} satisfies RotateSecretOperationRequest;
|
|
524
|
+
|
|
525
|
+
try {
|
|
526
|
+
const data = await api.rotateSecret(body);
|
|
527
|
+
console.log(data);
|
|
528
|
+
} catch (error) {
|
|
529
|
+
console.error(error);
|
|
530
|
+
}
|
|
531
|
+
}
|
|
532
|
+
|
|
533
|
+
// Run the test
|
|
534
|
+
example().catch(console.error);
|
|
535
|
+
```
|
|
536
|
+
|
|
537
|
+
### Parameters
|
|
538
|
+
|
|
539
|
+
|
|
540
|
+
| Name | Type | Description | Notes |
|
|
541
|
+
|------------- | ------------- | ------------- | -------------|
|
|
542
|
+
| **name** | `string` | Secret name | [Defaults to `undefined`] |
|
|
543
|
+
| **rotateSecretRequest** | [RotateSecretRequest](RotateSecretRequest.md) | | |
|
|
544
|
+
| **environment** | `string` | Environment id | [Optional] [Defaults to `undefined`] |
|
|
545
|
+
| **scope** | `string` | Explicit scope (legacy) | [Optional] [Defaults to `undefined`] |
|
|
546
|
+
|
|
547
|
+
### Return type
|
|
548
|
+
|
|
549
|
+
[**RotateSecretResponse**](RotateSecretResponse.md)
|
|
550
|
+
|
|
551
|
+
### Authorization
|
|
552
|
+
|
|
553
|
+
[bearer_auth](../README.md#bearer_auth)
|
|
554
|
+
|
|
555
|
+
### HTTP request headers
|
|
556
|
+
|
|
557
|
+
- **Content-Type**: `application/json`
|
|
558
|
+
- **Accept**: `application/json`
|
|
559
|
+
|
|
560
|
+
|
|
561
|
+
### HTTP response details
|
|
562
|
+
| Status code | Description | Response headers |
|
|
563
|
+
|-------------|-------------|------------------|
|
|
564
|
+
| **200** | Secret rotated | - |
|
|
565
|
+
| **400** | Invalid request | - |
|
|
566
|
+
| **401** | Unauthorized | - |
|
|
567
|
+
| **403** | Forbidden | - |
|
|
568
|
+
| **404** | Secret or environment not found | - |
|
|
569
|
+
|
|
570
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
571
|
+
|
package/docs/ServiceDetails.md
CHANGED
package/docs/ServiceEndpoint.md
CHANGED
package/docs/ServiceMetrics.md
CHANGED
package/docs/ServiceSummary.md
CHANGED
package/docs/ServicesApi.md
CHANGED
|
@@ -25,11 +25,11 @@ Get service details.
|
|
|
25
25
|
import {
|
|
26
26
|
Configuration,
|
|
27
27
|
ServicesApi,
|
|
28
|
-
} from '@zlayer/client';
|
|
29
|
-
import type { GetServiceRequest } from '@zlayer/client';
|
|
28
|
+
} from '@zlayer/api-client';
|
|
29
|
+
import type { GetServiceRequest } from '@zlayer/api-client';
|
|
30
30
|
|
|
31
31
|
async function example() {
|
|
32
|
-
console.log("🚀 Testing @zlayer/client SDK...");
|
|
32
|
+
console.log("🚀 Testing @zlayer/api-client SDK...");
|
|
33
33
|
const config = new Configuration({
|
|
34
34
|
// Configure HTTP bearer authorization: bearer_auth
|
|
35
35
|
accessToken: "YOUR BEARER TOKEN",
|
|
@@ -101,11 +101,11 @@ Returns service logs as plain text when `follow=false`, or as a S
|
|
|
101
101
|
import {
|
|
102
102
|
Configuration,
|
|
103
103
|
ServicesApi,
|
|
104
|
-
} from '@zlayer/client';
|
|
105
|
-
import type { GetServiceLogsRequest } from '@zlayer/client';
|
|
104
|
+
} from '@zlayer/api-client';
|
|
105
|
+
import type { GetServiceLogsRequest } from '@zlayer/api-client';
|
|
106
106
|
|
|
107
107
|
async function example() {
|
|
108
|
-
console.log("🚀 Testing @zlayer/client SDK...");
|
|
108
|
+
console.log("🚀 Testing @zlayer/api-client SDK...");
|
|
109
109
|
const config = new Configuration({
|
|
110
110
|
// Configure HTTP bearer authorization: bearer_auth
|
|
111
111
|
accessToken: "YOUR BEARER TOKEN",
|
|
@@ -186,11 +186,11 @@ List services in a deployment.
|
|
|
186
186
|
import {
|
|
187
187
|
Configuration,
|
|
188
188
|
ServicesApi,
|
|
189
|
-
} from '@zlayer/client';
|
|
190
|
-
import type { ListServicesRequest } from '@zlayer/client';
|
|
189
|
+
} from '@zlayer/api-client';
|
|
190
|
+
import type { ListServicesRequest } from '@zlayer/api-client';
|
|
191
191
|
|
|
192
192
|
async function example() {
|
|
193
|
-
console.log("🚀 Testing @zlayer/client SDK...");
|
|
193
|
+
console.log("🚀 Testing @zlayer/api-client SDK...");
|
|
194
194
|
const config = new Configuration({
|
|
195
195
|
// Configure HTTP bearer authorization: bearer_auth
|
|
196
196
|
accessToken: "YOUR BEARER TOKEN",
|
|
@@ -259,11 +259,11 @@ Scale a service.
|
|
|
259
259
|
import {
|
|
260
260
|
Configuration,
|
|
261
261
|
ServicesApi,
|
|
262
|
-
} from '@zlayer/client';
|
|
263
|
-
import type { ScaleServiceRequest } from '@zlayer/client';
|
|
262
|
+
} from '@zlayer/api-client';
|
|
263
|
+
import type { ScaleServiceRequest } from '@zlayer/api-client';
|
|
264
264
|
|
|
265
265
|
async function example() {
|
|
266
|
-
console.log("🚀 Testing @zlayer/client SDK...");
|
|
266
|
+
console.log("🚀 Testing @zlayer/api-client SDK...");
|
|
267
267
|
const config = new Configuration({
|
|
268
268
|
// Configure HTTP bearer authorization: bearer_auth
|
|
269
269
|
accessToken: "YOUR BEARER TOKEN",
|