Skip to content

feat: rename Error to GridError and add additionalProperties to error schemas #131

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.

Sign up for GitHub

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

Jump to bottom
Open
pengying wants to merge 1 commit into
base: 01-24-feat_flatten_lightningexternalaccountinfo_schema_split_split_split
Choose a base branch
from
Open

feat: rename Error to GridError and add additionalProperties to error schemas #131

pengying wants to merge 1 commit into from
+112 −39

Conversation

@pengying
Copy link
Contributor

@pengying pengying commented Jan 24, 2026 •
edited
Loading

TL;DR

Added a new GridError schema and improved error handling in the OpenAPI specification.

What changed?

  • Created a new GridError schema to standardize error responses
  • Added additionalProperties: true to all error schema details objects to allow for flexible error details
  • Refactored BulkCustomerImportErrorEntry to extend from GridError instead of using a nested error structure
  • Updated webhook response schemas to reference GridError instead of Error

This was referenced Jan 24, 2026
Merged
Merged
@pengying Graphite App
Copy link
Contributor Author

pengying commented Jan 24, 2026 •
edited
Loading

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more

This stack of pull requests is managed by Graphite. Learn more about stacking.

This was referenced Jan 24, 2026
Merged
Open
Open
Open
@pengying pengying marked this pull request as ready for review January 24, 2026 22:55
@greptile-apps
Copy link

greptile-apps bot commented Jan 24, 2026 •
edited
Loading

Greptile Overview

Greptile Summary

This PR standardizes error handling across the Grid API by introducing a new GridError schema and enhancing flexibility in error response objects.

Key Changes

  • New GridError schema: Created a reusable base error schema with code, message, and flexible details object
  • Enhanced error flexibility: Added additionalProperties: true to the details object in all HTTP error schemas (Error400-501), allowing APIs to include arbitrary additional error context
  • Refactored bulk import errors: Changed BulkCustomerImportErrorEntry to extend GridError using allOf composition, eliminating nested error structures
  • Updated webhook responses: Migrated IncomingPaymentWebhookForbiddenResponse and IncomingPaymentWebhookUnprocessableResponse from Error to GridError

Issues Found

One file still references the old Error.yaml schema at openapi/paths/customers/customers_{customerId}.yaml:145. This needs to be updated to GridError.yaml to complete the migration.

Confidence Score: 4/5

  • Safe to merge after fixing the one remaining Error.yaml reference
  • The changes are well-structured and consistent across the codebase, with proper use of OpenAPI composition patterns. However, one file was missed in the migration from Error to GridError, which needs to be corrected to avoid schema inconsistencies.
  • openapi/paths/customers/customers_{customerId}.yaml needs to be updated to reference GridError.yaml instead of Error.yaml

Important Files Changed
Filename Overview
openapi/components/schemas/common/GridError.yaml Added new standardized error schema with flexible details object
openapi/components/schemas/customers/BulkCustomerImportErrorEntry.yaml Refactored to extend GridError using allOf composition
openapi/components/schemas/errors/Error400.yaml Added additionalProperties: true to details object for flexibility
openapi/components/schemas/webhooks/IncomingPaymentWebhookForbiddenResponse.yaml Updated to extend GridError instead of Error
openapi.yaml Bundled OpenAPI spec with all error schema updates, but has one outdated Error reference

Sequence Diagram

 
sequenceDiagram
    participant Client
    participant API
    participant ErrorHandler
    participant Response

    Note over Client,Response: Error Schema Standardization Flow

    Client->>API: Make API Request
    API->>ErrorHandler: Process Request
    
    alt Request Error (400-level)
        ErrorHandler->>Response: Generate Error400/401/403/404/409/412
        Note over Response: Uses status-specific schema<br/>with additionalProperties: true
        Response-->>Client: Return HTTP Error with details object
    else Server Error (500-level)
        ErrorHandler->>Response: Generate Error500/501
        Note over Response: Uses status-specific schema<br/>with additionalProperties: true
        Response-->>Client: Return HTTP Error with details object
    else Webhook Response Error
        ErrorHandler->>Response: Generate GridError-based response
        Note over Response: IncomingPaymentWebhookForbiddenResponse<br/>or IncomingPaymentWebhookUnprocessableResponse<br/>extends GridError
        Response-->>Client: Return webhook error response
    else Bulk Import Error
        ErrorHandler->>Response: Generate BulkCustomerImportErrorEntry
        Note over Response: Extends GridError with correlationId<br/>using allOf composition
        Response-->>Client: Return error entry in bulk job results
    end

    Note over Response: All error schemas now include<br/>additionalProperties: true on details<br/>for flexible error information
Loading

@pengying pengying force-pushed the 01-24-feat_flatten_lightningexternalaccountinfo_schema_split_split_split_split branch from 6432728 to e5749d2 Compare January 27, 2026 01:29
greptile-apps[bot]
greptile-apps bot reviewed Jan 27, 2026
View reviewed changes
Copy link

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

1 file reviewed, 1 comment

Edit Code Review Agent Settings | Greptile

@greptile-apps
Copy link

greptile-apps bot commented Jan 27, 2026

Additional Comments (1)

openapi/paths/customers/customers_{customerId}.yaml
Incomplete migration: still references Error.yaml instead of GridError.yaml. For consistency with the rest of this PR, this should be updated to use GridError.yaml.

            $ref: ../../components/schemas/common/GridError.yaml
Prompt To Fix With AI 
This is a comment left during a code review.
Path: openapi/paths/customers/customers_{customerId}.yaml
Line: 145:145

Comment:
Incomplete migration: still references `Error.yaml` instead of `GridError.yaml`. For consistency with the rest of this PR, this should be updated to use `GridError.yaml`.

```suggestion
            $ref: ../../components/schemas/common/GridError.yaml
```

How can I resolve this? If you propose a fix, please make it concise.

@pengying pengying force-pushed the 01-24-feat_flatten_lightningexternalaccountinfo_schema_split_split_split branch from 68ab09c to 5786fb9 Compare January 27, 2026 05:18
@pengying pengying force-pushed the 01-24-feat_flatten_lightningexternalaccountinfo_schema_split_split_split_split branch from e5749d2 to a27f6e6 Compare January 27, 2026 05:19
greptile-apps[bot]
greptile-apps bot reviewed Jan 27, 2026
View reviewed changes
Copy link

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

1 file reviewed, 1 comment

Edit Code Review Agent Settings | Greptile

@greptile-apps
Copy link

greptile-apps bot commented Jan 27, 2026

Additional Comments (1)

openapi/paths/customers/customers_{customerId}.yaml
Inconsistent error schema reference - should use GridError.yaml instead of Error.yaml to match the PR's goal of standardizing on GridError

            $ref: ../../components/schemas/common/GridError.yaml
Prompt To Fix With AI 
This is a comment left during a code review.
Path: openapi/paths/customers/customers_{customerId}.yaml
Line: 145:145

Comment:
Inconsistent error schema reference - should use `GridError.yaml` instead of `Error.yaml` to match the PR's goal of standardizing on `GridError`

```suggestion
            $ref: ../../components/schemas/common/GridError.yaml
```

How can I resolve this? If you propose a fix, please make it concise.

@pengying pengying force-pushed the 01-24-feat_flatten_lightningexternalaccountinfo_schema_split_split_split branch from 5786fb9 to 79467e5 Compare January 27, 2026 05:24
@pengying pengying force-pushed the 01-24-feat_flatten_lightningexternalaccountinfo_schema_split_split_split_split branch from a27f6e6 to a1379cd Compare January 27, 2026 05:24
greptile-apps[bot]
greptile-apps bot reviewed Jan 27, 2026
View reviewed changes
Copy link

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

1 file reviewed, 1 comment

Edit Code Review Agent Settings | Greptile

@greptile-apps
Copy link

greptile-apps bot commented Jan 27, 2026

Additional Comments (1)

openapi/paths/customers/customers_{customerId}.yaml
Update this to reference GridError for consistency with other error responses

            $ref: ../../components/schemas/common/GridError.yaml

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

Prompt To Fix With AI 
This is a comment left during a code review.
Path: openapi/paths/customers/customers_{customerId}.yaml
Line: 145:145

Comment:
Update this to reference `GridError` for consistency with other error responses

```suggestion
            $ref: ../../components/schemas/common/GridError.yaml
```

<sub>Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!</sub>

How can I resolve this? If you propose a fix, please make it concise.

@pengying pengying force-pushed the 01-24-feat_flatten_lightningexternalaccountinfo_schema_split_split_split branch from 79467e5 to 9f4bbd9 Compare January 27, 2026 20:38
@pengying pengying force-pushed the 01-24-feat_flatten_lightningexternalaccountinfo_schema_split_split_split_split branch from a1379cd to d0f0475 Compare January 27, 2026 20:38
greptile-apps[bot]
greptile-apps bot reviewed Jan 27, 2026
View reviewed changes
Copy link

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

1 file reviewed, 1 comment

Edit Code Review Agent Settings | Greptile

@greptile-apps
Copy link

greptile-apps bot commented Jan 27, 2026

Additional Comments (1)

openapi/paths/customers/customers_{customerId}.yaml
inconsistent reference - should use GridError instead of Error to match the pattern established in this PR

            $ref: ../../components/schemas/common/GridError.yaml
Prompt To Fix With AI 
This is a comment left during a code review.
Path: openapi/paths/customers/customers_{customerId}.yaml
Line: 145:145

Comment:
inconsistent reference - should use `GridError` instead of `Error` to match the pattern established in this PR

```suggestion
            $ref: ../../components/schemas/common/GridError.yaml
```

How can I resolve this? If you propose a fix, please make it concise.

@pengying pengying force-pushed the 01-24-feat_flatten_lightningexternalaccountinfo_schema_split_split_split_split branch from d0f0475 to 94a379a Compare January 27, 2026 21:19
@pengying pengying force-pushed the 01-24-feat_flatten_lightningexternalaccountinfo_schema_split_split_split branch from 9f4bbd9 to 4e17d69 Compare January 27, 2026 21:19
greptile-apps[bot]
greptile-apps bot reviewed Jan 27, 2026
View reviewed changes
Copy link

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

1 file reviewed, 1 comment

Edit Code Review Agent Settings | Greptile

@greptile-apps
Copy link

greptile-apps bot commented Jan 27, 2026

Additional Comments (1)

openapi/paths/customers/customers_{customerId}.yaml
this should reference GridError.yaml not Error.yaml for consistency with the rest of the PR

            $ref: ../../components/schemas/common/GridError.yaml
Prompt To Fix With AI 
This is a comment left during a code review.
Path: openapi/paths/customers/customers_{customerId}.yaml
Line: 145:145

Comment:
this should reference `GridError.yaml` not `Error.yaml` for consistency with the rest of the PR

```suggestion
            $ref: ../../components/schemas/common/GridError.yaml
```

How can I resolve this? If you propose a fix, please make it concise.

@pengying pengying force-pushed the 01-24-feat_flatten_lightningexternalaccountinfo_schema_split_split_split branch from 4e17d69 to 5022722 Compare January 27, 2026 23:54
@pengying pengying force-pushed the 01-24-feat_flatten_lightningexternalaccountinfo_schema_split_split_split_split branch from 94a379a to c72b46f Compare January 27, 2026 23:54
@pengying pengying force-pushed the 01-24-feat_flatten_lightningexternalaccountinfo_schema_split_split_split_split branch from c72b46f to 99a29c9 Compare January 27, 2026 23:57
@pengying pengying force-pushed the 01-24-feat_flatten_lightningexternalaccountinfo_schema_split_split_split branch from 5022722 to 03ebf04 Compare January 27, 2026 23:57
greptile-apps[bot]
greptile-apps bot reviewed Jan 28, 2026
View reviewed changes
Copy link

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

1 file reviewed, 1 comment

Edit Code Review Agent Settings | Greptile

@greptile-apps
Copy link

greptile-apps bot commented Jan 28, 2026

Additional Comments (1)

openapi/paths/customers/customers_{customerId}.yaml
reference to Error.yaml should be updated to GridError.yaml for consistency

            $ref: ../../components/schemas/common/GridError.yaml
Prompt To Fix With AI 
This is a comment left during a code review.
Path: openapi/paths/customers/customers_{customerId}.yaml
Line: 145:145

Comment:
reference to `Error.yaml` should be updated to `GridError.yaml` for consistency

```suggestion
            $ref: ../../components/schemas/common/GridError.yaml
```

How can I resolve this? If you propose a fix, please make it concise.

@pengying pengying force-pushed the 01-24-feat_flatten_lightningexternalaccountinfo_schema_split_split_split_split branch from 99a29c9 to d8d7c4d Compare January 28, 2026 00:08
@pengying pengying force-pushed the 01-24-feat_flatten_lightningexternalaccountinfo_schema_split_split_split branch from 03ebf04 to db286da Compare January 28, 2026 00:08
greptile-apps[bot]
greptile-apps bot reviewed Jan 28, 2026
View reviewed changes
Copy link

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

1 file reviewed, 1 comment

Edit Code Review Agent Settings | Greptile

@greptile-apps
Copy link

greptile-apps bot commented Jan 28, 2026

Additional Comments (1)

openapi/paths/customers/customers_{customerId}.yaml
Still references old Error.yaml instead of GridError.yaml

            $ref: ../../components/schemas/common/GridError.yaml
Prompt To Fix With AI 
This is a comment left during a code review.
Path: openapi/paths/customers/customers_{customerId}.yaml
Line: 145:145

Comment:
Still references old `Error.yaml` instead of `GridError.yaml`

```suggestion
            $ref: ../../components/schemas/common/GridError.yaml
```

How can I resolve this? If you propose a fix, please make it concise.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@greptile-apps greptile-apps[bot] greptile-apps[bot] left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@pengying