Support/override authorization header#25
Open
ryu-sato wants to merge 6 commits intogrowilabs:mainfrom
Open
Conversation
…E.md and README_JP.md
🦋 Changeset detectedLatest commit: 933bb27 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
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
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.
This pull request adds support for custom authorization headers in the
@growi/sdk-typescriptpackage, allowing users to override the default Bearer token authentication. This is particularly useful for environments where GROWI is protected by Digest authentication, Basic authentication, or custom proxy authentication. The changes include updates to documentation (in both English and Japanese), comprehensive test coverage, and additional input validation in theAxiosInstanceManager.Authorization header override and authentication improvements:
authorizationHeaderoption toAxiosInstanceManager.addAxiosInstance(), allowing users to specify custom authorization headers instead of the default Bearer token. When provided, the GROWI access token is sent via theX-GROWI-ACCESS-TOKENheader, supporting Digest, Basic, and custom authentication schemes. [1] [2]Documentation updates:
README.mdandREADME_JP.mdwith detailed explanations and usage examples for the newauthorizationHeaderfunctionality, including code samples for Bearer, Digest, and Basic authentication scenarios. [1] [2] [3] [4]Testing and validation:
axios-instance-manager.test.tsto cover the new functionality, including edge cases and error handling for invalid input.addAxiosInstanceto ensureappName,baseURL, andtokenare non-empty strings, throwing descriptive errors for invalid input.