.. | ||
.openapi-generator | ||
docs | ||
src | ||
.gitignore | ||
.openapi-generator-ignore | ||
.travis.yml | ||
Cargo.toml | ||
git_push.sh | ||
README.md |
Rust API client for openapi
This is an auto generated API description made out of an Ent schema definition
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.1.0
- Package version: 0.1.0
- Generator version: 7.4.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 |
---|---|---|---|
CardApi | create_card | POST /cards | Create a new Card |
CardApi | delete_card | DELETE /cards/{id} | Deletes a Card by ID |
CardApi | draw_done | PUT /cards/{id}/d | Draws a card item as done. |
CardApi | draw_start | PATCH /users/{id}/card/start | Draws a card item as done. |
CardApi | list_card | GET /cards | List Cards |
CardApi | read_card | GET /cards/{id} | Find a Card by ID |
CardApi | read_card_owner | GET /cards/{id}/owner | Find the attached User |
CardApi | update_card | PATCH /cards/{id} | Updates a Card |
GroupApi | create_group | POST /groups | Create a new Group |
GroupApi | delete_group | DELETE /groups/{id} | Deletes a Group by ID |
GroupApi | list_group | GET /groups | List Groups |
GroupApi | list_group_users | GET /groups/{id}/users | List attached Users |
GroupApi | read_group | GET /groups/{id} | Find a Group by ID |
GroupApi | update_group | PATCH /groups/{id} | Updates a Group |
UeApi | create_ue | POST /ues | Create a new Ue |
UeApi | delete_ue | DELETE /ues/{id} | Deletes a Ue by ID |
UeApi | list_ue | GET /ues | List Ues |
UeApi | read_ue | GET /ues/{id} | Find a Ue by ID |
UeApi | read_ue_owner | GET /ues/{id}/owner | Find the attached User |
UeApi | update_ue | PATCH /ues/{id} | Updates a Ue |
UserApi | create_user | POST /users | Create a new User |
UserApi | delete_user | DELETE /users/{id} | Deletes a User by ID |
UserApi | list_user | GET /users | List Users |
UserApi | list_user_card | GET /users/{id}/card | List attached Cards |
UserApi | list_user_ue | GET /users/{id}/ue | List attached Ues |
UserApi | read_user | GET /users/{id} | Find a User by ID |
UserApi | update_user | PATCH /users/{id} | Updates a User |
Documentation For Models
- Card
- CardCreate
- CardList
- CardOwnerRead
- CardRead
- CardUpdate
- CreateCardRequest
- CreateGroupRequest
- CreateUeRequest
- CreateUserRequest
- Group
- GroupCreate
- GroupList
- GroupRead
- GroupUpdate
- GroupUsersList
- ListCard400Response
- Ue
- UeCreate
- UeList
- UeOwnerRead
- UeRead
- UeUpdate
- UpdateCardRequest
- UpdateGroupRequest
- UpdateUeRequest
- UpdateUserRequest
- User
- UserCardList
- UserCreate
- UserList
- UserRead
- UserUeList
- UserUpdate
To get access to the crate's generated documentation, use:
cargo doc --open