AWS devopsagent documentation change
Summary
Fixed formatting and syntax in example code snippets, including indentation corrections, removal of non-breaking spaces, and template literal fixes in Authorization header
Security assessment
Changes are purely cosmetic/formatting improvements to code examples. The Authorization header fix corrects a syntax issue but doesn't address a vulnerability. No security mechanisms were added or modified.
Diff
diff --git a/devopsagent/latest/userguide/configuring-capabilities-for-aws-devops-agent-invoking-devops-agent-through-webhook.md b/devopsagent/latest/userguide/configuring-capabilities-for-aws-devops-agent-invoking-devops-agent-through-webhook.md index ba0d13624..4d7aa25a4 100644 --- a//devopsagent/latest/userguide/configuring-capabilities-for-aws-devops-agent-invoking-devops-agent-through-webhook.md +++ b//devopsagent/latest/userguide/configuring-capabilities-for-aws-devops-agent-invoking-devops-agent-through-webhook.md @@ -147,11 +147,11 @@ The request body should include information about the incident: - "title": "Incident title", - "severity": "high", - "affectedResources": ["resource-id-1", "resource-id-2"], - "timestamp": "2025-11-23T18:00:00Z", - "description": "Detailed incident description", - "data": { - "metadata": { - "region": "us-east-1", - "environment": "production" - } - } + "title": "Incident title", + "severity": "high", + "affectedResources": ["resource-id-1", "resource-id-2"], + "timestamp": "2025-11-23T18:00:00Z", + "description": "Detailed incident description", + "data": { + "metadata": { + "region": "us-east-1", + "environment": "production" + } + } @@ -172,15 +172,15 @@ The request body should include information about the incident: - const incidentData = { - eventType: 'incident', - incidentId: 'incident-123', - action: 'created', - priority: "HIGH", - title: 'High CPU usage on production server', - description: 'High CPU usage on production server host ABC in AWS account 1234 region us-east-1', - timestamp: new Date().toISOString(), - service: 'MyTestService', - data: { - metadata: { - region: 'us-east-1', - environment: 'production' - } - } + const incidentData = { + eventType: 'incident', + incidentId: 'incident-123', + action: 'created', + priority: "HIGH", + title: 'High CPU usage on production server', + description: 'High CPU usage on production server host ABC in AWS account 1234 region us-east-1', + timestamp: new Date().toISOString(), + service: 'MyTestService', + data: { + metadata: { + region: 'us-east-1', + environment: 'production' + } + } @@ -198,7 +198,7 @@ The request body should include information about the incident: - method: 'POST', - headers: { - 'Content-Type': 'application/json', - 'x-amzn-event-timestamp': timestamp, - 'x-amzn-event-signature': signature - }, - body: payload + method: 'POST', + headers: { + 'Content-Type': 'application/json', + 'x-amzn-event-timestamp': timestamp, + 'x-amzn-event-signature': signature + }, + body: payload @@ -207,2 +207,2 @@ The request body should include information about the incident: - console.log(`Status Code: ${res.status}`); - return res.text(); + console.log(`Status Code: ${res.status}`); + return res.text(); @@ -211 +211 @@ The request body should include information about the incident: - console.log('Response:', data); + console.log('Response:', data); @@ -214 +214 @@ The request body should include information about the incident: - console.error('Error:', error); + console.error('Error:', error); @@ -258,23 +258,23 @@ The request body should include information about the incident: - const timestamp = new Date().toISOString(); - - const payload = { - eventType: 'incident', - incidentId: 'incident-123', - action: 'created', - priority: "HIGH", - title: 'Test Alert', - description: 'Test description', - timestamp: timestamp, - service: 'TestService', - data: {} - }; - - fetch(webhookUrl, { - method: "POST", - headers: { - "Content-Type": "application/json", - "x-amzn-event-timestamp": timestamp, - "Authorization": `Bearer ${secret}`, // Fixed: template literal - }, - body: JSON.stringify(payload), - }); + const timestamp = new Date().toISOString(); + + const payload = { + eventType: 'incident', + incidentId: 'incident-123', + action: 'created', + priority: "HIGH", + title: 'Test Alert', + description: 'Test description', + timestamp: timestamp, + service: 'TestService', + data: {} + }; + + fetch(webhookUrl, { + method: "POST", + headers: { + "Content-Type": "application/json", + "x-amzn-event-timestamp": timestamp, + "Authorization": `Bearer ${secret}`, // Fixed: template literal + }, + body: JSON.stringify(payload), + });