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

Sync API permissions in JSON file with Markdown documentation #1496

Open
1 task
james-garriss opened this issue Jan 8, 2025 · 0 comments
Open
1 task

Sync API permissions in JSON file with Markdown documentation #1496

james-garriss opened this issue Jan 8, 2025 · 0 comments
Labels
documentation This issue or pull request improves or adds to documentation enhancement This issue or pull request will add new or improve existing functionality
Milestone

Comments

@james-garriss
Copy link
Collaborator

💡 Summary

Microsoft recently created an API permissions file in JSON that lists and consolidates all of the permissions that ScubaGear needs to access the various M365 APIs. We need to ensure that these permissions are sync'd with those listed in our documentation:

https://github.com/cisagov/ScubaGear/blob/main/docs/prerequisites/interactive.md
https://github.com/cisagov/ScubaGear/blob/main/docs/prerequisites/noninteractive.md

Motivation and context

This should ensure that our documentation is in sync with reality.

Implementation notes

There are at least 3 ways this could be done:

  • The docs could just point to JSON, which is what our dependencies page does. This is perhaps the best way to avoid DRY.
  • There could be a utility or a workflow that that reads the JSON and creates corresponding Markdown. Microsoft has indicated that they already have code that could do this (or be mod'd to do this).
  • There could be a utility or a workflow that reads the JSON and the Markdown files and compares the two of them.

Acceptance criteria

How do we know when this work is done?

  • There is a non-manual way to verify that the required permissions are sync'd with the docs.
@james-garriss james-garriss added documentation This issue or pull request improves or adds to documentation enhancement This issue or pull request will add new or improve existing functionality labels Jan 8, 2025
@james-garriss james-garriss added this to the Backlog milestone Jan 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This issue or pull request improves or adds to documentation enhancement This issue or pull request will add new or improve existing functionality
Projects
None yet
Development

No branches or pull requests

1 participant