feat: implement RFS client with authentication and file management APIs
This commit is contained in:
		
							
								
								
									
										114
									
								
								packages/clients/rfsclient/openapi/README.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										114
									
								
								packages/clients/rfsclient/openapi/README.md
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,114 @@ | ||||
| # 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](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: 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**](docs/AuthenticationApi.md#sign_in_handler) | **POST** /api/v1/signin |  | ||||
| *BlockManagementApi* | [**check_block_handler**](docs/BlockManagementApi.md#check_block_handler) | **HEAD** /api/v1/block/{hash} | Checks a block by its hash. | ||||
| *BlockManagementApi* | [**get_block_downloads_handler**](docs/BlockManagementApi.md#get_block_downloads_handler) | **GET** /api/v1/block/{hash}/downloads | Retrieve the number of times a block has been downloaded. | ||||
| *BlockManagementApi* | [**get_block_handler**](docs/BlockManagementApi.md#get_block_handler) | **GET** /api/v1/block/{hash} | Retrieve a block by its hash. | ||||
| *BlockManagementApi* | [**get_blocks_by_hash_handler**](docs/BlockManagementApi.md#get_blocks_by_hash_handler) | **GET** /api/v1/blocks/{hash} | Retrieve blocks by hash (file hash or block hash). | ||||
| *BlockManagementApi* | [**get_user_blocks_handler**](docs/BlockManagementApi.md#get_user_blocks_handler) | **GET** /api/v1/user/blocks | Retrieve all blocks uploaded by a specific user. | ||||
| *BlockManagementApi* | [**list_blocks_handler**](docs/BlockManagementApi.md#list_blocks_handler) | **GET** /api/v1/blocks | List all block hashes in the server with pagination | ||||
| *BlockManagementApi* | [**upload_block_handler**](docs/BlockManagementApi.md#upload_block_handler) | **POST** /api/v1/block | Upload a block to the server. | ||||
| *BlockManagementApi* | [**verify_blocks_handler**](docs/BlockManagementApi.md#verify_blocks_handler) | **POST** /api/v1/block/verify | Verify if multiple blocks exist on the server. | ||||
| *FileManagementApi* | [**get_file_handler**](docs/FileManagementApi.md#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**](docs/FileManagementApi.md#upload_file_handler) | **POST** /api/v1/file | Upload a file to the server. | ||||
| *FlistManagementApi* | [**create_flist_handler**](docs/FlistManagementApi.md#create_flist_handler) | **POST** /api/v1/fl |  | ||||
| *FlistManagementApi* | [**get_flist_state_handler**](docs/FlistManagementApi.md#get_flist_state_handler) | **GET** /api/v1/fl/{job_id} |  | ||||
| *FlistManagementApi* | [**list_flists_handler**](docs/FlistManagementApi.md#list_flists_handler) | **GET** /api/v1/fl |  | ||||
| *FlistManagementApi* | [**preview_flist_handler**](docs/FlistManagementApi.md#preview_flist_handler) | **GET** /api/v1/fl/preview/{flist_path} |  | ||||
| *FlistManagementApi* | [**serve_flists**](docs/FlistManagementApi.md#serve_flists) | **GET** /{path} | Serve flist files from the server's filesystem | ||||
| *SystemApi* | [**health_check_handler**](docs/SystemApi.md#health_check_handler) | **GET** /api/v1 |  | ||||
| *WebsiteServingApi* | [**serve_website_handler**](docs/WebsiteServingApi.md#serve_website_handler) | **GET** /api/v1/website/{website_hash}/{path} |  | ||||
|  | ||||
|  | ||||
| ## Documentation For Models | ||||
|  | ||||
|  - [BlockDownloadsResponse](docs/BlockDownloadsResponse.md) | ||||
|  - [BlockInfo](docs/BlockInfo.md) | ||||
|  - [BlockUploadedResponse](docs/BlockUploadedResponse.md) | ||||
|  - [BlocksResponse](docs/BlocksResponse.md) | ||||
|  - [DirListTemplate](docs/DirListTemplate.md) | ||||
|  - [DirLister](docs/DirLister.md) | ||||
|  - [ErrorTemplate](docs/ErrorTemplate.md) | ||||
|  - [FileDownloadRequest](docs/FileDownloadRequest.md) | ||||
|  - [FileInfo](docs/FileInfo.md) | ||||
|  - [FileUploadResponse](docs/FileUploadResponse.md) | ||||
|  - [FlistBody](docs/FlistBody.md) | ||||
|  - [FlistState](docs/FlistState.md) | ||||
|  - [FlistStateAccepted](docs/FlistStateAccepted.md) | ||||
|  - [FlistStateCreated](docs/FlistStateCreated.md) | ||||
|  - [FlistStateInProgress](docs/FlistStateInProgress.md) | ||||
|  - [FlistStateInfo](docs/FlistStateInfo.md) | ||||
|  - [FlistStateResponse](docs/FlistStateResponse.md) | ||||
|  - [FlistStateStarted](docs/FlistStateStarted.md) | ||||
|  - [HealthResponse](docs/HealthResponse.md) | ||||
|  - [Job](docs/Job.md) | ||||
|  - [ListBlocksParams](docs/ListBlocksParams.md) | ||||
|  - [ListBlocksResponse](docs/ListBlocksResponse.md) | ||||
|  - [PreviewResponse](docs/PreviewResponse.md) | ||||
|  - [ResponseError](docs/ResponseError.md) | ||||
|  - [ResponseErrorBadRequest](docs/ResponseErrorBadRequest.md) | ||||
|  - [ResponseErrorConflict](docs/ResponseErrorConflict.md) | ||||
|  - [ResponseErrorForbidden](docs/ResponseErrorForbidden.md) | ||||
|  - [ResponseErrorNotFound](docs/ResponseErrorNotFound.md) | ||||
|  - [ResponseErrorTemplateError](docs/ResponseErrorTemplateError.md) | ||||
|  - [ResponseErrorUnauthorized](docs/ResponseErrorUnauthorized.md) | ||||
|  - [ResponseResult](docs/ResponseResult.md) | ||||
|  - [ResponseResultBlockUploaded](docs/ResponseResultBlockUploaded.md) | ||||
|  - [ResponseResultDirTemplate](docs/ResponseResultDirTemplate.md) | ||||
|  - [ResponseResultFileUploaded](docs/ResponseResultFileUploaded.md) | ||||
|  - [ResponseResultFlistCreated](docs/ResponseResultFlistCreated.md) | ||||
|  - [ResponseResultFlistState](docs/ResponseResultFlistState.md) | ||||
|  - [ResponseResultFlists](docs/ResponseResultFlists.md) | ||||
|  - [ResponseResultPreviewFlist](docs/ResponseResultPreviewFlist.md) | ||||
|  - [ResponseResultRes](docs/ResponseResultRes.md) | ||||
|  - [ResponseResultSignedIn](docs/ResponseResultSignedIn.md) | ||||
|  - [SignInBody](docs/SignInBody.md) | ||||
|  - [SignInResponse](docs/SignInResponse.md) | ||||
|  - [TemplateErr](docs/TemplateErr.md) | ||||
|  - [TemplateErrBadRequest](docs/TemplateErrBadRequest.md) | ||||
|  - [TemplateErrInternalServerError](docs/TemplateErrInternalServerError.md) | ||||
|  - [TemplateErrNotFound](docs/TemplateErrNotFound.md) | ||||
|  - [UploadBlockParams](docs/UploadBlockParams.md) | ||||
|  - [UserBlockInfo](docs/UserBlockInfo.md) | ||||
|  - [UserBlocksResponse](docs/UserBlocksResponse.md) | ||||
|  - [VerifyBlock](docs/VerifyBlock.md) | ||||
|  - [VerifyBlocksRequest](docs/VerifyBlocksRequest.md) | ||||
|  - [VerifyBlocksResponse](docs/VerifyBlocksResponse.md) | ||||
|  | ||||
|  | ||||
| To get access to the crate's generated documentation, use: | ||||
|  | ||||
| ``` | ||||
| cargo doc --open | ||||
| ``` | ||||
|  | ||||
| ## Author | ||||
|  | ||||
|  | ||||
|  | ||||
		Reference in New Issue
	
	Block a user