Skip to content

Commit 0c9bcae

Browse files
committed
Clarified UPGRADING.
1 parent 7f2b73d commit 0c9bcae

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

UPGRADING.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
### Upgrading to >= 3.0.0
44

5-
#### Breaking Model Changes
5+
The 3.0 version introduces numerous improvements along with several *breaking changes*.
6+
7+
#### Model Changes
68

79
The models have been updated and now closer align to the API documentation.
810

@@ -14,9 +16,10 @@ The models have been updated and now closer align to the API documentation.
1416
- `Segment` was renamed to `DetailedSegment`, `SummarySegment` was added and `SegmentStats` was removed
1517
- `SegmentEffort` was renamed to `DetailedSegmentEffort` and `SummarySegmentEffort` was added
1618
- `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
1821

19-
There are several API changes.
22+
#### API Changes
2023

2124
- **Activities:**
2225
- `create_activity()` now returns `DetailedActivity` instead of `Activity`
@@ -46,9 +49,8 @@ There are several API changes.
4649
- `segment()` now returns `DetailedSegment` instead of `Segment`
4750
- `star_segment()` now returns `DetailedSegment` instead of `Segment`
4851

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
5254

5355
See [#96](https://github.com/dblock/strava-ruby-client/pull/96) for details.
5456

@@ -75,7 +77,7 @@ See [#94](https://github.com/dblock/strava-ruby-client/pull/94) for details.
7577

7678
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.
7779

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.
7981

8082
**Before (v2.x):**
8183
```ruby

0 commit comments

Comments
 (0)