#api-client #batch #generated #engine #open-api #model #codegen

headless_batch_engine

A client and model library for Liferay DXP's batch engine api, auto generated by open-api-generator

1 unstable release

0.1.0 Mar 17, 2023

#63 in #batch

Download history 8/week @ 2024-02-19 24/week @ 2024-02-26 3/week @ 2024-03-04 10/week @ 2024-03-11 1/week @ 2024-03-18 9/week @ 2024-03-25 40/week @ 2024-04-01

61 downloads per month
Used in 3 crates

MIT/Apache

79KB
2K SLoC

Rust API client for batch_api

A Java client JAR is available for use with the group ID 'com.liferay', artifact ID 'com.liferay.headless.batch.engine.client', and version '1.0.11'.

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: v1.0
  • Package version: v1.0
  • Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder in a directory named batch_api and add the following to Cargo.toml under [dependencies]:

batch_api = { path = "./batch_api" }

Documentation for API Endpoints

All URIs are relative to http://localhost:8080/o/headless-batch-engine

Class Method HTTP request Description
DefaultApi get_open_api GET /v1.0/openapi.{type}
ExportTaskApi get_export_task GET /v1.0/export-task/{exportTaskId}
ExportTaskApi get_export_task_by_external_reference_code GET /v1.0/export-task/by-external-reference-code/{externalReferenceCode}
ExportTaskApi get_export_task_by_external_reference_code_content GET /v1.0/export-task/by-external-reference-code/{externalReferenceCode}/content
ExportTaskApi get_export_task_content GET /v1.0/export-task/{exportTaskId}/content
ExportTaskApi post_export_task POST /v1.0/export-task/{className}/{contentType}
ImportTaskApi delete_import_task1 DELETE /v1.0/import-task/{className}
ImportTaskApi get_import_task GET /v1.0/import-task/{importTaskId}
ImportTaskApi get_import_task_by_external_reference_code GET /v1.0/import-task/by-external-reference-code/{externalReferenceCode}
ImportTaskApi get_import_task_by_external_reference_code_content GET /v1.0/import-task/by-external-reference-code/{externalReferenceCode}/content
ImportTaskApi get_import_task_by_external_reference_code_failed_item_report GET /v1.0/import-task/by-external-reference-code/{externalReferenceCode}/failed-items/report
ImportTaskApi get_import_task_content GET /v1.0/import-task/{importTaskId}/content
ImportTaskApi get_import_task_failed_item_report GET /v1.0/import-task/{importTaskId}/failed-items/report
ImportTaskApi post_import_task1 POST /v1.0/import-task/{className}
ImportTaskApi put_import_task1 PUT /v1.0/import-task/{className}

Documentation For Models

To get access to the crate's generated documentation, use:

cargo doc --open

Author

Dependencies

~7–21MB
~313K SLoC