|
1 | | -# Changelog and versioning |
| 1 | +# Changelog |
2 | 2 |
|
3 | | -## Versioning Policy |
4 | 3 |
|
5 | | -Our API and its client libraries adopt MAJOR.MINOR.PATCH format |
6 | | -for version numbers. These version numbers conform to |
7 | | -[semantic versioning](https://semver.org). This means that you can upgrade |
8 | | -minor or patch versions to pick up new functionality and fixes, without breaking |
9 | | -your integration. |
10 | | - |
11 | | -Most often, we introduce backward-compatible changes between minor versions |
12 | | -in the form of: |
13 | | - |
14 | | -- New data schemas or encodings |
15 | | -- Additional fields to existing data schemas |
16 | | -- Additional batch download customizations |
17 | | - |
18 | | -Our API and official client libraries are kept in sync with same-day releases |
19 | | -for major and minor versions. For instance, `v1.2.x` of the Python client |
20 | | -library will use the same functionality found in `v1.2.y` of the HTTP API. |
21 | | - |
22 | | -Each major version is guaranteed to operate for two years after the date |
23 | | -of the subsequent major release. For example, if `v2.0.0` is released on |
24 | | -January 1, 2022, then all versions `v1.x.y` of the API and client libraries |
25 | | -are deprecated after January 1, 2024. When a version is deprecated, |
26 | | -any calls made to the API will be defaulted to the next oldest, usable version. |
27 | | -However, you should assume that the calls will not work. Likewise, the client |
28 | | -libraries rely on the API and cannot be assumed to work against later versions |
29 | | -of the API. |
30 | | - |
31 | | -We recommend to pin your version requirements against `0.x.*` or `0.x.y`. |
32 | | -Either one of the following is fine: |
33 | | - |
34 | | -- `databento>=0.2,<1.0` |
35 | | -- `databento==0.3.0` |
36 | | - |
37 | | -Additionally note: |
38 | | -- All undocumented APIs are considered internal. They are not part of this contract. |
39 | | - |
40 | | -- Certain features (e.g. integrations) may be explicitly called out as |
41 | | -"experimental" or "unstable" in the documentation. |
42 | | - |
43 | | - |
44 | | - |
45 | | -## 0.2.0 - 2021-12-10 |
46 | | - - Added backend endpoint APIs |
47 | | - - Added async stream support |
48 | | - - Added `Bento` convenience objects |
49 | | - - Updated Changelog and versioning policy |
50 | | - |
51 | | -## 0.1.0 - 2021-08-30 |
52 | | - - Added support for remote procedure call (RPC) streaming requests |
53 | | - - Refactored legacy code |
| 4 | +## 0.3.0 - 2022-08-30 |
| 5 | + - Initial release |
0 commit comments