Sync eng/common directory with azure-sdk-tools for PR 10286

[azure-sdk]

Sync eng/common directory with azure-sdk-tools for PR Azure/azure-sdk-tools#10286 See eng/common workflow

[Copilot]

Pull Request Overview

Syncs the eng/common directory with upstream azure-sdk-tools to enhance APIView integration and logging.

• Adds correlation ID headers to APIView web requests and logs them
• Converts and logs full JSON responses for better troubleshooting
• Updates pipeline step display name to reflect APIView creation

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File	Description
eng/common/scripts/Helpers/ApiView-Helpers.ps1	Injects x-correlation-id header, logs correlation IDs, and enhances success messages with parsed JSON
eng/common/scripts/Detect-Api-Changes.ps1	Adds correlation ID header, logs full JSON response on success
eng/common/pipelines/templates/steps/detect-api-changes.yml	Renames step displayName to indicate APIView creation

Comments suppressed due to low confidence (4)

eng/common/scripts/Helpers/ApiView-Helpers.ps1:281

• [nitpick] Variable casing is inconsistent (uses $Response instead of $response). Normalize to one style for readability, e.g., $responseContent = $response.Content | ....

$responseContent = $Response.Content | ConvertFrom-Json | ConvertTo-Json -Depth 10

eng/common/pipelines/templates/steps/detect-api-changes.yml:27

• [nitpick] The displayName now refers to creating an APIView, but the template and variable names still reference detection; align naming for consistency.

displayName: Create APIView if API has changes

eng/common/scripts/Detect-Api-Changes.ps1:61

• Setting Content-Type: application/json on a GET request is unusual and may be unnecessary; consider removing it to avoid confusion.

"Content-Type"  = "application/json"

eng/common/scripts/Detect-Api-Changes.ps1:71

• [nitpick] Logging the raw JSON object may produce unstructured output; wrap this in a descriptive message (e.g., LogSuccess "API response: $responseContent").

LogSuccess $responseContent