Skip to content

Improv/openapi request #985

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

Merged
bcbogdan merged 27 commits into from
Apr 18, 2025
Merged

Improv/openapi request #985

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
46f4908
Add a function to generate code samples from open api specs
bcbogdan Mar 11, 2025
8e3d1d9
Add components to render the api requests
bcbogdan Mar 18, 2025
a4aa7ff
Fix styling
bcbogdan Mar 25, 2025
e666ec1
Merge branch 'master' into improv/openapi-request
bcbogdan Mar 27, 2025
c0c4887
Update folder structure
bcbogdan Mar 27, 2025
da07d9c
Add tests
bcbogdan Mar 28, 2025
5979cf6
Merge branch 'master' into improv/openapi-request
bcbogdan Mar 28, 2025
0cd65ac
Fix cdi files
bcbogdan Mar 29, 2025
91aaf4b
Fix accordion style
bcbogdan Apr 7, 2025
36d1908
Use scalar to parse openapi docs
bcbogdan Apr 7, 2025
d4deee6
Add authorization
bcbogdan Apr 9, 2025
a25cbf5
Update to the lastest cdi version
bcbogdan Apr 9, 2025
e68b330
Add summaries and descriptions
bcbogdan Apr 9, 2025
e928a99
Update styles
bcbogdan Apr 10, 2025
56b0f65
Extend code snippets
bcbogdan Apr 10, 2025
ba5537e
Styling fixes
bcbogdan Apr 10, 2025
181c0c5
Update cdi references
bcbogdan Apr 10, 2025
37bd408
Merge branch 'master' into improv/openapi-request
bcbogdan Apr 14, 2025
5e7c938
Styling fix
bcbogdan Apr 14, 2025
8f50d2a
Add missing endpoints
bcbogdan Apr 14, 2025
646b3ee
Remove coming soon
bcbogdan Apr 15, 2025
8f3648d
Add loading skeleton
bcbogdan Apr 15, 2025
5ef3ef6
Fix rendering
bcbogdan Apr 15, 2025
42e6979
Fix endpoint names
bcbogdan Apr 18, 2025
0f00f19
Update seo descriptions
bcbogdan Apr 18, 2025
1eeb9c1
Trigger preview deploy
bcbogdan Apr 18, 2025
c3b013b
Add missing cdi endpoints
bcbogdan Apr 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
9 changes: 9 additions & 0 deletions bunfig.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
[test]
# Enable React and JSX support in tests
jsx = true
# Use Jest-compatible expect API
jsdom = true

[test.environment]
# Enable DOM globals like window and document (using jsdom)
DOM = true
6 changes: 3 additions & 3 deletions docs/additional-verification/mfa/email-sms-otp/otp-for-all-users.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ supertokens.init({
<BackendTabs.TabItem value="go">

:::note
Coming soon. In the meantime, checkout the [legacy method](../legacy-method/how-it-works) for adding MFA to your app.
At the moment this feature is not supported through the Go SDK.
:::

</BackendTabs.TabItem>
Expand Down Expand Up @@ -641,7 +641,7 @@ supertokens.init({
<BackendTabs.TabItem value="go">

:::note
Coming soon. In the meantime, checkout the [legacy method](../legacy-method/how-it-works) for adding MFA to your app.
At the moment this feature is not supported through the Go SDK.
:::

</BackendTabs.TabItem>
Expand Down Expand Up @@ -738,7 +738,7 @@ async function createNewTenant() {
<BackendTabs.TabItem value="go">

:::note
Coming soon. In the meantime, checkout the [legacy method](../legacy-method/how-it-works) for adding MFA to your app.
At the moment this feature is not supported through the Go SDK.
:::

</BackendTabs.TabItem>
Expand Down
12 changes: 6 additions & 6 deletions docs/additional-verification/mfa/email-sms-otp/otp-for-opt-in-users.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ supertokens.init({
<BackendTabs.TabItem value="go">

:::note
Coming soon. In the meantime, checkout the [legacy method](../legacy-method/how-it-works) for adding MFA to your app.
At the moment this feature is not supported through the Go SDK.
:::

</BackendTabs.TabItem>
Expand Down Expand Up @@ -335,7 +335,7 @@ supertokens.init({
<BackendTabs.TabItem value="go">

:::note
Coming soon. In the meantime, checkout the [legacy method](../legacy-method/how-it-works) for adding MFA to your app.
At the moment this feature is not supported through the Go SDK.
:::

</BackendTabs.TabItem>
Expand Down Expand Up @@ -525,7 +525,7 @@ async function isOTPEmailEnabledForUser(userId: string) {
<BackendTabs.TabItem value="go">

:::note
Coming soon. In the meantime, checkout the [legacy method](../legacy-method/how-it-works) for adding MFA to your app.
At the moment this feature is not supported through the Go SDK.
:::

</BackendTabs.TabItem>
Expand Down Expand Up @@ -564,7 +564,7 @@ async function disableMFAForUser(userId: string) {
<BackendTabs.TabItem value="go">

:::note
Coming soon. In the meantime, checkout the [legacy method](../legacy-method/how-it-works) for adding MFA to your app.
At the moment this feature is not supported through the Go SDK.
:::

</BackendTabs.TabItem>
Expand Down Expand Up @@ -697,7 +697,7 @@ supertokens.init({
<BackendTabs.TabItem value="go">

:::note
Coming soon. In the meantime, checkout the [legacy method](../legacy-method/how-it-works) for adding MFA to your app.
At the moment this feature is not supported through the Go SDK.
:::

</BackendTabs.TabItem>
Expand Down Expand Up @@ -920,7 +920,7 @@ supertokens.init({
<BackendTabs.TabItem value="go">

:::note
Coming soon. In the meantime, checkout the [legacy method](../legacy-method/how-it-works) for adding MFA to your app.
At the moment this feature is not supported through the Go SDK.
:::

</BackendTabs.TabItem>
Expand Down
26 changes: 13 additions & 13 deletions docs/additional-verification/mfa/initial-setup.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ SuperTokens.init({
<BackendTabs.TabItem value="go">

:::note
Coming soon. In the meantime, checkout the [legacy method](./legacy-method/how-it-works) for adding MFA to your app.
At the moment this feature is not supported through the Go SDK.
:::

</BackendTabs.TabItem>
Expand Down Expand Up @@ -220,7 +220,7 @@ supertokens.init({
<BackendTabs.TabItem value="go">

:::note
Coming soon. In the meantime, checkout the [legacy method](./legacy-method/how-it-works) for adding MFA to your app.
At the moment this feature is not supported through the Go SDK.
:::

</BackendTabs.TabItem>
Expand Down Expand Up @@ -296,7 +296,7 @@ async function createNewTenant() {
<BackendTabs.TabItem value="go">

:::note
Coming soon. In the meantime, checkout the [legacy method](./legacy-method/how-it-works) for adding MFA to your app.
At the moment this feature is not supported through the Go SDK.
:::

</BackendTabs.TabItem>
Expand Down Expand Up @@ -459,7 +459,7 @@ SuperTokens.init({
<BackendTabs.TabItem value="go">

:::note
Coming soon. In the meantime, checkout the [legacy method](./legacy-method/how-it-works) for adding MFA to your app.
At the moment this feature is not supported through the Go SDK.
:::

</BackendTabs.TabItem>
Expand Down Expand Up @@ -590,7 +590,7 @@ supertokens.init({
<BackendTabs.TabItem value="go">

:::note
Coming soon. In the meantime, checkout the [legacy method](./legacy-method/how-it-works) for adding MFA to your app.
At the moment this feature is not supported through the Go SDK.
:::

</BackendTabs.TabItem>
Expand Down Expand Up @@ -699,7 +699,7 @@ supertokens.init({
<BackendTabs.TabItem value="go">

:::note
Coming soon. In the meantime, checkout the [legacy method](./legacy-method/how-it-works) for adding MFA to your app.
At the moment this feature is not supported through the Go SDK.
:::

</BackendTabs.TabItem>
Expand Down Expand Up @@ -811,7 +811,7 @@ supertokens.init({
<BackendTabs.TabItem value="go">

:::note
Coming soon. In the meantime, checkout the [legacy method](./legacy-method/how-it-works) for adding MFA to your app.
At the moment this feature is not supported through the Go SDK.
:::

</BackendTabs.TabItem>
Expand Down Expand Up @@ -928,7 +928,7 @@ If you add more than one item in this array, it means that the user must complet
<BackendTabs.TabItem value="go">

:::note
Coming soon. In the meantime, checkout the [legacy method](./legacy-method/how-it-works) for adding MFA to your app.
At the moment this feature is not supported through the Go SDK.
:::

</BackendTabs.TabItem>
Expand Down Expand Up @@ -1071,7 +1071,7 @@ supertokens.init({
<BackendTabs.TabItem value="go">

:::note
Coming soon. In the meantime, checkout the [legacy method](./legacy-method/how-it-works) for adding MFA to your app.
At the moment this feature is not supported through the Go SDK.
:::

</BackendTabs.TabItem>
Expand Down Expand Up @@ -1157,7 +1157,7 @@ async function enableMFAForUser(userId: string) {
<BackendTabs.TabItem value="go">

:::note
Coming soon. In the meantime, checkout the [legacy method](./legacy-method/how-it-works) for adding MFA to your app.
At the moment this feature is not supported through the Go SDK.
:::

</BackendTabs.TabItem>
Expand Down Expand Up @@ -1245,7 +1245,7 @@ supertokens.init({
<BackendTabs.TabItem value="go">

:::note
Coming soon. In the meantime, checkout the [legacy method](./legacy-method/how-it-works) for adding MFA to your app.
At the moment this feature is not supported through the Go SDK.
:::

</BackendTabs.TabItem>
Expand Down Expand Up @@ -1334,7 +1334,7 @@ async function isTotpEnabledForUser(userId: string) {
<BackendTabs.TabItem value="go">

:::note
Coming soon. In the meantime, checkout the [legacy method](./legacy-method/how-it-works) for adding MFA to your app.
At the moment this feature is not supported through the Go SDK.
:::

</BackendTabs.TabItem>
Expand Down Expand Up @@ -1394,7 +1394,7 @@ async function isTotpSetupForUser(userId: string) {
<BackendTabs.TabItem value="go">

:::note
Coming soon. In the meantime, checkout the [legacy method](./legacy-method/how-it-works) for adding MFA to your app.
At the moment this feature is not supported through the Go SDK.
:::

</BackendTabs.TabItem>
Expand Down
2 changes: 1 addition & 1 deletion docs/additional-verification/mfa/migration/old-sdk-to-new.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ SuperTokens.init({
<BackendTabs.TabItem value="go">

:::note
Coming soon. In the meantime, checkout the [legacy method](./legacy-method/how-it-works) for adding MFA to your app.
At the moment this feature is not supported through the Go SDK.
:::

</BackendTabs.TabItem>
Expand Down
4 changes: 2 additions & 2 deletions docs/additional-verification/mfa/protect-routes.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -294,7 +294,7 @@ export class ExampleController {
<BackendTabs.TabItem value="go">

:::note
Coming soon. In the meantime, checkout the [legacy method](./legacy-method/how-it-works) for adding MFA to your app.
At the moment this feature is not supported through the Go SDK.
:::

</BackendTabs.TabItem>
Expand Down Expand Up @@ -862,7 +862,7 @@ export class ExampleController {
<BackendTabs.TabItem value="go">

:::note
Coming soon. In the meantime, checkout the [legacy method](./legacy-method/how-it-works) for adding MFA to your app.
At the moment this feature is not supported through the Go SDK.
:::

</BackendTabs.TabItem>
Expand Down
4 changes: 2 additions & 2 deletions docs/additional-verification/mfa/step-up-auth.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -414,7 +414,7 @@ export class ExampleController {
<BackendTabs.TabItem value="go">

:::note
Coming soon.
At the moment this feature is not supported through the Go SDK.
:::

</BackendTabs.TabItem>
Expand Down Expand Up @@ -636,7 +636,7 @@ supertokens.init({
<BackendTabs.TabItem value="go">

:::note
Coming soon.
At the moment this feature is not supported through the Go SDK.
:::

</BackendTabs.TabItem>
Expand Down
6 changes: 3 additions & 3 deletions docs/additional-verification/mfa/totp/totp-for-all-users.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ supertokens.init({
<BackendTabs.TabItem value="go">

:::note
Coming soon.
At the moment this feature is not supported through the Go SDK.
:::

</BackendTabs.TabItem>
Expand Down Expand Up @@ -879,7 +879,7 @@ supertokens.init({
<BackendTabs.TabItem value="go">

:::note
Coming soon.
At the moment this feature is not supported through the Go SDK.
:::

</BackendTabs.TabItem>
Expand Down Expand Up @@ -947,7 +947,7 @@ async function createNewTenant() {
<BackendTabs.TabItem value="go">

:::note
Coming soon.
At the moment this feature is not supported through the Go SDK.
:::

</BackendTabs.TabItem>
Expand Down
16 changes: 8 additions & 8 deletions docs/additional-verification/mfa/totp/totp-for-opt-in-users.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ supertokens.init({
<BackendTabs.TabItem value="go">

:::note
Coming soon.
At the moment this feature is not supported through the Go SDK.
:::

</BackendTabs.TabItem>
Expand Down Expand Up @@ -256,7 +256,7 @@ supertokens.init({
<BackendTabs.TabItem value="go">

:::note
Coming soon.
At the moment this feature is not supported through the Go SDK.
:::

</BackendTabs.TabItem>
Expand Down Expand Up @@ -394,7 +394,7 @@ async function isTotpEnabledForUser(userId: string) {
<BackendTabs.TabItem value="go">

:::note
Coming soon. In the meantime, checkout the [legacy method](../legacy-method/how-it-works) for adding MFA to your app.
At the moment this feature is not supported through the Go SDK.
:::

</BackendTabs.TabItem>
Expand Down Expand Up @@ -451,7 +451,7 @@ async function disableMFAForUser(userId: string) {
<BackendTabs.TabItem value="go">

:::note
Coming soon. In the meantime, checkout the [legacy method](../legacy-method/how-it-works) for adding MFA to your app.
At the moment this feature is not supported through the Go SDK.
:::

</BackendTabs.TabItem>
Expand Down Expand Up @@ -832,7 +832,7 @@ supertokens.init({
<BackendTabs.TabItem value="go">

:::note
Coming soon.
At the moment this feature is not supported through the Go SDK.
:::

</BackendTabs.TabItem>
Expand Down Expand Up @@ -992,7 +992,7 @@ supertokens.init({
<BackendTabs.TabItem value="go">

:::note
Coming soon.
At the moment this feature is not supported through the Go SDK.
:::

</BackendTabs.TabItem>
Expand Down Expand Up @@ -1124,7 +1124,7 @@ async function isTotpEnabledForUser(userId: string) {
<BackendTabs.TabItem value="go">

:::note
Coming soon. In the meantime, checkout the [legacy method](../legacy-method/how-it-works) for adding MFA to your app.
At the moment this feature is not supported through the Go SDK.
:::

</BackendTabs.TabItem>
Expand Down Expand Up @@ -1181,7 +1181,7 @@ async function disableMFAForUser(userId: string) {
<BackendTabs.TabItem value="go">

:::note
Coming soon. In the meantime, checkout the [legacy method](../legacy-method/how-it-works) for adding MFA to your app.
At the moment this feature is not supported through the Go SDK.
:::

</BackendTabs.TabItem>
Expand Down
2 changes: 1 addition & 1 deletion ...entication/social/_blocks/frontend-custom-ui-mobile-authorization-code-flow.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ In case you are using Expo, you can use the [expo-apple-authentication](https://
#### Fetching the authorisation token on the frontend

:::info
Coming Soon
At the moment this flow is not supported on Android.
:::

</MobileFrameworksCard.Content>
Expand Down
24 changes: 18 additions & 6 deletions docs/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,12 +142,24 @@ import { DescriptionText } from "/src/components/DescriptionText";
</ReferenceCard.Description>
</ReferenceCard>
<ReferenceCard.GridHelper />
<ReferenceCard href="/docs/references/api-reference">
<ReferenceCard.Title>
API Reference
</ReferenceCard.Title>
<ReferenceCard href="/docs/references/fdi/introduction">
<ReferenceCard.Title>
FDI Reference
</ReferenceCard.Title>
<ReferenceCard.Description>
Information on the APIs exposed by the SuperTokens Core and by the backend SDKs.
Details about the endpoints exposed by the **Frontend Driver Interface**.
This is the API enabled by the backend SDKs.
</ReferenceCard.Description>
</ReferenceCard>
</ReferenceCard>

<ReferenceCard href="/docs/references/cdi/introduction">
<ReferenceCard.Title>
CDI Reference
</ReferenceCard.Title>
<ReferenceCard.Description>
Details about the endpoints exposed by the **Core Driver Interface**.
This is the API enabled by the SuperTokens Core Service.
</ReferenceCard.Description>
</ReferenceCard>

</ReferenceCard.Grid>
Loading
Loading