-
Notifications
You must be signed in to change notification settings - Fork 59
fix: complete auth API docs migration to Mintlify MDX #1199
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.
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
Open
mikemimik
wants to merge
15
commits into
main
Choose a base branch
from
fix/auth-api-docs-migration-completion
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
36fc583
refactor: migrate auth API navigation from generated files to static …
mikemimik bc239a4
feat: add redirects for auth API docs restructuring
mikemimik 12649cd
fix: remove muti-factor-authentication typo directory (en)
mikemimik 5e97f2c
feat: add multi-factor-authentication docs with correct spelling (en)
mikemimik c805fd6
refactor: remove old fr-ca auth API files from previous structure
mikemimik b31e176
feat: update existing fr-ca auth API docs with French content
mikemimik 8ed2341
feat: add fr-ca auth API docs for new directory structure
mikemimik 9224f84
refactor: remove old ja-jp auth API files from previous structure
mikemimik 584d3db
feat: update existing ja-jp auth API docs with Japanese content
mikemimik 6dcb9d5
feat: add ja-jp auth API docs for new directory structure
mikemimik 341ba69
refactor: extract auth API navigation pages into dedicated files
mikemimik 3e51671
refactor: replace inline auth API pages with $ref in navigation configs
mikemimik 3751226
refactor: wrap auth API nav groups in root-level group object
mikemimik 302abe6
fix: use explicit index path for login nav entry to show correct side…
mikemimik 2bd0386
fix: update japanese translation of page
mikemimik File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,196 @@ | ||
| { | ||
| "pages": [ | ||
| "docs/api/authentication", | ||
| { | ||
| "group": " ", | ||
| "pages": [ | ||
| { | ||
| "group": "Login", | ||
| "pages": [ | ||
| "docs/api/authentication/login/index", | ||
| "docs/api/authentication/login/authenticate-using-database", | ||
| "docs/api/authentication/login/enterprise-saml-and-others", | ||
| "docs/api/authentication/login/start-back-channel-login", | ||
| "docs/api/authentication/login/check-back-channel-login-status" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "Logout", | ||
| "pages": [ | ||
| "docs/api/authentication/logout/auth-0-logout", | ||
| "docs/api/authentication/logout/oidc-logout", | ||
| "docs/api/authentication/logout/saml-logout", | ||
| "docs/api/authentication/logout/global-token-revocation" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "Passwordless", | ||
| "pages": [ | ||
| "docs/api/authentication/passwordless/get-code-or-link", | ||
| "docs/api/authentication/passwordless/authenticate-user", | ||
| "docs/api/authentication/passwordless/verify" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "Signup", | ||
| "pages": [ | ||
| "docs/api/authentication/signup/create-a-new-user" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "Change Password", | ||
| "pages": [ | ||
| "docs/api/authentication/change-password/change-password" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "User Profile", | ||
| "pages": [ | ||
| "docs/api/authentication/user-profile/get-user-info" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "Multi Factor Authentication", | ||
| "pages": [ | ||
| "docs/api/authentication/multi-factor-authentication/request-mfa-challenge", | ||
| "docs/api/authentication/multi-factor-authentication/verify-mfa-with-otp", | ||
| "docs/api/authentication/multi-factor-authentication/verify-with-out-of-band", | ||
| "docs/api/authentication/multi-factor-authentication/verify-with-recovery-code", | ||
| "docs/api/authentication/multi-factor-authentication/add-an-authenticator", | ||
| "docs/api/authentication/multi-factor-authentication/list-authenticators", | ||
| "docs/api/authentication/multi-factor-authentication/delete-authenticator" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "SAML", | ||
| "pages": [ | ||
| "docs/api/authentication/saml/accept-saml-request", | ||
| "docs/api/authentication/saml/get-saml-metadata", | ||
| "docs/api/authentication/saml/idp-initiated-sso" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "WS Federation", | ||
| "pages": [ | ||
| "docs/api/authentication/ws-federation/accept-ws-federation-request", | ||
| "docs/api/authentication/ws-federation/get-ws-federation-metadata" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "Dynamic Application (Client) Registration", | ||
| "pages": [ | ||
| "docs/api/authentication/dynamic-application-client-registration/dynamic-application-registration" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "Authorization Code Flow", | ||
| "pages": [ | ||
| "docs/api/authentication/authorization-code-flow/authorize-application", | ||
| "docs/api/authentication/authorization-code-flow/get-token" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "Authorization Code Flow with PKCE", | ||
| "pages": [ | ||
| "docs/api/authentication/authorization-code-flow-with-pkce/authorize-with-pkce", | ||
| "docs/api/authentication/authorization-code-flow-with-pkce/get-token-pkce" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "Authorization Code Flow with Enhanced Privacy Protection", | ||
| "pages": [ | ||
| "docs/api/authentication/authorization-code-flow-with-enhanced-privacy-protection/push-authorization-requests", | ||
| "docs/api/authentication/authorization-code-flow-with-enhanced-privacy-protection/authorize", | ||
| "docs/api/authentication/authorization-code-flow-with-enhanced-privacy-protection/exchange-authorization-code-for-token" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "Client Credential Flow", | ||
| "pages": [ | ||
| "docs/api/authentication/client-credential-flow/get-token" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "Implicit Flow", | ||
| "pages": [ | ||
| "docs/api/authentication/implicit-flow/authorize" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "Custom Token Exchange", | ||
| "pages": [ | ||
| "docs/api/authentication/custom-token-exchange/get-token" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "Resource Owner Password Flow", | ||
| "pages": [ | ||
| "docs/api/authentication/resource-owner-password-flow/get-token" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "Device Authorization Flow", | ||
| "pages": [ | ||
| "docs/api/authentication/device-authorization-flow/authorize-device" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "Refresh Token", | ||
| "pages": [ | ||
| "docs/api/authentication/refresh-token/refresh-token" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "Revoke Refresh Token", | ||
| "pages": [ | ||
| "docs/api/authentication/revoke-refresh-token/revoke-refresh-token" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "Token Exchange for Native Social", | ||
| "pages": [ | ||
| "docs/api/authentication/token-exchange-for-native-social/token-exchange-native-social" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "Login [Legacy]", | ||
| "pages": [ | ||
| "docs/api/authentication/login-legacy/social-with-providers-access-token", | ||
| "docs/api/authentication/login-legacy/database-ad-lapd-active" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "User Profile [Legacy]", | ||
| "pages": [ | ||
| "docs/api/authentication/user-profile-legacy/get-token-info" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "Account Linking [Legacy]", | ||
| "pages": [ | ||
| "docs/api/authentication/account-linking-legacy/link", | ||
| "docs/api/authentication/account-linking-legacy/unlink" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "Delegation [Legacy]", | ||
| "pages": [ | ||
| "docs/api/authentication/delegation-legacy/delegation" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "Impersonation [Legacy]", | ||
| "pages": [ | ||
| "docs/api/authentication/impersonation-legacy/impersonation" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "Resource Owner [Legacy]", | ||
| "pages": [ | ||
| "docs/api/authentication/resource-owner-legacy/resource-owner-password-grant" | ||
| ] | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,196 @@ | ||
| { | ||
| "pages": [ | ||
| "docs/fr-ca/api/authentication", | ||
| { | ||
| "group": " ", | ||
| "pages": [ | ||
| { | ||
| "group": "Login", | ||
| "pages": [ | ||
| "docs/fr-ca/api/authentication/login/index", | ||
| "docs/fr-ca/api/authentication/login/authenticate-using-database", | ||
| "docs/fr-ca/api/authentication/login/enterprise-saml-and-others", | ||
| "docs/fr-ca/api/authentication/login/start-back-channel-login", | ||
| "docs/fr-ca/api/authentication/login/check-back-channel-login-status" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "Logout", | ||
| "pages": [ | ||
| "docs/fr-ca/api/authentication/logout/auth-0-logout", | ||
| "docs/fr-ca/api/authentication/logout/oidc-logout", | ||
| "docs/fr-ca/api/authentication/logout/saml-logout", | ||
| "docs/fr-ca/api/authentication/logout/global-token-revocation" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "Passwordless", | ||
| "pages": [ | ||
| "docs/fr-ca/api/authentication/passwordless/get-code-or-link", | ||
| "docs/fr-ca/api/authentication/passwordless/authenticate-user", | ||
| "docs/fr-ca/api/authentication/passwordless/verify" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "Signup", | ||
| "pages": [ | ||
| "docs/fr-ca/api/authentication/signup/create-a-new-user" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "Change Password", | ||
| "pages": [ | ||
| "docs/fr-ca/api/authentication/change-password/change-password" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "User Profile", | ||
| "pages": [ | ||
| "docs/fr-ca/api/authentication/user-profile/get-user-info" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "Multi Factor Authentication", | ||
| "pages": [ | ||
| "docs/fr-ca/api/authentication/multi-factor-authentication/request-mfa-challenge", | ||
| "docs/fr-ca/api/authentication/multi-factor-authentication/verify-mfa-with-otp", | ||
| "docs/fr-ca/api/authentication/multi-factor-authentication/verify-with-out-of-band", | ||
| "docs/fr-ca/api/authentication/multi-factor-authentication/verify-with-recovery-code", | ||
| "docs/fr-ca/api/authentication/multi-factor-authentication/add-an-authenticator", | ||
| "docs/fr-ca/api/authentication/multi-factor-authentication/list-authenticators", | ||
| "docs/fr-ca/api/authentication/multi-factor-authentication/delete-authenticator" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "SAML", | ||
| "pages": [ | ||
| "docs/fr-ca/api/authentication/saml/accept-saml-request", | ||
| "docs/fr-ca/api/authentication/saml/get-saml-metadata", | ||
| "docs/fr-ca/api/authentication/saml/idp-initiated-sso" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "WS Federation", | ||
| "pages": [ | ||
| "docs/fr-ca/api/authentication/ws-federation/accept-ws-federation-request", | ||
| "docs/fr-ca/api/authentication/ws-federation/get-ws-federation-metadata" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "Dynamic Application (Client) Registration", | ||
| "pages": [ | ||
| "docs/fr-ca/api/authentication/dynamic-application-client-registration/dynamic-application-registration" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "Authorization Code Flow", | ||
| "pages": [ | ||
| "docs/fr-ca/api/authentication/authorization-code-flow/authorize-application", | ||
| "docs/fr-ca/api/authentication/authorization-code-flow/get-token" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "Authorization Code Flow with PKCE", | ||
| "pages": [ | ||
| "docs/fr-ca/api/authentication/authorization-code-flow-with-pkce/authorize-with-pkce", | ||
| "docs/fr-ca/api/authentication/authorization-code-flow-with-pkce/get-token-pkce" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "Authorization Code Flow with Enhanced Privacy Protection", | ||
| "pages": [ | ||
| "docs/fr-ca/api/authentication/authorization-code-flow-with-enhanced-privacy-protection/push-authorization-requests", | ||
| "docs/fr-ca/api/authentication/authorization-code-flow-with-enhanced-privacy-protection/authorize", | ||
| "docs/fr-ca/api/authentication/authorization-code-flow-with-enhanced-privacy-protection/exchange-authorization-code-for-token" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "Client Credential Flow", | ||
| "pages": [ | ||
| "docs/fr-ca/api/authentication/client-credential-flow/get-token" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "Implicit Flow", | ||
| "pages": [ | ||
| "docs/fr-ca/api/authentication/implicit-flow/authorize" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "Custom Token Exchange", | ||
| "pages": [ | ||
| "docs/fr-ca/api/authentication/custom-token-exchange/get-token" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "Resource Owner Password Flow", | ||
| "pages": [ | ||
| "docs/fr-ca/api/authentication/resource-owner-password-flow/get-token" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "Device Authorization Flow", | ||
| "pages": [ | ||
| "docs/fr-ca/api/authentication/device-authorization-flow/authorize-device" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "Refresh Token", | ||
| "pages": [ | ||
| "docs/fr-ca/api/authentication/refresh-token/refresh-token" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "Revoke Refresh Token", | ||
| "pages": [ | ||
| "docs/fr-ca/api/authentication/revoke-refresh-token/revoke-refresh-token" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "Token Exchange for Native Social", | ||
| "pages": [ | ||
| "docs/fr-ca/api/authentication/token-exchange-for-native-social/token-exchange-native-social" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "Login [Legacy]", | ||
| "pages": [ | ||
| "docs/fr-ca/api/authentication/login-legacy/social-with-providers-access-token", | ||
| "docs/fr-ca/api/authentication/login-legacy/database-ad-lapd-active" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "User Profile [Legacy]", | ||
| "pages": [ | ||
| "docs/fr-ca/api/authentication/user-profile-legacy/get-token-info" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "Account Linking [Legacy]", | ||
| "pages": [ | ||
| "docs/fr-ca/api/authentication/account-linking-legacy/link", | ||
| "docs/fr-ca/api/authentication/account-linking-legacy/unlink" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "Delegation [Legacy]", | ||
| "pages": [ | ||
| "docs/fr-ca/api/authentication/delegation-legacy/delegation" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "Impersonation [Legacy]", | ||
| "pages": [ | ||
| "docs/fr-ca/api/authentication/impersonation-legacy/impersonation" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "Resource Owner [Legacy]", | ||
| "pages": [ | ||
| "docs/fr-ca/api/authentication/resource-owner-legacy/resource-owner-password-grant" | ||
| ] | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ℹ️ It's necessary to do this
/indexbit to make Mintlify render the page title correctly in the sidebar. If we don't add/indexthe sidebar will say "Login" instead of "Social"There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
huh! i tested this locally by changing this like in the nav to
docs/api/authentication/loginand movingdocs/api/authentication/login/index.mdxtodocs/api/authentication/login.mdxand it correctly shows the page title as "Social":