Skip to content

Conversation

@mchu2-stripe
Copy link
Contributor

@mchu2-stripe mchu2-stripe commented Sep 8, 2025

Summary

  • adds a schema for manifest version two: stripe-app.yaml

Motivation

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

Screenshot 2025-09-08 at 2 25 01 PM

"id": {
"type": "string",
"description": "The unique identifier for the managed resource",
"pattern": "^[a-z]{1,7}(?:_test)?_6[a-zA-Z0-9]{31,}$"
Copy link
Contributor Author

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

@@ -0,0 +1,244 @@
{
"$id": "https://stripe.com/app-manifest.schema.json",
Copy link
Contributor Author

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

Copy link
Contributor Author

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

@mchu2-stripe mchu2-stripe force-pushed the mchu/add-manifest-v2-schema branch from 406dcd7 to 4e4dd39 Compare September 8, 2025 21:57
@mchu2-stripe mchu2-stripe force-pushed the mchu/add-manifest-v2-schema branch from 67deeb4 to 86790bf Compare September 9, 2025 23:29
Copy link
Collaborator

@chaves-stripe chaves-stripe left a 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

r? @mchu2-stripe

"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",
Copy link
Collaborator

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?

Copy link
Contributor Author

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

Copy link
Collaborator

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!

@mchu2-stripe mchu2-stripe force-pushed the mchu/add-manifest-v2-schema branch from 7e50c8d to 567ac39 Compare September 24, 2025 03:59
@mchu2-stripe mchu2-stripe merged commit 4d58fcb into main Sep 24, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants