You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: UPGRADING.md
+9-7Lines changed: 9 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,9 @@
2
2
3
3
### Upgrading to >= 3.0.0
4
4
5
-
#### Breaking Model Changes
5
+
The 3.0 version introduces numerous improvements along with several *breaking changes*.
6
+
7
+
#### Model Changes
6
8
7
9
The models have been updated and now closer align to the API documentation.
8
10
@@ -14,9 +16,10 @@ The models have been updated and now closer align to the API documentation.
14
16
-`Segment` was renamed to `DetailedSegment`, `SummarySegment` was added and `SegmentStats` was removed
15
17
-`SegmentEffort` was renamed to `DetailedSegmentEffort` and `SummarySegmentEffort` was added
16
18
-`ClubMember` was renamed to `ClubAthlete`, and `ClubAdmin` was removed
17
-
-`RunningRace` was removed, `BaseStream`, `StatsVisibility`, `SummaryPRSegmentEffort`, `UpdatableActivity`, `Xoms`, `Destination`, `LocalLegend` and `Waypoint` were added.
19
+
-`BaseStream`, `StatsVisibility`, `SummaryPRSegmentEffort`, `UpdatableActivity`, `Xoms`, `Destination`, `LocalLegend` and `Waypoint` were added
20
+
-`RunningRace` was removed
18
21
19
-
There are several API changes.
22
+
#### API Changes
20
23
21
24
-**Activities:**
22
25
-`create_activity()` now returns `DetailedActivity` instead of `Activity`
@@ -46,9 +49,8 @@ There are several API changes.
46
49
-`segment()` now returns `DetailedSegment` instead of `Segment`
47
50
-`star_segment()` now returns `DetailedSegment` instead of `Segment`
48
51
49
-
**Removed Methods:**
50
-
51
-
-**`running_race(id)`** - The `client.running_race(id)` method has been removed along with the entire `RunningRaces` endpoint module.
52
+
-**Running Races:**
53
+
-`running_race(id)` has been removed
52
54
53
55
See [#96](https://github.com/dblock/strava-ruby-client/pull/96) for details.
54
56
@@ -75,7 +77,7 @@ See [#94](https://github.com/dblock/strava-ruby-client/pull/94) for details.
75
77
76
78
The `Strava::Webhooks::Models::Event` model has been refactored to map the `object_id` field to `id` for consistency and to resolve `Hashie::Trash` serialization warnings.
77
79
78
-
**Breaking Change**: If you're using webhooks and accessing the `object_id` property, you must now use `id` instead.
80
+
If you're using webhooks and accessing the `object_id` property, you must now use `id` instead.
0 commit comments