Skip to content

Commit d85b5a4

Browse files
author
clickingbuttons
authored
Versioning guide (#192)
* copy versioning guide from Go * format and add para
1 parent e90bc58 commit d85b5a4

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,21 @@ but we're open to bug reports and feature requests. Or if you have more general
2222
feedback, feel free to reach out on
2323
our [Slack channel](https://polygon.io/contact).
2424

25+
## Release planning
26+
This client will attempt to follow the release cadence of our API.
27+
When endpoints are deprecated and newer versions are added, the client will
28+
maintain two methods in a backwards compatible way
29+
(e.g. `list_trades` and `list_trades_v4(...)`).
30+
When deprecated endpoints are removed from the API, we'll rename the versioned
31+
method (e.g. `list_trades_v4(...)` -> `list_trades(...)`), remove the old method,
32+
and release a new major version of the client.
33+
34+
The goal is to give users ample time to upgrade to newer versions of our API
35+
_before_ we bump the major version of the client, and in general, we'll try to
36+
bundle breaking changes like this to avoid frequent major version bumps.
37+
38+
Exceptions to this are:
39+
- Methods under `client.vx`. These are expiremental.
40+
- Methods that start with `_*`. We use these internally.
41+
- Type annotations. We may modify these based on our JSON responses.
42+
- We may add model fields.

0 commit comments

Comments
 (0)