sal/rfs-client/openapi/README.md

Rust API client for openapi

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

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

Installation

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

openapi = { path = "./openapi" }

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
AuthenticationApi	sign_in_handler	POST /api/v1/signin
BlockManagementApi	check_block_handler	HEAD /api/v1/block/{hash}	Checks a block by its hash.
BlockManagementApi	get_block_downloads_handler	GET /api/v1/block/{hash}/downloads	Retrieve the number of times a block has been downloaded.
BlockManagementApi	get_block_handler	GET /api/v1/block/{hash}	Retrieve a block by its hash.
BlockManagementApi	get_blocks_by_hash_handler	GET /api/v1/blocks/{hash}	Retrieve blocks by hash (file hash or block hash).
BlockManagementApi	get_user_blocks_handler	GET /api/v1/user/blocks	Retrieve all blocks uploaded by a specific user.
BlockManagementApi	list_blocks_handler	GET /api/v1/blocks	List all block hashes in the server with pagination
BlockManagementApi	upload_block_handler	POST /api/v1/block	Upload a block to the server.
BlockManagementApi	verify_blocks_handler	POST /api/v1/block/verify	Verify if multiple blocks exist on the server.
FileManagementApi	get_file_handler	GET /api/v1/file/{hash}	Retrieve a file by its hash from path, with optional custom filename in request body.
FileManagementApi	upload_file_handler	POST /api/v1/file	Upload a file to the server.
FlistManagementApi	create_flist_handler	POST /api/v1/fl
FlistManagementApi	get_flist_state_handler	GET /api/v1/fl/{job_id}
FlistManagementApi	list_flists_handler	GET /api/v1/fl
FlistManagementApi	preview_flist_handler	GET /api/v1/fl/preview/{flist_path}
FlistManagementApi	serve_flists	GET /{path}	Serve flist files from the server's filesystem
SystemApi	health_check_handler	GET /api/v1
WebsiteServingApi	serve_website_handler	GET /api/v1/website/{website_hash}/{path}

Documentation For Models

• BlockDownloadsResponse
• BlockInfo
• BlockUploadedResponse
• BlocksResponse
• DirListTemplate
• DirLister
• ErrorTemplate
• FileDownloadRequest
• FileInfo
• FileUploadResponse
• FlistBody
• FlistState
• FlistStateAccepted
• FlistStateCreated
• FlistStateInProgress
• FlistStateInfo
• FlistStateResponse
• FlistStateStarted
• HealthResponse
• Job
• ListBlocksParams
• ListBlocksResponse
• PreviewResponse
• ResponseError
• ResponseErrorBadRequest
• ResponseErrorConflict
• ResponseErrorForbidden
• ResponseErrorNotFound
• ResponseErrorTemplateError
• ResponseErrorUnauthorized
• ResponseResult
• ResponseResultBlockUploaded
• ResponseResultDirTemplate
• ResponseResultFileUploaded
• ResponseResultFlistCreated
• ResponseResultFlistState
• ResponseResultFlists
• ResponseResultPreviewFlist
• ResponseResultRes
• ResponseResultSignedIn
• SignInBody
• SignInResponse
• TemplateErr
• TemplateErrBadRequest
• TemplateErrInternalServerError
• TemplateErrNotFound
• UploadBlockParams
• UserBlocksResponse
• VerifyBlock
• VerifyBlocksRequest
• VerifyBlocksResponse

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

cargo doc --open

Author