Skip to content

jimfuqian/BB2-3798 Update readme to reflect smart app v2 scope usage #65

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

Merged
merged 8 commits into from
May 13, 2025

Conversation

JFU-NAVA-PBC
Copy link
Contributor

@JFU-NAVA-PBC JFU-NAVA-PBC commented Apr 10, 2025

JIRA Ticket:
BB2-3798
Update readme text related to scope checking under Smart App v2 scopes (vs legacy scopes)

What Does This PR Do?

Updated readme text related to scope checking under Smart App v2 scopes (vs legacy scopes)

What Should Reviewers Watch For?

If you're reviewing this PR, please check for these things in particular:

Validation

Check the readme is accurate w.r.t access token scopes usage (SMART App v2 scopes)
and optionally, verify that the SDK works with the client code - BB2 Node Sample App:

CMSgov/bluebutton-sample-client-nodejs-react#69

What Security Implications Does This PR Have?

Please indicate if this PR does any of the following:

  • Adds any new software dependencies
  • Modifies any security controls
  • Adds new transmission or storage of data
  • Any other changes that could possibly affect security?
  • Yes, one or more of the above security implications apply. This PR must not be merged without the ISSO or team security engineer's approval.

@JFU-NAVA-PBC JFU-NAVA-PBC changed the title jimfuqian/BB2-3798 Update readme scopes related text to reflect smart app v2 scopes jimfuqian/BB2-3798 Update readme to reflect smart app v2 scopes Apr 30, 2025
@JFU-NAVA-PBC JFU-NAVA-PBC changed the title jimfuqian/BB2-3798 Update readme to reflect smart app v2 scopes jimfuqian/BB2-3798 Update readme to reflect smart app v2 scope usage Apr 30, 2025
@jimmyfagan
Copy link
Contributor

The last two commits here changed a bunch of files, can you say a bit about what that doc regen was, how you ran it, and why it was needed? Should those files be put in a .gitignore or something instead of having to add manual steps to keep them updated?

@JFU-NAVA-PBC
Copy link
Contributor Author

The last two commits here changed a bunch of files, can you say a bit about what that doc regen was, how you ran it, and why it was needed? Should those files be put in a .gitignore or something instead of having to add manual steps to keep them updated?

sdk javascript source is annotated at methods and classes level - like javadoc for java codes, it provides more details beyond readme, it is surposedly direct consume from the source tree without going into the source code, and it is hierarchically organized for easy drill down, e.g. I wanted to see what are in AuthorizationToken...

image

note,

it is not packaged with the sdk tarball.
it common practice for node project and good to keep...

@JFU-NAVA-PBC JFU-NAVA-PBC merged commit 25e058c into main May 13, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants