Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Example on Sending Custom Param/Header #144

Merged
merged 1 commit into from
Dec 26, 2023

Conversation

dvonthenen
Copy link
Contributor

Proposed changes

This is an example on sending a custom query parameter and a custom header for a given REST API call. Since these are custom, by definition there is zero error checking that happens.

// example on how to send a custom header
headers := make(map[string][]string, 0)
headers["MY-CUSTOM-HEADER"] = []string{"CUSTOM"}
ctx = cfginterfaces.WithCustomHeaders(ctx, headers)

// example on how to send a custom parameter
params := make(map[string][]string, 0)
params["utterances"] = []string{"true"}
ctx = cfginterfaces.WithCustomParameters(ctx, params)

If you enable verbose debugging, this is what it looks like then under the covers:

I1214 06:41:45.807373    4217 client.go:131] Connecting to https://api.deepgram.com/v1/listen?diarize=true&language=en-US&punctuate=true&utterances=true
I1214 06:41:45.807446    4217 client.go:143] Custom Header: MY-CUSTOM-HEADER = CUSTOM

Types of changes

What types of changes does your code introduce to the community Go SDK?
Put an x in the boxes that apply

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update or tests (if none of the other choices apply)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

  • I have read the CONTRIBUTING doc
  • Lint and unit tests pass locally with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)
  • Any dependent changes have been merged and published in downstream modules

Further comments

NA

@dvonthenen dvonthenen merged commit da3d074 into deepgram:main Dec 26, 2023
1 check passed
@dvonthenen dvonthenen deleted the example-custom-param-header branch December 26, 2023 17:05
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