Rust API client for tapis-files
The Tapis Files API provides for management of file resources on Tapis systems
For more information, please visit https://tapis-project.org
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.8.2
- Package version: 0.2.0
- Generator version: 7.18.0
- Build package:
org.openapitools.codegen.languages.RustClientCodegen
Installation
Put the package under your project folder in a directory named tapis-files and add the following to Cargo.toml under [dependencies]:
tapis-files = { path = "./tapis-files" }
Documentation for API Endpoints
All URIs are relative to http://localhost:8080
| Class | Method | HTTP request | Description |
|---|---|---|---|
| ContentApi | get_contents | GET /v3/files/content/{systemId}/{path} | |
| FileOperationsApi | delete | DELETE /v3/files/ops/{systemId}/{path} | |
| FileOperationsApi | get_facl | GET /v3/files/utils/linux/facl/{systemId}/{path} | |
| FileOperationsApi | get_stat_info | GET /v3/files/utils/linux/{systemId}/{path} | |
| FileOperationsApi | insert | POST /v3/files/ops/{systemId}/{path} | |
| FileOperationsApi | list_files | GET /v3/files/ops/{systemId}/{path} | |
| FileOperationsApi | mkdir | POST /v3/files/ops/{systemId} | |
| FileOperationsApi | move_copy | PUT /v3/files/ops/{systemId}/{path} | |
| FileOperationsApi | run_linux_native_op | POST /v3/files/utils/linux/{systemId}/{path} | |
| FileOperationsApi | set_facl | POST /v3/files/utils/linux/facl/{systemId}/{path} | |
| GeneralApi | health_check | GET /v3/files/healthcheck | |
| GeneralApi | ready_check | GET /v3/files/readycheck | |
| PermissionsApi | delete_permissions | DELETE /v3/files/permissions/{systemId}/{path} | |
| PermissionsApi | get_permissions | GET /v3/files/permissions/{systemId}/{path} | |
| PermissionsApi | grant_permissions | POST /v3/files/permissions/{systemId}/{path} | |
| PostItsApi | create_post_it | POST /v3/files/postits/{systemId}/{path} | Create a PostIt |
| PostItsApi | delete_post_it | DELETE /v3/files/postits/{postitId} | Delete a PostIt |
| PostItsApi | get_post_it | GET /v3/files/postits/{postitId} | Get PostIt. |
| PostItsApi | list_post_its | GET /v3/files/postits | List PostIts. |
| PostItsApi | redeem_post_it | GET /v3/files/postits/redeem/{postitId} | Redeem PostIt. |
| PostItsApi | update_post_it | PATCH /v3/files/postits/{postitId} | Modify a PostIt |
| SharingApi | get_share_info | GET /v3/files/share/{systemId}/{path} | Retrieve all sharing information for a path on a system |
| SharingApi | share_path | POST /v3/files/share/{systemId}/{path} | Share a path on a system with one or more users. |
| SharingApi | share_path_public | POST /v3/files/share_public/{systemId}/{path} | Share a path on a system publicly with all users in the tenant. |
| SharingApi | un_share_path | POST /v3/files/unshare/{systemId}/{path} | Unshare a path on a system with one or more users. |
| SharingApi | un_share_path_all | POST /v3/files/unshare_all/{systemId}/{path} | Remove all shares for a path on a system including public access. |
| SharingApi | un_share_path_public | POST /v3/files/unshare_public/{systemId}/{path} | Remove public access for a path on a system. |
| TransfersApi | cancel_transfer_task | DELETE /v3/files/transfers/{transferTaskId} | |
| TransfersApi | create_transfer_task | POST /v3/files/transfers | |
| TransfersApi | get_recent_transfer_tasks | GET /v3/files/transfers | |
| TransfersApi | get_transfer_task | GET /v3/files/transfers/{transferTaskId} | |
| TransfersApi | get_transfer_task_details | GET /v3/files/transfers/{transferTaskId}/details |
Documentation For Models
- AclEntryInfo
- CreatePermissionRequest
- CreatePostItRequest
- FileInfo
- FileListingResponse
- FilePermission
- FilePermissionResponse
- FileStatInfo
- FileStatInfoResponse
- FileStringResponse
- FileTypeEnum
- HeaderByteRange
- ListTypeEnum
- MkdirRequest
- MoveCopyRequest
- NativeLinuxGetFaclResponse
- NativeLinuxOpRequest
- NativeLinuxOpResponse
- NativeLinuxOpResultResponse
- NativeLinuxSetFaclRequest
- NativeLinuxSetFaclResponse
- NativeLinuxSetFaclResult
- PermEnum
- PostIt
- PostItListResponse
- PostItResponse
- ReqShareUpdate
- ReqTransfer
- ReqTransferElement
- RespBasic
- RespChangeCount
- RespFileList
- RespShareInfo
- RespString
- ResultChangeCount
- ResultShareInfo
- ShareFileRequest
- SharedFileObject
- StringResponse
- TransferStatusEnum
- TransferTask
- TransferTaskChild
- TransferTaskListResponse
- TransferTaskParent
- TransferTaskResponse
- UpdatePostItRequest
- UserShareInfo
To get access to the crate's generated documentation, use:
cargo doc --open