-
Notifications
You must be signed in to change notification settings - Fork 80
Add manifest v2 schema #1011
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
Add manifest v2 schema #1011
Conversation
schema/app-manifest.schema.yaml
Outdated
| "id": { | ||
| "type": "string", | ||
| "description": "The unique identifier for the managed resource", | ||
| "pattern": "^[a-z]{1,7}(?:_test)?_6[a-zA-Z0-9]{31,}$" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
derived the pattern from https://docs.google.com/document/d/1L2O79xIkdtzOZjwLnvntQYbm0EUsAGLdttVGFqF96CQ/edit?tab=t.0, might need to retest with actual examples because the example on https://docs.stripe.com/api/v2/core/event_destinations didn't seem to match either of the definition of compartment_id or object_id
schema/app-manifest.schema.yaml
Outdated
| @@ -0,0 +1,244 @@ | |||
| { | |||
| "$id": "https://stripe.com/app-manifest.schema.json", | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we may need to revisit calling it app-manifest here before publishing to the JSON Schema Store
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we settled on calling this stripe-manifest
406dcd7 to
4e4dd39
Compare
4e4dd39 to
67deeb4
Compare
67deeb4 to
86790bf
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
a question about the permissions
| "markdownDescription": "The ID of the permission. [Read more about permissions](https://stripe.com/docs/stripe-apps/reference/permissions).", | ||
| "enum": [ | ||
| "account_link_write", | ||
| "application_fee_read", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
what will the process be for updating this?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we might just have to add a pr like how sasha did with the post install action #1010 and I haven't looked into how to publish to the json schema library but we probably need to do that as well
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yeah I think that makes sense for now!
7e50c8d to
567ac39
Compare
Summary
stripe-app.yamlMotivation
https://jira.corp.stripe.com/browse/APPLCM-3355
Test
In repo with manifest yaml:
Go to VS Code Settings >> search yaml schema >> edit in settings.json >> add
"yaml.schemas": { "/Users/mchu/stripe/stripe-apps/schema/app-manifest.schema.yaml": "app-manifest.yaml" },>> restart VS Code