Fix/emphasise m2 m access to api #178
Conversation
WalkthroughThe changes across the documents clarify the requirements for machine-to-machine (M2M) applications connecting to Kinde’s Management API. Key modifications include emphasizing that only M2M applications can access the API, specifying that scopes must be defined, and streamlining introductory sections for clarity. Additionally, a new section linking related articles has been added to enhance contextual understanding. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant M2M Application
participant Kinde API
User->>M2M Application: Create M2M application
M2M Application->>Kinde API: Request access with scopes
Kinde API-->>M2M Application: Grant access
M2M Application->>User: Provide access token
Tip OpenAI O1 model for chat
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Deploying kinde-docs-previews with
|
| Latest commit: |
1a0a14d
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://fe222ac9.kinde-docs-previews.pages.dev |
| Branch Preview URL: | https://fix-emphasise-m2m-access-to.kinde-docs-previews.pages.dev |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range and nitpick comments (1)
src/content/docs/developer-tools/kinde-api/add-a-m2m-application-for-api-access.mdx (1)
19-19: Approve the change and consider rephrasing for better style.The change effectively emphasizes that only M2M applications can connect to the Kinde Management API, which aligns with the PR objective.
To improve the writing style, consider rephrasing the sentence to avoid using "get":
-Only machine to machine (M2M) applications can connect to [Kinde's Management API](https://kinde.com/api/docs/#kinde-management-api). This topic explains how to set up an M2M application, including managing the scopes that get requested. +Only machine to machine (M2M) applications can connect to [Kinde's Management API](https://kinde.com/api/docs/#kinde-management-api). This topic explains how to set up an M2M application, including managing the scopes that are requested.Tools
LanguageTool
[style] ~19-~19: The verb “get” can be informal. Consider replacing it with a form of “to be”.
Context: ...ion, including managing the scopes that get requested. ## About scopes and the Kinde Managem...(GET_USED_ARE_USED)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (3)
- src/content/docs/developer-tools/kinde-api/add-a-m2m-application-for-api-access.mdx (1 hunks)
- src/content/docs/developer-tools/kinde-api/get-access-token-for-connecting-securely-to-kindes-api.mdx (1 hunks)
- src/content/docs/get-started/apis-and-sdks/about-kinde-apis.mdx (2 hunks)
Additional context used
LanguageTool
src/content/docs/developer-tools/kinde-api/add-a-m2m-application-for-api-access.mdx
[style] ~19-~19: The verb “get” can be informal. Consider replacing it with a form of “to be”.
Context: ...ion, including managing the scopes that get requested. ## About scopes and the Kinde Managem...(GET_USED_ARE_USED)
[uncategorized] ~23-~23: Use a comma before ‘or’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...pes when you authorize a new application or you can add scopes to an existing appli...(COMMA_COMPOUND_SENTENCE)
Additional comments not posted (5)
src/content/docs/get-started/apis-and-sdks/about-kinde-apis.mdx (2)
6-10: LGTM!The addition of the
relatedArticlesfield in the front matter is consistent with the PR objective to add cross-references and related topics. The article IDs seem to be valid UUIDs.
20-20: LGTM!The content change clarifies that only M2M applications can access the Kinde Management API, which is consistent with the PR objective.
src/content/docs/developer-tools/kinde-api/add-a-m2m-application-for-api-access.mdx (1)
23-23: LGTM!The change enhances the clarity and specificity of the instructions by reinforcing that scopes must be defined in all M2M applications accessing the Kinde Management API.
Tools
LanguageTool
[uncategorized] ~23-~23: Use a comma before ‘or’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...pes when you authorize a new application or you can add scopes to an existing appli...(COMMA_COMPOUND_SENTENCE)
src/content/docs/developer-tools/kinde-api/get-access-token-for-connecting-securely-to-kindes-api.mdx (2)
15-18: LGTM!The changes effectively clarify the prerequisites for securely connecting to Kinde's API, emphasizing the need for a machine-to-machine application with the relevant API scopes and the availability of application details. This aligns well with the PR objectives and enhances the clarity of the documentation.
15-18: This code segment has already been reviewed and approved in the previous comment.
Update to a few topics to clarify that only M2M apps can access the Kinde Management API. Added some cross references and related topics as well.
Summary by CodeRabbit