AWS solutions documentation change
Summary
Formatting updates to API documentation including punctuation fixes, markdown table formatting normalization, and JSON comment syntax correction
Security assessment
Changes involve typo fixes (e.g., straight quotes to curly quotes), markdown table formatting consistency, and JSON comment syntax correction. No security vulnerabilities addressed or new security features documented - maintains existing references to Cognito JWT tokens and RBAC requirements without adding new security content.
Diff
diff --git a/solutions/latest/generative-ai-application-builder-on-aws/api-reference.md index 9f83293f4..3af2c53c9 100644 --- a/solutions/latest/generative-ai-application-builder-on-aws/api-reference.md +++ b/solutions/latest/generative-ai-application-builder-on-aws/api-reference.md @@ -151 +151 @@ WebSocket API | Functionality | Authorized callers -`/sendMessage` | Sends user's chat message to the WebSocket for processing with the configured LLM experience. | Amazon Cognito authenticated JWT token +`/sendMessage` | Sends user’s chat message to the WebSocket for processing with the configured LLM experience. | Amazon Cognito authenticated JWT token @@ -166 +166 @@ _Request Payload_ - "authToken": "XXXX" / Optional. accessToken from cognito flow. Required for RAG with RBAC + "authToken": "XXXX" // Optional. accessToken from cognito flow. Required for RAG with RBAC @@ -169 +169 @@ _Request Payload_ -**Parameter Name** | **Type** | **Description** +Parameter Name | Type | Description @@ -171 +171 @@ _Request Payload_ -**action** | `String` | Currently we only support the “sendMessage” action on the WebSocket +**action** | `String` | Currently we only support the "sendMessage" action on the WebSocket @@ -189 +189 @@ The WebSocket API will respond with 1 (if streaming is disabled) or many (if str -**Parameter Name** | **Type** | **Description** +Parameter Name | Type | Description @@ -191 +191 @@ The WebSocket API will respond with 1 (if streaming is disabled) or many (if str -**data** | `String` | A chunk of the response from the LLM if streaming is enabled, or the entire response. If using streaming, a response of this format with the data content being ##END_CONVERSATION## will be sent to indicate the end of the response to a single question. +**data** | `String` | A chunk of the response from the LLM if streaming is enabled, or the entire response. If using streaming, a response of this format with the data content being _END_CONVERSATION_ will be sent to indicate the end of the response to a single question. @@ -211 +211 @@ If you have configured your RAG use case to return source documents, you will al -**Parameter Name** | **Type** | **Description** +Parameter Name | Type | Description @@ -223 +223 @@ If you have configured your RAG use case to return source documents, you will al -**WebSocket API** | **Functionality** | **Authorized callers** +WebSocket API | Functionality | Authorized callers @@ -226 +226 @@ If you have configured your RAG use case to return source documents, you will al -`/invokeAgent` | Sends user's message to the WebSocket for processing with the configured agent. | Amazon Cognito authenticated JWT token +`/invokeAgent` | Sends user’s message to the WebSocket for processing with the configured agent. | Amazon Cognito authenticated JWT token @@ -241 +241 @@ _Request payload_ - "authToken": "XXXX" / Optional. accessToken from cognito flow. If provided, it needs to be a valid JWT token associated with the user + "authToken": "XXXX" // Optional. accessToken from cognito flow. If provided, it needs to be a valid JWT token associated with the user @@ -244 +244 @@ _Request payload_ -**Parameter name** | **Type** | **Description** +Parameter name | Type | Description @@ -259 +259 @@ The WebSocket API will respond with one (if streaming is disabled) or many (if s - "data"" "some data", + "data" "some data", @@ -263 +263 @@ The WebSocket API will respond with one (if streaming is disabled) or many (if s -**Parameter name** | **Type** | **Description** +Parameter name | Type | Description