Skip to content

Standardize User-Agent and add telemetry headers#74

Open
luke-hagar-sp wants to merge 2 commits intomainfrom
feature/standardize-useragent-headers
Open

Standardize User-Agent and add telemetry headers#74
luke-hagar-sp wants to merge 2 commits intomainfrom
feature/standardize-useragent-headers

Conversation

@luke-hagar-sp
Copy link
Contributor

Summary

  • Replace OpenAPI-Generator/1.7.16/ts User-Agent with SailPoint-SDK/typescript/1.7.16 to differentiate our published SDK from customer-generated clients
  • Add consumerIdentifier and consumerVersion fields to Configuration so consumers can identify themselves: SailPoint-SDK/typescript/1.7.16 (sailpoint-cli/1.2.3)
  • Standardize X-SailPoint-SDK header to typescript/{ver} format
  • Add X-SailPoint-SDK-Runtime (e.g. node/20.10.0) and X-SailPoint-SDK-OS (e.g. linux/x64) telemetry headers

Files changed

  • sdk-output/configuration.ts — new consumer fields on ConfigurationParameters and Configuration class
  • sdk-resources/resources/common.mustache — dynamic User-Agent with consumer suffix, updated X-SailPoint-SDK, added telemetry headers

Test plan

  • Run make build to regenerate all versioned packages
  • Verify sdk-output/v3/common.ts contains new header format
  • Run cd sdk-output && npm test to verify no regressions
  • Verify consumer fields produce parenthetical suffix when set
  • Verify consumer fields are optional (no suffix when unset)

🤖 Generated with Claude Code

Replace generic OpenAPI-Generator User-Agent with SailPoint-SDK/typescript/{ver}
format. Add consumerIdentifier/consumerVersion fields to Configuration
for consumers to identify themselves in the User-Agent via parenthetical
suffix. Standardize X-SailPoint-SDK to typescript/{ver} format and add
X-SailPoint-SDK-Runtime and X-SailPoint-SDK-OS telemetry headers.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…nt-* headers

Format: SailPoint-SDK-TypeScript/{version} ({os}; {arch}) Node/{node-version} (openapi-generator/{gen-version})

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants