@zlayer/api-client 0.10.86

package/docs/ImageInfoDto.md

@@ -0,0 +1,39 @@
+
+# ImageInfoDto
+
+Serializable wrapper for [`ImageInfo`] so we can attach `ToSchema` here (the underlying type in `zlayer-agent` can\'t depend on `utoipa`).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`digest` | string
+`reference` | string
+`sizeBytes` | number
+
+## Example
+
+```typescript
+import type { ImageInfoDto } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "digest": null,
+  "reference": null,
+  "sizeBytes": null,
+} satisfies ImageInfoDto
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ImageInfoDto
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ImagesApi.md

@@ -0,0 +1,372 @@
+# ImagesApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**listImagesHandler**](ImagesApi.md#listimageshandler) | **GET** /api/v1/images | List all cached images known to the runtime. |
+| [**pruneImagesHandler**](ImagesApi.md#pruneimageshandler) | **POST** /api/v1/system/prune | Prune dangling / unused images from the runtime\'s cache. |
+| [**pullImageHandler**](ImagesApi.md#pullimagehandler) | **POST** /api/v1/images/pull | Pull an OCI image into the runtime\'s local cache. |
+| [**removeImageHandler**](ImagesApi.md#removeimagehandler) | **DELETE** /api/v1/images/{image} | Remove an image from the runtime\'s cache. |
+| [**tagImageHandler**](ImagesApi.md#tagimagehandler) | **POST** /api/v1/images/tag | Create a new tag pointing at an existing image. |
+
+
+
+## listImagesHandler
+
+> Array<ImageInfoDto> listImagesHandler()
+
+List all cached images known to the runtime.
+
+# Errors  Returns an error if authentication fails or the runtime cannot enumerate its image cache (for example, when the backend does not implement `list_images`).
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ImagesApi,
+} from '@zlayer/client';
+import type { ListImagesHandlerRequest } from '@zlayer/client';
+
+async function example() {
+  console.log("🚀 Testing @zlayer/client SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearer_auth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new ImagesApi(config);
+
+  try {
+    const data = await api.listImagesHandler();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array<ImageInfoDto>**](ImageInfoDto.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | List of cached images |  -  |
+| **401** | Unauthorized |  -  |
+| **501** | Runtime does not support image listing |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## pruneImagesHandler
+
+> PruneResultDto pruneImagesHandler()
+
+Prune dangling / unused images from the runtime\'s cache.
+
+# Errors  Returns an error if authentication fails or the runtime backend does not support pruning.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ImagesApi,
+} from '@zlayer/client';
+import type { PruneImagesHandlerRequest } from '@zlayer/client';
+
+async function example() {
+  console.log("🚀 Testing @zlayer/client SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearer_auth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new ImagesApi(config);
+
+  try {
+    const data = await api.pruneImagesHandler();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**PruneResultDto**](PruneResultDto.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Prune result |  -  |
+| **401** | Unauthorized |  -  |
+| **501** | Runtime does not support pruning |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## pullImageHandler
+
+> PullImageResponse pullImageHandler(pullImageRequest)
+
+Pull an OCI image into the runtime\'s local cache.
+
+This is a blocking pull: the handler returns only after the image is resolved and stored locally (or the pull fails). When `pull_policy` is omitted the default is `\"always\"`, matching Docker-compat semantics for `POST /images/create`. On success, the response echoes the reference and best-effort `digest`/`size_bytes` resolved via `list_images()`.  # Errors  Returns an error if authentication fails, the reference is empty, the image cannot be pulled, or the user lacks the operator role.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ImagesApi,
+} from '@zlayer/client';
+import type { PullImageHandlerRequest } from '@zlayer/client';
+
+async function example() {
+  console.log("🚀 Testing @zlayer/client SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearer_auth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new ImagesApi(config);
+
+  const body = {
+    // PullImageRequest
+    pullImageRequest: ...,
+  } satisfies PullImageHandlerRequest;
+
+  try {
+    const data = await api.pullImageHandler(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **pullImageRequest** | [PullImageRequest](PullImageRequest.md) |  | |
+
+### Return type
+
+[**PullImageResponse**](PullImageResponse.md)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Image pulled |  -  |
+| **400** | Invalid request |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden - operator role required |  -  |
+| **500** | Pull failed |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## removeImageHandler
+
+> removeImageHandler(image, force)
+
+Remove an image from the runtime\'s cache.
+
+# Errors  Returns an error if authentication fails, the image cannot be found, or the runtime backend does not support image removal.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ImagesApi,
+} from '@zlayer/client';
+import type { RemoveImageHandlerRequest } from '@zlayer/client';
+
+async function example() {
+  console.log("🚀 Testing @zlayer/client SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearer_auth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new ImagesApi(config);
+
+  const body = {
+    // string | Image reference (URL-encoded)
+    image: image_example,
+    // boolean | Force removal even if the image is referenced by containers. (optional)
+    force: true,
+  } satisfies RemoveImageHandlerRequest;
+
+  try {
+    const data = await api.removeImageHandler(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **image** | `string` | Image reference (URL-encoded) | [Defaults to `undefined`] |
+| **force** | `boolean` | Force removal even if the image is referenced by containers. | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | Image removed |  -  |
+| **401** | Unauthorized |  -  |
+| **404** | Image not found |  -  |
+| **501** | Runtime does not support image removal |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## tagImageHandler
+
+> tagImageHandler(tagImageRequest)
+
+Create a new tag pointing at an existing image.
+
+Docker-compat `POST /api/v1/images/tag`: takes `{ source, target }` and asks the runtime to make `target` resolve to the same content as `source`. Both references must be non-empty; `target` is split on the last `:` into repository + tag (defaulting tag to `latest`).  # Errors  Returns `400` if the request body is malformed, `404` if the source image is not in the cache, `403` if the caller lacks the `operator` role, `501` if the runtime does not support tagging, and `500` for other runtime errors.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ImagesApi,
+} from '@zlayer/client';
+import type { TagImageHandlerRequest } from '@zlayer/client';
+
+async function example() {
+  console.log("🚀 Testing @zlayer/client SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearer_auth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new ImagesApi(config);
+
+  const body = {
+    // TagImageRequest
+    tagImageRequest: ...,
+  } satisfies TagImageHandlerRequest;
+
+  try {
+    const data = await api.tagImageHandler(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **tagImageRequest** | [TagImageRequest](TagImageRequest.md) |  | |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[bearer_auth](../README.md#bearer_auth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | Tag created |  -  |
+| **400** | Invalid request |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden - operator role required |  -  |
+| **404** | Source image not found |  -  |
+| **500** | Internal error |  -  |
+| **501** | Runtime does not support tagging |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/docs/InternalApi.md

@@ -0,0 +1,149 @@
+# InternalApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getReplicasInternal**](InternalApi.md#getreplicasinternal) | **GET** /api/v1/internal/replicas/{service} | Get the current replica count for a service. |
+| [**scaleServiceInternal**](InternalApi.md#scaleserviceinternal) | **POST** /api/v1/internal/scale | Scale a service via internal scheduler request. |
+
+
+
+## getReplicasInternal
+
+> InternalScaleResponse getReplicasInternal(service)
+
+Get the current replica count for a service.
+
+This endpoint allows the scheduler to query the current state of a service.  # Errors  Returns an error if the service is not found or authentication is invalid.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  InternalApi,
+} from '@zlayer/client';
+import type { GetReplicasInternalRequest } from '@zlayer/client';
+
+async function example() {
+  console.log("🚀 Testing @zlayer/client SDK...");
+  const api = new InternalApi();
+
+  const body = {
+    // string | Service name
+    service: service_example,
+  } satisfies GetReplicasInternalRequest;
+
+  try {
+    const data = await api.getReplicasInternal(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **service** | `string` | Service name | [Defaults to `undefined`] |
+
+### Return type
+
+[**InternalScaleResponse**](InternalScaleResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Current replica count |  -  |
+| **401** | Unauthorized - invalid or missing internal token |  -  |
+| **404** | Service not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## scaleServiceInternal
+
+> InternalScaleResponse scaleServiceInternal(internalScaleRequest)
+
+Scale a service via internal scheduler request.
+
+This endpoint is called by the distributed scheduler leader to trigger scaling operations on agent nodes. It uses a shared secret for authentication.  # Errors  Returns an error if the service is not found, scaling fails, or authentication is invalid.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  InternalApi,
+} from '@zlayer/client';
+import type { ScaleServiceInternalRequest } from '@zlayer/client';
+
+async function example() {
+  console.log("🚀 Testing @zlayer/client SDK...");
+  const api = new InternalApi();
+
+  const body = {
+    // InternalScaleRequest
+    internalScaleRequest: ...,
+  } satisfies ScaleServiceInternalRequest;
+
+  try {
+    const data = await api.scaleServiceInternal(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **internalScaleRequest** | [InternalScaleRequest](InternalScaleRequest.md) |  | |
+
+### Return type
+
+[**InternalScaleResponse**](InternalScaleResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Service scaled successfully |  -  |
+| **401** | Unauthorized - invalid or missing internal token |  -  |
+| **404** | Service not found |  -  |
+| **500** | Internal error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/docs/InternalScaleRequest.md

@@ -0,0 +1,37 @@
+
+# InternalScaleRequest
+
+Request to scale a service
+
+## Properties
+
+Name | Type
+------------ | -------------
+`replicas` | number
+`service` | string
+
+## Example
+
+```typescript
+import type { InternalScaleRequest } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "replicas": null,
+  "service": null,
+} satisfies InternalScaleRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as InternalScaleRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/InternalScaleResponse.md

@@ -0,0 +1,41 @@
+
+# InternalScaleResponse
+
+Response from internal scale operation
+
+## Properties
+
+Name | Type
+------------ | -------------
+`message` | string
+`replicas` | number
+`service` | string
+`success` | boolean
+
+## Example
+
+```typescript
+import type { InternalScaleResponse } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "message": null,
+  "replicas": null,
+  "service": null,
+  "success": null,
+} satisfies InternalScaleResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as InternalScaleResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/IpAllocationResponse.md

@@ -0,0 +1,45 @@
+
+# IpAllocationResponse
+
+IP allocation status response
+
+## Properties
+
+Name | Type
+------------ | -------------
+`allocatedCount` | number
+`allocatedIps` | Array<string>
+`availableCount` | number
+`cidr` | string
+`totalIps` | number
+`utilizationPercent` | number
+
+## Example
+
+```typescript
+import type { IpAllocationResponse } from '@zlayer/client'
+
+// TODO: Update the object below with actual values
+const example = {
+  "allocatedCount": null,
+  "allocatedIps": null,
+  "availableCount": null,
+  "cidr": null,
+  "totalIps": null,
+  "utilizationPercent": null,
+} satisfies IpAllocationResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as IpAllocationResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+