Skip to content

Commit 8b0db42

Browse files
author
Brett Chaldecott
committed
feat: added extra path documentation
1 parent 70b7ff0 commit 8b0db42

File tree

1 file changed

+30
-1
lines changed

1 file changed

+30
-1
lines changed

src/content/docs/developer-tools/sdks/backend/ruby-sdk.mdx

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ If you decide instead to use the rails engine, you can add the following to your
154154
mount KindeSdk::Engine, at: "/kinde_sdk"
155155
```
156156

157-
### Usage
157+
### Usage the AuthController in your application
158158
To use the AuthController consume the routes in your application. For example in a Rails view file use the auth path to trigger the login flow:
159159

160160
```ruby
@@ -164,6 +164,35 @@ To use the AuthController consume the routes in your application. For example in
164164
</a>
165165
</div>
166166
```
167+
The full list of paths exposed by the controller are the following:
168+
169+
```ruby
170+
kinde_sdk_auth_path
171+
kinde_sdk_callback_path
172+
kinde_sdk_logout_path
173+
kinde_sdk_logout_callback_path
174+
kinde_sdk_client_credentials_auth_path
175+
```
176+
177+
#### Using the engine
178+
When using the AuthController with the engine your application can use the paths as follows:
179+
180+
```ruby
181+
<div class="buttons">
182+
<a class="button is-primary" href="<%= kinde_sdk.auth_path %>">
183+
<strong>Log in</strong>
184+
</a>
185+
</div>
186+
```
187+
The full list of paths exposed by the engine are the following:
188+
189+
```ruby
190+
kinde_sdk.auth_path
191+
kinde_sdk.callback_path
192+
kinde_sdk.logout_path
193+
kinde_sdk.logout_callback_path
194+
kinde_sdk.client_credentials_auth_path
195+
```
167196

168197
## Sign in and registration
169198

0 commit comments

Comments
 (0)