Skip to content

feat: add optional scopes to oauth_config schema#64

Merged
mwbrooks merged 2 commits into
mainfrom
mwbrooks-optional-scopes
May 1, 2026
Merged

feat: add optional scopes to oauth_config schema#64
mwbrooks merged 2 commits into
mainfrom
mwbrooks-optional-scopes

Conversation

@mwbrooks
Copy link
Copy Markdown
Member

@mwbrooks mwbrooks commented May 1, 2026

Summary

This pull request adds user_optional and bot_optional scope arrays to the oauth_config.scopes schema definition in both v1 and v2 manifest schemas.

Also updates development documentation to recommend using a .venv virtual environment.

Testing

  • Verify the new user_optional and bot_optional properties appear under oauth_config.scopes in both schemas/manifest.schema.1.0.0.json and schemas/manifest.schema.2.0.0.json
  • Confirm the new properties follow the same constraints as existing user and bot (string items, maxLength 50, maxItems 255)

Category

  • manifest.schema.json edit
  • /schema and/or its core components
  • Others

Requirements

  • I've read and agree to the Code of Conduct.
  • I've run ./scripts/install_all_and_run_tests.sh after making the changes.

@mwbrooks mwbrooks self-assigned this May 1, 2026
@mwbrooks mwbrooks added enhancement New feature or request semver:minor labels May 1, 2026
@mwbrooks mwbrooks marked this pull request as ready for review May 1, 2026 21:52
Copy link
Copy Markdown
Member Author

@mwbrooks mwbrooks left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comments for the kind reviewers

Comment thread AGENTS.md
Comment on lines +10 to +13
# Create and activate a virtual environment (first time only)
python -m venv .venv
source .venv/bin/activate

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note: Follow-up on #63 (comment)

Comment on lines +61 to +64
```bash
source .venv/bin/activate
pip install -U -e .
```
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note: Follow-up on #63 (comment)

Copy link
Copy Markdown
Member

@zimeg zimeg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mwbrooks Thanks for taking these features to the finish line 🏁

},
"maxItems": 255
},
"user_optional": {
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📚 suggestion(non-blocking): Let's add the description to version 1 as well? I find this format is used often in existing apps. No blocker because I realize this might be a pattern throughout this file!

An array of strings containing optional user scopes. Optional scopes must also be listed in the corresponding user fields.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@zimeg Can we look at this in a different PR? There are no descriptions in version 1 format and I'm unsure why or what side effects happen if we add the description field.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mwbrooks Of course! I understand this might've been generated too and changing it too much can make later understandings confused.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome, thanks!

@mwbrooks
Copy link
Copy Markdown
Member Author

mwbrooks commented May 1, 2026

Thanks for the quick reviews @zimeg! 🙇🏻

@mwbrooks mwbrooks merged commit efc89b6 into main May 1, 2026
4 checks passed
@mwbrooks mwbrooks deleted the mwbrooks-optional-scopes branch May 1, 2026 22:52
@mwbrooks mwbrooks mentioned this pull request May 4, 2026
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request semver:minor

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants