24 stable releases
| new 1.1.5 | Mar 15, 2025 |
|---|---|
| 1.1.3 | Feb 25, 2025 |
| 1.0.16 | Nov 6, 2024 |
| 1.0.13 | Jul 20, 2024 |
#8 in #dtz
1,330 downloads per month
Used in dtz
70KB
1K
SLoC
Rust API client for dtz-core
a generated client for the DTZ Core API
Overview
This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.
- API version: 1.1.5
- Package version: 1.1.5
- Build package:
org.openapitools.codegen.languages.RustClientCodegen
Installation
Put the package under your project folder in a directory named dtz-core and add the following to Cargo.toml under [dependencies]:
dtz-core = { path = "./dtz-core" }
Documentation for API Endpoints
All URIs are relative to https://dtz.rocks/api/2021-12-09
| Class | Method | HTTP request | Description |
|---|---|---|---|
| DefaultApi | create_context | POST /context | create new context |
| DefaultApi | create_ingress | POST /ingress/{domain}/{uri} | create static content for ingress |
| DefaultApi | create_root_ingress | POST /ingress/{domain}/ | create or update ingress |
| DefaultApi | create_support_request | POST /context/{context_id}/support | create a new support request |
| DefaultApi | create_task | POST /task/{task_id} | create task for async execution |
| DefaultApi | delete_context | DELETE /context/{context_id} | delete context |
| DefaultApi | delete_ingress | DELETE /ingress/{domain}/{uri} | delete ingress |
| DefaultApi | delete_root_ingress | DELETE /ingress/{domain}/ | delete ingress |
| DefaultApi | enable_service | POST /context/{context_id}/enableService | enable service for context |
| DefaultApi | get_context | GET /context/{context_id} | get context information |
| DefaultApi | get_current_context | GET /context | get current context |
| DefaultApi | get_ingress | GET /ingress/{domain}/{uri} | get ingress for '/' path |
| DefaultApi | get_root_ingress | GET /ingress/{domain}/ | get ingress for '/' path |
| DefaultApi | get_support_case | GET /context/{context_id}/support/{case_id} | get the full support case, including its timeline |
| DefaultApi | get_task_history | GET /task/{task_id} | get execution history |
| DefaultApi | issue_certificate | POST /certificate | issue a certificate |
| DefaultApi | list_available_contexts | GET /identity/availableContexts | list all avaiable contexts |
| DefaultApi | list_ingress | GET /ingress | list all ingress |
| DefaultApi | pull_task_from_queue | POST /task | pull one task from the async task queue |
| DefaultApi | update_context | POST /context/{context_id} | update context |
| DefaultApi | update_support_case | POST /context/{context_id}/support/{case_id} | add a new entry to the support timeline |
Documentation For Models
- Container
- ContextResponse
- CreateContextRequest
- CreateIngressRequest
- CreateSupportRequestRequest
- CreateTaskRequest
- CreateTaskRequestTaskDefinition
- IngressResponse
- IssueCertificateRequest
- Login
- PullTaskFromQueue200Response
- PullTaskFromQueueRequest
- Rewrite
- StaticContent
- StaticContentHttp
- StaticContentHttpHeaderInner
- SupportCase
- SupportCaseTimelineInner
- Validity
To get access to the crate's generated documentation, use:
cargo doc --open
Author
Dependencies
~6–19MB
~277K SLoC