-
Notifications
You must be signed in to change notification settings - Fork 3
feat: rename accounts to data in list external accounts response #127
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
base: 01-24-feat_convert_single-value_enums_to_const_for_base_types
Are you sure you want to change the base?
Conversation
|
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.
This stack of pull requests is managed by Graphite. Learn more about stacking. |
Greptile OverviewGreptile SummaryRenamed the response property from Key changes:
Breaking change: This is a breaking change for existing API consumers. Any clients currently accessing Consistency achieved: This change standardizes the API to use Confidence Score: 5/5
|
| Filename | Overview |
|---|---|
| openapi/paths/platform/platform_external_accounts.yaml | Renamed response property from accounts to data for API consistency |
| openapi.yaml | Bundled OpenAPI spec with updated data property (auto-generated from source) |
| mintlify/openapi.yaml | Mintlify copy of bundled spec with updated data property (auto-generated) |
Sequence Diagram
sequenceDiagram
participant Client
participant API as Grid API
participant DB as Database
Note over Client,DB: List Platform External Accounts Request
Client->>API: GET /platform/external-accounts
activate API
Note right of Client: Authentication via Basic Auth
API->>DB: Query external accounts
activate DB
DB-->>API: Return account records
deactivate DB
API->>API: Build response with "data" property
Note right of API: Changed from "accounts" to "data"<br/>for consistency with other endpoints
API-->>Client: 200 OK
deactivate API
Note left of API: Response:<br/>{<br/> "data": [...]<br/>}<br/>(previously "accounts")

TL;DR
Updated the response schema for external accounts endpoint to use
datainstead ofaccountsas the property name.What changed?
Changed the required property name in the external accounts API response from
accountstodata. This affects the schema definition in the OpenAPI specification across multiple files:mintlify/openapi.yamlopenapi.yamlopenapi/paths/platform/platform_external_accounts.yamlHow to test?
dataarray instead of anaccountsarrayWhy make this change?
This change standardizes the API response format to be consistent with other endpoints in the system that use
dataas the top-level property for array responses. This improves API consistency and makes client integration more predictable.