Module redmine_api::api

source · [−]
Expand description

Redmine API

Redmine Documentation

  • 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

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
  • async support?

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

QueryParams

A structure for query parameters.

Redmine

main API client object

ResponsePage

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.

Pageable

A trait to indicate that an endpoint is pageable.

ParamValue

A trait representing a parameter value.

ReturnsJsonResponse

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)