| # Rust API client for koharu-client |
|
|
| No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) |
|
|
|
|
| ## Overview |
|
|
| This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [openapi-spec](https://openapis.org) from a remote server, you can easily generate an API client. |
|
|
| - API version: |
| - Package version: 0.0.0 |
| - Generator version: 7.21.0 |
| - Build package: `org.openapitools.codegen.languages.RustClientCodegen` |
|
|
| ## Installation |
|
|
| Put the package under your project folder in a directory named `koharu-client` and add the following to `Cargo.toml` under `[dependencies]`: |
|
|
| ``` |
| koharu-client = { path = "./koharu-client" } |
| ``` |
|
|
| ## Documentation for API Endpoints |
|
|
| All URIs are relative to *http://localhost* |
|
|
| Class | Method | HTTP request | Description |
| ------------ | ------------- | ------------- | ------------- |
| *DefaultApi* | [**add_image_layer**](docs/DefaultApi.md#add_image_layer) | **POST** /pages/{id}/image-layers | |
| *DefaultApi* | [**apply_command**](docs/DefaultApi.md#apply_command) | **POST** /history/apply | |
| *DefaultApi* | [**cancel_operation**](docs/DefaultApi.md#cancel_operation) | **DELETE** /operations/{id} | |
| *DefaultApi* | [**clear_provider_secret**](docs/DefaultApi.md#clear_provider_secret) | **DELETE** /config/providers/{id}/secret | Clear a provider's keyring secret. The provider entry itself is kept. |
| *DefaultApi* | [**create_pages**](docs/DefaultApi.md#create_pages) | **POST** /pages | |
| *DefaultApi* | [**create_project**](docs/DefaultApi.md#create_project) | **POST** /projects | |
| *DefaultApi* | [**delete_current_llm**](docs/DefaultApi.md#delete_current_llm) | **DELETE** /llm/current | |
| *DefaultApi* | [**delete_current_project**](docs/DefaultApi.md#delete_current_project) | **DELETE** /projects/current | |
| *DefaultApi* | [**events**](docs/DefaultApi.md#events) | **GET** /events | |
| *DefaultApi* | [**export_current_project**](docs/DefaultApi.md#export_current_project) | **POST** /projects/current/export | |
| *DefaultApi* | [**fetch_google_font**](docs/DefaultApi.md#fetch_google_font) | **POST** /google-fonts/{family}/fetch | |
| *DefaultApi* | [**get_blob**](docs/DefaultApi.md#get_blob) | **GET** /blobs/{hash} | |
| *DefaultApi* | [**get_catalog**](docs/DefaultApi.md#get_catalog) | **GET** /llm/catalog | |
| *DefaultApi* | [**get_config**](docs/DefaultApi.md#get_config) | **GET** /config | |
| *DefaultApi* | [**get_current_llm**](docs/DefaultApi.md#get_current_llm) | **GET** /llm/current | |
| *DefaultApi* | [**get_engine_catalog**](docs/DefaultApi.md#get_engine_catalog) | **GET** /engines | |
| *DefaultApi* | [**get_google_font_file**](docs/DefaultApi.md#get_google_font_file) | **GET** /google-fonts/{family}/{file} | |
| *DefaultApi* | [**get_google_fonts_catalog**](docs/DefaultApi.md#get_google_fonts_catalog) | **GET** /google-fonts | |
| *DefaultApi* | [**get_meta**](docs/DefaultApi.md#get_meta) | **GET** /meta | |
| *DefaultApi* | [**get_page_thumbnail**](docs/DefaultApi.md#get_page_thumbnail) | **GET** /pages/{id}/thumbnail | |
| *DefaultApi* | [**get_scene_bin**](docs/DefaultApi.md#get_scene_bin) | **GET** /scene.bin | |
| *DefaultApi* | [**get_scene_json**](docs/DefaultApi.md#get_scene_json) | **GET** /scene.json | |
| *DefaultApi* | [**import_project**](docs/DefaultApi.md#import_project) | **POST** /projects/import | |
| *DefaultApi* | [**list_fonts**](docs/DefaultApi.md#list_fonts) | **GET** /fonts | |
| *DefaultApi* | [**list_projects**](docs/DefaultApi.md#list_projects) | **GET** /projects | |
| *DefaultApi* | [**patch_config**](docs/DefaultApi.md#patch_config) | **PATCH** /config | |
| *DefaultApi* | [**put_current_llm**](docs/DefaultApi.md#put_current_llm) | **PUT** /llm/current | |
| *DefaultApi* | [**put_current_project**](docs/DefaultApi.md#put_current_project) | **PUT** /projects/current | |
| *DefaultApi* | [**put_mask**](docs/DefaultApi.md#put_mask) | **PUT** /pages/{id}/masks/{role} | Upsert the `Mask { role }` node on a page with the raw image bytes in the body. Emits `Op::UpdateNode` if a mask of that role exists, else `Op::AddNode`. Used by the repair-brush / segment-edit flow; the follow-up localized inpaint is a separate `POST /pipelines` call. |
| *DefaultApi* | [**redo**](docs/DefaultApi.md#redo) | **POST** /history/redo | |
| *DefaultApi* | [**set_provider_secret**](docs/DefaultApi.md#set_provider_secret) | **PUT** /config/providers/{id}/secret | Save (or overwrite) the keyring secret for a provider. Creates the provider entry in `config.providers` if it didn't exist. `PUT` because setting the secret is idempotent for the same body. |
| *DefaultApi* | [**start_download**](docs/DefaultApi.md#start_download) | **POST** /downloads | |
| *DefaultApi* | [**start_pipeline**](docs/DefaultApi.md#start_pipeline) | **POST** /pipelines | |
| *DefaultApi* | [**undo**](docs/DefaultApi.md#undo) | **POST** /history/undo | |
|
|
|
|
| ## Documentation For Models |
|
|
| - [AddImageLayerResponse](docs/AddImageLayerResponse.md) |
| - [AppConfig](docs/AppConfig.md) |
| - [AppEvent](docs/AppEvent.md) |
| - [AppEventOneOf](docs/AppEventOneOf.md) |
| - [AppEventOneOf1](docs/AppEventOneOf1.md) |
| - [AppEventOneOf10](docs/AppEventOneOf10.md) |
| - [AppEventOneOf11](docs/AppEventOneOf11.md) |
| - [AppEventOneOf12](docs/AppEventOneOf12.md) |
| - [AppEventOneOf13](docs/AppEventOneOf13.md) |
| - [AppEventOneOf2](docs/AppEventOneOf2.md) |
| - [AppEventOneOf3](docs/AppEventOneOf3.md) |
| - [AppEventOneOf4](docs/AppEventOneOf4.md) |
| - [AppEventOneOf5](docs/AppEventOneOf5.md) |
| - [AppEventOneOf6](docs/AppEventOneOf6.md) |
| - [AppEventOneOf7](docs/AppEventOneOf7.md) |
| - [AppEventOneOf8](docs/AppEventOneOf8.md) |
| - [AppEventOneOf9](docs/AppEventOneOf9.md) |
| - [ConfigPatch](docs/ConfigPatch.md) |
| - [CreatePagesResponse](docs/CreatePagesResponse.md) |
| - [CreateProjectRequest](docs/CreateProjectRequest.md) |
| - [DataConfig](docs/DataConfig.md) |
| - [DownloadProgress](docs/DownloadProgress.md) |
| - [DownloadStatus](docs/DownloadStatus.md) |
| - [DownloadStatusOneOf](docs/DownloadStatusOneOf.md) |
| - [DownloadStatusOneOf1](docs/DownloadStatusOneOf1.md) |
| - [DownloadStatusOneOf2](docs/DownloadStatusOneOf2.md) |
| - [DownloadStatusOneOf3](docs/DownloadStatusOneOf3.md) |
| - [EngineCatalog](docs/EngineCatalog.md) |
| - [EngineCatalogEntry](docs/EngineCatalogEntry.md) |
| - [ErrorEvent](docs/ErrorEvent.md) |
| - [ExportFormat](docs/ExportFormat.md) |
| - [ExportProjectRequest](docs/ExportProjectRequest.md) |
| - [FontFaceInfo](docs/FontFaceInfo.md) |
| - [FontPrediction](docs/FontPrediction.md) |
| - [FontSource](docs/FontSource.md) |
| - [GoogleFontCatalog](docs/GoogleFontCatalog.md) |
| - [GoogleFontEntry](docs/GoogleFontEntry.md) |
| - [GoogleFontVariant](docs/GoogleFontVariant.md) |
| - [HistoryResult](docs/HistoryResult.md) |
| - [HttpConfig](docs/HttpConfig.md) |
| - [HttpConfigPatch](docs/HttpConfigPatch.md) |
| - [ImageData](docs/ImageData.md) |
| - [ImageDataPatch](docs/ImageDataPatch.md) |
| - [ImageRole](docs/ImageRole.md) |
| - [JobFinishedEvent](docs/JobFinishedEvent.md) |
| - [JobStatus](docs/JobStatus.md) |
| - [JobSummary](docs/JobSummary.md) |
| - [ListProjectsResponse](docs/ListProjectsResponse.md) |
| - [LlmCatalog](docs/LlmCatalog.md) |
| - [LlmCatalogModel](docs/LlmCatalogModel.md) |
| - [LlmGenerationOptions](docs/LlmGenerationOptions.md) |
| - [LlmLoadRequest](docs/LlmLoadRequest.md) |
| - [LlmProviderCatalog](docs/LlmProviderCatalog.md) |
| - [LlmProviderCatalogStatus](docs/LlmProviderCatalogStatus.md) |
| - [LlmState](docs/LlmState.md) |
| - [LlmStateStatus](docs/LlmStateStatus.md) |
| - [LlmTarget](docs/LlmTarget.md) |
| - [LlmTargetKind](docs/LlmTargetKind.md) |
| - [MaskData](docs/MaskData.md) |
| - [MaskDataPatch](docs/MaskDataPatch.md) |
| - [MaskRole](docs/MaskRole.md) |
| - [MetaInfo](docs/MetaInfo.md) |
| - [NamedFontPrediction](docs/NamedFontPrediction.md) |
| - [Node](docs/Node.md) |
| - [NodeDataPatch](docs/NodeDataPatch.md) |
| - [NodeDataPatchOneOf](docs/NodeDataPatchOneOf.md) |
| - [NodeDataPatchOneOf1](docs/NodeDataPatchOneOf1.md) |
| - [NodeDataPatchOneOf2](docs/NodeDataPatchOneOf2.md) |
| - [NodeKind](docs/NodeKind.md) |
| - [NodeKindOneOf](docs/NodeKindOneOf.md) |
| - [NodeKindOneOf1](docs/NodeKindOneOf1.md) |
| - [NodeKindOneOf2](docs/NodeKindOneOf2.md) |
| - [NodePatch](docs/NodePatch.md) |
| - [Op](docs/Op.md) |
| - [OpOneOf](docs/OpOneOf.md) |
| - [OpOneOf1](docs/OpOneOf1.md) |
| - [OpOneOf1AddPage](docs/OpOneOf1AddPage.md) |
| - [OpOneOf2](docs/OpOneOf2.md) |
| - [OpOneOf2RemovePage](docs/OpOneOf2RemovePage.md) |
| - [OpOneOf3](docs/OpOneOf3.md) |
| - [OpOneOf3UpdatePage](docs/OpOneOf3UpdatePage.md) |
| - [OpOneOf4](docs/OpOneOf4.md) |
| - [OpOneOf4ReorderPages](docs/OpOneOf4ReorderPages.md) |
| - [OpOneOf5](docs/OpOneOf5.md) |
| - [OpOneOf5AddNode](docs/OpOneOf5AddNode.md) |
| - [OpOneOf6](docs/OpOneOf6.md) |
| - [OpOneOf6RemoveNode](docs/OpOneOf6RemoveNode.md) |
| - [OpOneOf7](docs/OpOneOf7.md) |
| - [OpOneOf7UpdateNode](docs/OpOneOf7UpdateNode.md) |
| - [OpOneOf8](docs/OpOneOf8.md) |
| - [OpOneOf8ReorderNodes](docs/OpOneOf8ReorderNodes.md) |
| - [OpOneOf9](docs/OpOneOf9.md) |
| - [OpOneOf9Batch](docs/OpOneOf9Batch.md) |
| - [OpOneOfUpdateProjectMeta](docs/OpOneOfUpdateProjectMeta.md) |
| - [OpenProjectRequest](docs/OpenProjectRequest.md) |
| - [Page](docs/Page.md) |
| - [PagePatch](docs/PagePatch.md) |
| - [PipelineConfig](docs/PipelineConfig.md) |
| - [PipelineConfigPatch](docs/PipelineConfigPatch.md) |
| - [PipelineProgress](docs/PipelineProgress.md) |
| - [PipelineStatus](docs/PipelineStatus.md) |
| - [PipelineStatusOneOf](docs/PipelineStatusOneOf.md) |
| - [PipelineStatusOneOf1](docs/PipelineStatusOneOf1.md) |
| - [PipelineStep](docs/PipelineStep.md) |
| - [ProjectMeta](docs/ProjectMeta.md) |
| - [ProjectMetaPatch](docs/ProjectMetaPatch.md) |
| - [ProjectStyle](docs/ProjectStyle.md) |
| - [ProjectSummary](docs/ProjectSummary.md) |
| - [ProviderConfig](docs/ProviderConfig.md) |
| - [ProviderPatch](docs/ProviderPatch.md) |
| - [ProviderSecretRequest](docs/ProviderSecretRequest.md) |
| - [PutMaskResponse](docs/PutMaskResponse.md) |
| - [Region](docs/Region.md) |
| - [Scene](docs/Scene.md) |
| - [SceneSnapshot](docs/SceneSnapshot.md) |
| - [SnapshotEvent](docs/SnapshotEvent.md) |
| - [StartDownloadRequest](docs/StartDownloadRequest.md) |
| - [StartDownloadResponse](docs/StartDownloadResponse.md) |
| - [StartPipelineRequest](docs/StartPipelineRequest.md) |
| - [StartPipelineResponse](docs/StartPipelineResponse.md) |
| - [TextAlign](docs/TextAlign.md) |
| - [TextData](docs/TextData.md) |
| - [TextDataPatch](docs/TextDataPatch.md) |
| - [TextDirection](docs/TextDirection.md) |
| - [TextShaderEffect](docs/TextShaderEffect.md) |
| - [TextStrokeStyle](docs/TextStrokeStyle.md) |
| - [TextStyle](docs/TextStyle.md) |
| - [TopFont](docs/TopFont.md) |
| - [Transform](docs/Transform.md) |
|
|
|
|
| To get access to the crate's generated documentation, use: |
|
|
| ``` |
| cargo doc --open |
| ``` |
|
|
| ## Author |
|
|
|
|
|
|
|
|
