Standardize User-Agent and add telemetry headers#155
Open
luke-hagar-sp wants to merge 1 commit intomainfrom
Open
Standardize User-Agent and add telemetry headers#155luke-hagar-sp wants to merge 1 commit intomainfrom
luke-hagar-sp wants to merge 1 commit intomainfrom
Conversation
Replace generic OpenAPI-Generator User-Agent with SailPoint-SDK/powershell/{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 powershell/{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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
OpenAPI-Generator/1.7.16/psUser-Agent withSailPoint-SDK/powershell/1.7.16to differentiate our published SDK from customer-generated clientsConsumerIdentifierandConsumerVersionconfiguration fields so consumers can identify themselves:SailPoint-SDK/powershell/1.7.16 (sailpoint-cli/1.2.3)X-SailPoint-SDKheader topowershell/{ver}format (wasPowershell-{ver})X-SailPoint-SDK-Runtime(e.g.powershell/7.4.1) andX-SailPoint-SDK-OStelemetry headersFiles changed
PSSailpoint/Configuration.ps1— new consumer fields inGet-DefaultConfigurationandSet-DefaultConfigurationsdk-resources/resources/api_client.mustache— dynamic User-Agent with consumer suffix, updated X-SailPoint-SDK, added telemetry headersTest plan
make buildto regenerate all versioned packagesPSSailpoint/v3/src/PSSailpoint.V3/Private/ApiClient.ps1contains new header formatInvoke-Pester -Output Detailed ./PSSailpoint/tests/to verify no regressionsSet-DefaultConfiguration -ConsumerIdentifier "my-app" -ConsumerVersion "1.0"works🤖 Generated with Claude Code