Skip to content

add deprecation notices to API reference #525

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
andrewkmin wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

add deprecation notices to API reference #525

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions api-reference/activities/create-read-write-session.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ import { EndpointPath } from "/snippets/api/endpoint.mdx";

<EndpointPath type="submit" path="create_read_write_session" />

<Warning>
This activity is deprecated. Use [Login with a Stamp](/api-reference/activities/login-with-a-stamp), [Login with OAuth](/api-reference/activities/login-with-oauth), or [Login with OTP](/api-reference/activities/login-with-otp) for session creation instead.
</Warning>

<Authorizations />

<H3Bordered text="Body" />
Expand Down
4 changes: 4 additions & 0 deletions api-reference/activities/init-email-recovery.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ import { EndpointPath } from "/snippets/api/endpoint.mdx";

<EndpointPath type="submit" path="init_user_email_recovery" />

<Warning>
This activity is deprecated. Use [Init Generic OTP](/api-reference/activities/init-generic-otp) to initiate a recovery flow combined with [Recover a User](/api-reference/activities/recover-a-user) instead.
</Warning>

<Authorizations />

<H3Bordered text="Body" />
Expand Down
4 changes: 4 additions & 0 deletions api-reference/activities/init-otp-auth.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ import { EndpointPath } from "/snippets/api/endpoint.mdx";

<EndpointPath type="submit" path="init_otp_auth" />

<Warning>
This activity is deprecated. Use [Init Generic OTP](/api-reference/activities/init-generic-otp) instead.
</Warning>

<Authorizations />

<H3Bordered text="Body" />
Expand Down
4 changes: 4 additions & 0 deletions api-reference/activities/oauth.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ import { EndpointPath } from "/snippets/api/endpoint.mdx";

<EndpointPath type="submit" path="oauth" />

<Warning>
This activity is deprecated. Use [Login with OAuth](/api-reference/activities/login-with-oauth) instead.
</Warning>

<Authorizations />

<H3Bordered text="Body" />
Expand Down
4 changes: 4 additions & 0 deletions api-reference/activities/otp-auth.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ import { EndpointPath } from "/snippets/api/endpoint.mdx";

<EndpointPath type="submit" path="otp_auth" />

<Warning>
This activity is deprecated. Use [Login with OTP](/api-reference/activities/login-with-otp) instead.
</Warning>

<Authorizations />

<H3Bordered text="Body" />
Expand Down
4 changes: 4 additions & 0 deletions api-reference/activities/perform-email-auth.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ import { EndpointPath } from "/snippets/api/endpoint.mdx";

<EndpointPath type="submit" path="email_auth" />

<Warning>
This activity is deprecated. Use [Init Generic OTP](/api-reference/activities/init-generic-otp) followed by [Login with OTP](/api-reference/activities/login-with-otp) instead.
</Warning>

<Authorizations />

<H3Bordered text="Body" />
Expand Down
4 changes: 4 additions & 0 deletions api-reference/activities/update-user.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ import { EndpointPath } from "/snippets/api/endpoint.mdx";

<EndpointPath type="submit" path="update_user" />

<Warning>
This activity is deprecated. Use the specific update activities instead: [Update User's Email](/api-reference/activities/update-users-email), [Update User's Name](/api-reference/activities/update-users-name), or [Update User's Phone Number](/api-reference/activities/update-users-phone-number).
</Warning>

<Authorizations />

<H3Bordered text="Body" />
Expand Down