misalignment between code and doc
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 55/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- angular, aws, javascript, node.js
- Domain
- backend, documentation, frontend
Research direction
Compare the AWS Cognito documentation with box-node-cognito-lambdas-sample/tokenExchange/box-manager.js and box-aws-cognito-angular2-skeleton-app-sample/src/app/config/box/box.config.ts. First inspect the referenced code and the corresponding documentation, then make the environment-variable and custom-attribute names consistent across both examples. Done means the docs and sample code use matching names.
Written by the indexing model from the issue text.
Description
Hi,
The first issue is
For the AWS Cognito examples using lambda, it is said in doc to use the following env variable:
BOX_PRIVATE_KEY_PASSPHRASE = <YOUR_APP_PRIVATE_KEY_PASSPHRASE>
but the lambda code is using BOX_PRIVATE_KEY_PASSWORD (see https://github.com/box/samples/blob/cognito_integration/box-node-cognito-lambdas-sample/tokenExchange/box-manager.js#L16)
The second issue is with the angular2 application
Its mentioned to add a custom attribute called custom:box_appuser_id which will store the box id for the given account.
but the application is using box_appuser_token (see https://github.com/box/samples/blob/master/box-aws-cognito-angular2-skeleton-app-sample/src/app/config/box/box.config.ts#L10)
- Dominant language
- JavaScript
- Stars
- 71
- Forks
- 83
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from box/samples
-
Difficulty 3/5 1-2 days Newbie friendliness 25/100
-
Difficulty 3/5 1-2 days Newbie friendliness 30/100
-
Difficulty 1/5 Under an hour Newbie friendliness 45/100
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
HarperFast/skills#96 ·
-
[Block] Latest Posts [Type] Bug
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Automattic/studio#4908 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
sugarlabs/musicblocks#8847 ·