Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions mintlify/openapi.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 1 addition & 3 deletions openapi.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 4 additions & 5 deletions openapi/components/schemas/errors/Error400.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -135,10 +135,10 @@ properties:
details:
type: object
description: >-
Additional error details. Shape varies by `code`. For field-validation
errors on submit endpoints (e.g. `POST /customers`, `PATCH /customers/{id}`),
`details.errors[]` enumerates every invalid field so platforms can render
form-field-level UX for the entire request in a single round-trip.
Field-level detail. On field-validation errors from submit endpoints
(e.g. `POST /customers`, `PATCH /customers/{id}`), `details.errors[]`
enumerates every invalid field so platforms can render form-field-level
UX for the entire request in a single round-trip.
properties:
errors:
type: array
Expand All @@ -147,4 +147,3 @@ properties:
submit endpoints.
Comment on lines 137 to 147

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

P1 Details Objects Remain Open

Removing additionalProperties: true does not close this object. The contract uses OpenAPI 3.1, where omitting additionalProperties still permits undeclared fields. As a result, the Error400 details object—and the same object in Error423—remains open, so the intended generated-client contract is not established. Declare additionalProperties: false on both objects.

Knowledge Base Used: Grid API contract

Prompt To Fix With AI
This is a comment left during a code review.
Path: openapi/components/schemas/errors/Error400.yaml
Line: 137-147

Comment:
**Details Objects Remain Open**

Removing `additionalProperties: true` does not close this object. The contract uses OpenAPI 3.1, where omitting `additionalProperties` still permits undeclared fields. As a result, the Error400 `details` object—and the same object in Error423—remains open, so the intended generated-client contract is not established. Declare `additionalProperties: false` on both objects.

**Knowledge Base Used:** [Grid API contract](https://app.greptile.com/lightspark/-/custom-context/knowledge-base/lightsparkdev/grid-api/-/docs/api-contract.md)

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

items:
$ref: ./FieldError.yaml
additionalProperties: true
1 change: 0 additions & 1 deletion openapi/components/schemas/errors/Error423.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,3 @@ properties:
format: date-time
failedAttempts:
type: integer
additionalProperties: true
Loading