Skip to content

Standardize User-Agent and add telemetry headers#129

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

Standardize User-Agent and add telemetry headers#129
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.4.17/python User-Agent with SailPoint-SDK/python/1.4.17 to differentiate our published SDK from customer-generated clients
  • Add consumer_identifier and consumer_version fields to Configuration so consumers can identify themselves: SailPoint-SDK/python/1.4.17 (sailpoint-cli/1.2.3)
  • Add previously missing X-SailPoint-SDK header as python/{ver} (was not sent at all before)
  • Add X-SailPoint-SDK-Runtime (e.g. python/3.12.1) and X-SailPoint-SDK-OS (e.g. linux/x86_64) telemetry headers

Files changed

  • sailpoint/configuration.py — new consumer identifier fields
  • sdk-resources/resources/api_client.mustache — updated UA string, added consumer suffix logic, added X-SailPoint-SDK + telemetry headers, added platform/sys imports

Test plan

  • Run make build to regenerate all versioned packages
  • Verify sailpoint/v3/api_client.py contains new UA and X-SailPoint-SDK header
  • Run python validation_test.py -v 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/python/{ver}
format. Add consumer_identifier/consumer_version fields to Configuration
for consumers to identify themselves in the User-Agent via parenthetical
suffix. Add previously missing X-SailPoint-SDK header (python/{ver}) 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-Python/{version} ({os}; {arch}) Python/{py-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