refactor: add-fragments-content #983
Open
Conversation
This file contains 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
Deploying logto-docs with
|
| Latest commit: |
d30133e
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://944452c9.logto-docs.pages.dev |
| Branch Preview URL: | https://rany-add-fragment-content.logto-docs.pages.dev |
charIeszhao
reviewed
Jan 23, 2025
Comment on lines
+145
to
+147
| ```json | ||
| Authorization: Basic ${Buffer.from(${id}:${secret}, 'utf8').toString('base64')} | ||
| ``` |
There was a problem hiding this comment.
This is inaccurate I think.
- First of all, not all "traditional web" are JS based framework, the code example showed here is Node.js
- Even in Node.js, the code sample is incorrect. Should be
Authorization: `Basic ${Buffer.from(`${id}:${secret}`, 'utf8').toString('base64')}`
charIeszhao
reviewed
Jan 23, 2025
Comment on lines
+1
to
+2
| /** eslint-disable no-irregular-whitespace \*/ | ||
| /** eslint-disable no-irregular-whitespace \*/ |
charIeszhao
reviewed
Jan 23, 2025
Comment on lines
+236
to
+244
| ```tsx | ||
| ssoIdentities: { | ||
| issuer: string; | ||
| identityId: string; | ||
| detail: { | ||
| [x: string]: Record<string, unknown>; | ||
| }; | ||
| }[]; | ||
| ``` |
There was a problem hiding this comment.
The code indent needs to be adjusted.
charIeszhao
reviewed
Jan 23, 2025
Comment on lines
+314
to
+335
| ```tsx | ||
| roles: { | ||
| id: string; | ||
| name: string; | ||
| description: string; | ||
| scopes: { | ||
| id: string; | ||
| name: string; | ||
| description: string | null; | ||
| resourceId: string; | ||
| resource: { | ||
| tenantId: string; | ||
| id: string; | ||
| name: string; | ||
| indicator: string; | ||
| isDefault: boolean; | ||
| accessTokenTtl: number; | ||
| } | ||
| } | ||
| []; | ||
| } | ||
| []; |
There was a problem hiding this comment.
Hmmm, would prefer using Array<{ key: type; key2: type }> when defining the types for a complex object, instead of []
charIeszhao
reviewed
Jan 23, 2025
Comment on lines
+342
to
+348
| ```tsx | ||
| organizations: { | ||
| id: string; | ||
| name: string; | ||
| description: string | null; | ||
| }[ | ||
| ``` |
charIeszhao
reviewed
Jan 23, 2025
Comment on lines
+354
to
+361
| ```tsx | ||
| organizationRoles: { | ||
| organizationId: string; | ||
| roleId: string; | ||
| roleName: string; | ||
| } | ||
| []; | ||
| ``` |
There was a problem hiding this comment.
Are these types copied from API docs?
There was a problem hiding this comment.
Should we use tables instead of json?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary