Skip to content

Commit 2a018ff

Browse files
committed
✏️ Fix documentation references to snakes and camels
1 parent cfc3ed4 commit 2a018ff

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,9 +118,9 @@ and this project adheres to [Semantic Versioning v2](https://semver.org/spec/v2.
118118
- [#414](https://gitlab.com/oauth-xx/oauth2/-/merge_requests/414) - Use Base64.strict_encode64 instead of custom internal logic (@meganemura)
119119
- [#489](https://gitlab.com/oauth-xx/oauth2/-/merge_requests/489) - **BREAKING**: Default value for option `OAuth2::Client` - `:authorize_url` removed leading slash to work with relative paths by default (`'oauth/authorize'`) (@ghost)
120120
- [#489](https://gitlab.com/oauth-xx/oauth2/-/merge_requests/489) - **BREAKING**: Default value for option `OAuth2::Client` - `:token_url` removed leading slash to work with relative paths by default (`'oauth/token'`) (@ghost)
121-
- [#507](https://gitlab.com/oauth-xx/oauth2/-/merge_requests/507), [#575](https://gitlab.com/oauth-xx/oauth2/-/merge_requests/575) - **BREAKING**: Transform keys to camel case, always, by default (ultimately via `rash_alt` gem)
121+
- [#507](https://gitlab.com/oauth-xx/oauth2/-/merge_requests/507), [#575](https://gitlab.com/oauth-xx/oauth2/-/merge_requests/575) - **BREAKING**: Transform keys to snake case, always, by default (ultimately via `rash_alt` gem)
122122
- Original keys will still work as previously, in most scenarios, thanks to `rash_alt` gem.
123-
- However, this is a _breaking_ change if you rely on `response.parsed.to_h`, as the keys in the result will be camel case.
123+
- However, this is a _breaking_ change if you rely on `response.parsed.to_h`, as the keys in the result will be snake case.
124124
- As of version 2.0.4 you can turn key transformation off with the `snaky: false` option.
125125
- [#576](https://gitlab.com/oauth-xx/oauth2/-/merge_requests/576) - **BREAKING**: Stop rescuing parsing errors (@pboling)
126126
- [#591](https://gitlab.com/oauth-xx/oauth2/-/merge_requests/576) - _DEPRECATION_: `OAuth2::Client` - `:extract_access_token` option is deprecated

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -255,13 +255,13 @@ For more see [SECURITY.md][🚎sec-pol].
255255
- `:access_token_class` (`AccessToken`); user specified class to use for all calls to `get_token`
256256
- Adds new option to `OAuth2::AccessToken#initialize`:
257257
- `:expires_latency` (`nil`); number of seconds by which AccessToken validity will be reduced to offset latency
258-
- By default, keys are transformed to camel case.
258+
- By default, keys are transformed to snake case.
259259
- Original keys will still work as previously, in most scenarios, thanks to `rash_alt` gem.
260-
- However, this is a _breaking_ change if you rely on `response.parsed.to_h`, as the keys in the result will be camel case.
260+
- However, this is a _breaking_ change if you rely on `response.parsed.to_h` to retain the original case, and the original wasn't snake case, as the keys in the result will be snake case.
261261
- As of version 2.0.4 you can turn key transformation off with the `snaky: false` option.
262262
- By default, the `:auth_scheme` is now `:basic_auth` (instead of `:request_body`)
263263
- Third-party strategies and gems may need to be updated if a provider was requiring client id/secret in the request body
264-
- [... A lot more](https://gitlab.com/oauth-xx/oauth2/-/blob/main/CHANGELOG.md#2.0.0)
264+
- [... A lot more](https://gitlab.com/oauth-xx/oauth2/-/blob/main/CHANGELOG.md#200-2022-06-21-tag)
265265

266266
## Compatibility
267267

oauth2.gemspec

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ You have installed oauth2 version #{OAuth2::Version::VERSION}, congratulations!
2929
There are BREAKING changes if you are upgrading from < v2, but most will not encounter them, and updating your code should be easy!
3030
Please see:
3131
#{spec.homepage}/-/blob/main/SECURITY.md
32-
#{spec.homepage}/-/blob/v#{spec.version}/CHANGELOG.md#2010-2022-09-19
33-
• Summary: #{spec.homepage}#what-is-new-for-v20
32+
#{spec.homepage}/-/blob/v#{spec.version}/CHANGELOG.md#200-2022-06-21-tag
33+
• Summary of most important breaking changes: #{spec.homepage}#what-is-new-for-v20
3434
3535
Major updates:
3636
1. master branch renamed to main

0 commit comments

Comments
 (0)