Docs sId/cId wording changes #9780
Conversation
|
Automatic code review is enabled for this repository. I will perform a review of this PR. |
![devloai[bot]](https://avatars.githubusercontent.com/in/886113?s=60&v=4){kind=small}
There was a problem hiding this comment.
Thank you for the documentation wording changes. While the ID → Id standardization looks good, I found a systematic issue where conversation ID parameters (denoted by cId) are incorrectly described as "sId" in several files. I've added specific suggestions to fix these inconsistencies.
| * schema: | ||
| * type: string | ||
| * - in: path | ||
| * name: cId | ||
| * required: true | ||
| * description: ID of the conversation | ||
| * description: sId of the conversation |
There was a problem hiding this comment.
The parameter is cId (conversation ID) but the description incorrectly says "sId". This should be "cId" instead.
| * description: sId of the conversation | |
| * description: cId of the conversation |
| @@ -31,7 +31,7 @@ import { apiError } from "@app/logger/withlogging"; | |||
| * required: true | |||
| * schema: | |||
| * type: string | |||
| * description: Conversation ID | |||
| * description: Conversation sId | |||
There was a problem hiding this comment.
The parameter is cId (Conversation ID) but the description incorrectly says "Conversation sId". This should be "Conversation cId" for consistency.
| * description: Conversation sId | |
| * description: Conversation cId |
| @@ -30,7 +30,7 @@ import { apiError } from "@app/logger/withlogging"; | |||
| * required: true | |||
| * schema: | |||
| * type: string | |||
| * description: Conversation ID | |||
| * description: Conversation sId | |||
There was a problem hiding this comment.
The parameter is cId (Conversation ID) but the description incorrectly says "Conversation sId". This should be "Conversation cId" for consistency.
| * description: Conversation sId | |
| * description: Conversation cId |
| * schema: | ||
| * type: string | ||
| * - in: path | ||
| * name: cId | ||
| * required: true | ||
| * description: ID of the conversation | ||
| * description: sId of the conversation |
There was a problem hiding this comment.
The parameter is cId (conversation ID) but the description incorrectly says "sId". This should be "cId" instead.
| * description: sId of the conversation | |
| * description: cId of the conversation |
|
Description
Quick wording changes
Risk
Deploy Plan