forked from nightfallai/nightfall-python-sdk
-
Notifications
You must be signed in to change notification settings - Fork 0
/
CHANGELOG
169 lines (116 loc) · 4.53 KB
/
CHANGELOG
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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
Changelog
=========
Here you can see the full list of changes between each Nightfall release.
Version 1.4.1
-------------
Released on July 19, 2022
- Added `commitAuthor` to finding response objects
Version 1.4.0
-------------
Released on February 23, 2022
- Added `policy_uuids` option to text scanning api
- Added `alert_config` option to text and file scanning
- Added `commitHash` to finding response objects
- Added `rowRange` and `columnRange` to finding response objects
- Made some fields `Optional` that were documented to potentially be `None` but not marked as such with types.
- README examples now run as doctests
Version 1.3.0
-------------
Released on January 5, 2022
- Added `default_redaction_config` option to text scanning api
Version 1.2.0
-------------
Released on December 7, 2021
- Added automated retry on 429 responses from the Nightfall Developer Platform
- Added optional `request_metadata` field to file scanning requests
- Fixed file scanning requests for binary files
Version 1.1.1
-------------
Released on November 29, 2021
- Add CONTRIBUTING, CODEOWNERS and update README
- Update User-Agent header
Version 1.1.0
-------------
Released on November 22, 2021
- *[BACKWARDS INCOMPATIBLE]* `validate_webhook` returns False instead of
throwing an exception if the request is invalid
- Added optional context byte setting to scan_text
- Updated Docutils to 0.18
Version 1.0.3
-------------
Released on November 2, 2021
- Bugfix fix classifier on module.
Version 1.0.2
-------------
Released on November 2, 2021
- Bugfix to send detection rule name in request.
Version 1.0.1
-------------
Released on November 1, 2021
- Updated documentation link
Version 1.0.0
-------------
Released on November 1, 2021
- Revised to use Nightfall v3 API.
- Add in file scanning functionality.
.. warning::
This is a breaking change compared to all versions before it, using
Nightfall's new APIs and adding in file scanning. Please check the
new methods provided to migrate from the older API.
Version 0.6.0
-------------
Released on July 25, 2021
- Update scan and chunking interface to handle dict with multiple items
instead of list of dicts.
.. warning::
This is a breaking change compared to version 0.5.0, but all users are
recommended to upgrade to this version. This version represents an
improvement on the previous iteration where instead of handling a list of
dicts, we now handle a single dict with multiple entries. This simplifies
the library code and makes the interface much more usable.
The previous version of the SDK required users to pass in a list of dicts.
We now require users to pass in a single dict with multiple entries.
``nightfall.scan([{'id': 'string}])`` should now be
``nightfall.scan({'id': 'string'})``.
Version 0.5.0
-------------
Released on July 12, 2021
- Publish Sphinx docs to GitHub pages
- Split up unit and integration tests, use mocking for unit tests
- Update scan and chunking method to scan strings from a dict
- Stop attempting to split strings and instead raise an exception
- Redefine ``MAX_PAYLOAD_SIZE`` constant to be actual max of 500_000 bytes
- Updated documentation to illustrate how to use debug logging with this library
.. warning::
Scanning dicts instead of strings is a breaking change. Previous versions
of the SDK accepted a list of strings for scanning. We now require users
to pass in a list of dicts instead. ``nightfall.scan(['string'])`` should
now be ``nightfall.scan([{'id': 'string'}])``. This allows you to keep
track of the reference of where the string came from for further processing.
Version 0.4.0
-------------
Released on June 20, 2021
- Add debug logs to Nightfall module
- Change primary class name from ``Api`` to ``Nightfall`` to make things a bit
more clear when this library is used in other programs and allow ``from
nightfall import Nightfall``
.. warning::
This is a breaking change, since the previous version of this SDK
imported Nightfall using ``from nightfall.api import Api``
Version 0.3.0
-------------
Released on June 13, 2021
- Implement basic chunking algorithm to split payloads per the API limits.
Version 0.2.0
-------------
.. note::
This is an initial Beta release.
Released on June 13, 2021
- Basic project tooling put into place.
- Continuous Integration with GitHub Actions
- Packaging and uploading to PyPI
- Code Coverage
- Testing with unittest
- Basic Documentation in place
- Add support for using the API with a token
- Add support for scan API endpoint