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.

Sign up for GitHub

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

Jump to bottom

API key header name doesn't match documented header name #1713

Closed
aryzing opened this issue Jun 29, 2024 · 1 comment · Fixed by hirosystems/docs#699
Closed

API key header name doesn't match documented header name #1713

aryzing opened this issue Jun 29, 2024 · 1 comment · Fixed by hirosystems/docs#699
Assignees
@janniks
Labels
bug Unwanted or unintended logic causing harm

Comments

@aryzing
Copy link

aryzing commented Jun 29, 2024

What version of Stacks.js are you using?

Commit 2c57ea4e5abed76da903f5138c79c1d2eceb008b (v6.16.0-beta.3)

Describe the bug

The http header for the api key defaults to x-api-key yet the docs use x-hiro-api-key

Is it a bug in the docs / code or are both allowed?
@aryzing aryzing added the bug Unwanted or unintended logic causing harm label Jun 29, 2024
@github-project-automation github-project-automation bot moved this to 🆕 New in DevTools Jun 29, 2024
@smcclellan smcclellan moved this from 🆕 New to 📋 Backlog in DevTools Jul 1, 2024
@janniks janniks mentioned this issue Jul 12, 2024
Merged
@janniks
Copy link
Collaborator

janniks commented Jul 12, 2024

Thanks, now updated in hirosystems/docs#699 -- both work, but we're airing on the side of the default non-hiro branded header

@janniks janniks closed this as completed Jul 12, 2024
@github-project-automation github-project-automation bot moved this from 📋 Backlog to ✅ Done in DevTools Jul 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@janniks janniks

Labels
bug Unwanted or unintended logic causing harm
Projects
DevTools
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: update api key header hirosystems/docs
2 participants
@aryzing @janniks