File: changelog.rst

package info (click to toggle)
python-rt 3.2.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 516 kB
  • sloc: python: 3,144; makefile: 141; sh: 7
file content (143 lines) | stat: -rw-r--r-- 4,090 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
Change Log
==========

Version 3.2.0 (2024-09-06)
----------------------------
Added
^^^^^
- Added option for custom list of fields to be populated for search "query_format" param to avoid unnecessary round trips to get fields like Told, Starts, Resolved, etc by returning the required fields during search. (see #97 @nerdfirefighter)

Version 3.1.4 (2024-02-16)
----------------------------
Fixes
^^^^^
- Add a workaround for a breaking change introduced in RT5.0.5 which returns undefined pages variable for non-superusers (see #93 #94).

Version 3.1.3 (2023-10-10)
----------------------------
Fixes
^^^^^
- Fix an issue where no e-mail was sent on ticket creation due to suggesting to use *Requestors* instead of *Requestor* (https://github.com/python-rt/python-rt/pull/92).

Version 3.1.2 (2023-09-25)
----------------------------
Fixes
^^^^^
- Revert breaking change for python3.8 (collections.abc.AsyncIterator is not subscriptable).

Version 3.1.1 (2023-09-25)
----------------------------
Fixes
^^^^^
- In AsyncRt, instead of returning sequences, return AsyncIterators.

Version 3.1.0 (2023-09-25)
----------------------------
Changes
^^^^^^^
- Replace *requests* with *httpx* for the REST2 part.

Added
^^^^^
- Add a new *AsyncRt* class which implements the RT REST2 API in asnyc.
- Adapt tests to include thew new async parts of this library.

Version 3.0.7 (2023-07-27)
----------------------------
Fixes
^^^^^
- Fix sorting when using search() method (#90)

Version 3.0.6 (2023-06-21)
----------------------------
Fixes
^^^^^
- Fixed bug in rest1 (#86)

Version 3.0.5 (2023-02-02)
----------------------------
Fixes
^^^^^
- Added support for specifying custom fields on user creation/edit (#82).

Version 3.0.4 (2022-11-08)
----------------------------
Fixes
^^^^^
- Workaround for parsing issues with tickets with only 1 attachment (#80), due to probably an upstream bug.

Version 3.0.3 (2022-06-16)
----------------------------
Changes
^^^^^^^
- Move package metadata and configuration from setup.cfg to pyproject.toml.

Version 3.0.2 (2022-06-12)
----------------------------
Fixes
^^^^^
- Fix edit_user() response handling in case a user_id name (str) was passed instead of a number.

Version 3.0.1 (2022-05-26)
----------------------------
Fixes
^^^^^
- Make sure to include _hyperlinks in history items
- On edit ticket, raise exception if user/queue does not exist

Added
^^^^^
- Add helper method for deleting tickets
- Add tests

Version 3.0.0 (2022-05-17)
----------------------------
The following is a major release of the `rt` library.
There is support for the REST API version 1 as well as version 2.
Please note that this release contains breaking changes and requires adaptations to existing code, even if you are
sticking to version 1 of the API.
These changes were necessary in order to properly support both API versions.

Importing
^^^^^^^^^
Previously doing:

    .. code-block:: python

        import rt
        c = rt.Rt(...)

was enough to import the main class `Rt` as well as all exception classes.
Starting with version 3, only the main exception class `RtError` is imported when importing the `rt` module.

In order to continue using the API version 1 you need to explicitly import it from the `rest1` submodule:

    .. code-block:: python

        import rt.rest1
        c = rt.rest1.Rt(...)

If you need access to specific exception class, make sure to import the exceptions module:

    .. code-block:: python

        import rt.exceptions

Everything else is the same as with version 2 of the library.

.. WARNING::
    The minimum supported version of python has been raised to 3.7.

Exception classes
^^^^^^^^^^^^^^^^^^
Some exception classes were renamed to follow proper naming scheme (https://peps.python.org/pep-0008/#exception-names):

.. csv-table::
   :header: "<3.0.0", ">=3.0.0"
   :widths: 15, 15

    "NotAllowed", "NotAllowedError"
    "UnexpectedResponse", "UnexpectedResponseError"
    "UnexpectedMessageFormat", "UnexpectedMessageFormatError"
    "InvalidUseError", "InvalidUseError"
    "BadRequestError", "BadRequestError"