Expand description
Redmine API
- authentication
-
pagination
- add Pageable instances to all types that need them
- figure out a way to write a general “fetch all pages” function (problem is the different key name in the wrapper)
- impersonation
- attachments
-
add all the wrappers I somehow missed
- check if admin and send_information truly are not part of the user hash in Create/UpdateUser or if the wiki docs are wrong (admin is, send_information is not)
- test include parameters and add relevant data to the return types
- async support
Potential breaking changes ahead
- use Enum for sort column
- typed ids
- change project_id_or_name to Enum
- extra filter expressions I overlooked/did not know about
- parameters that are more flexible than they appear
Modules§
- attachments
- Attachments Rest API Endpoint definitions
- custom_
fields - Custom Fields Rest API Endpoint definitions
- enumerations
- Enumerations Rest API Endpoint definitions
- files
- Files Rest API Endpoint definitions
- groups
- Groups Rest API Endpoint definitions
- issue_
categories - Issue Categories Rest API Endpoint definitions
- issue_
relations - Issue Relations Rest API Endpoint definitions
- issue_
statuses - Issue Statuses Rest API Endpoint definitions
- issues
- Issues Rest API Endpoint definitions
- my_
account - My Account Rest API Endpoint definitions
- news
- News Rest API Endpoint definitions
- project_
memberships - Project Memberships Rest API Endpoint definitions
- projects
- Projects Rest API Endpoint definitions
- queries
- Queries Rest API Endpoint definitions
- roles
- Roles Rest API Endpoint definitions
- search
- Search Rest API Endpoint definitions
- time_
entries - Time Entries Rest API Endpoint definitions
- trackers
- Trackers Rest API Endpoint definitions
- uploads
- Uploads Rest API Endpoint definitions
- users
- Users Rest API Endpoint definitions
- versions
- Versions Rest API Endpoint definitions
- wiki_
pages - Wiki Pages Rest API Endpoint definitions
Structs§
- Query
Params - A structure for query parameters.
- Redmine
- main API client object (sync)
- Redmine
Async - main API client object (async)
- Response
Page - Return value from paged requests, includes the actual value as well as pagination data
Traits§
- Endpoint
- A trait for providing the necessary information for a single REST API endpoint.
- NoPagination
- A trait to indicate that an endpoint requires pagination to yield all results or in other words that the non-pagination API should not be used on it or one might miss some results
- Pageable
- A trait to indicate that an endpoint is pageable.
- Param
Value - A trait representing a parameter value.
- Returns
Json Response - A trait to indicate that an endpoint is expected to return a JSON result
Functions§
- deserialize_
optional_ rfc3339 - helper to parse created_on and updated_on in the correct format (default time serde implementation seems to use a different format)
- deserialize_
rfc3339 - helper to parse created_on and updated_on in the correct format (default time serde implementation seems to use a different format)
- serialize_
optional_ rfc3339 - helper to serialize created_on and updated_on in the correct format (default time serde implementation seems to use a different format)
- serialize_
rfc3339 - helper to serialize created_on and updated_on in the correct format (default time serde implementation seems to use a different format)