Skip to content

docs(spec): clarify customerType is immutable on PATCH /customers #497

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

Closed
jklein24 wants to merge 1 commit into from
+27 −3
Closed

docs(spec): clarify customerType is immutable on PATCH /customers #497

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 9 additions & 1 deletion mintlify/openapi.yaml
View file
Open in desktop

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

10 changes: 9 additions & 1 deletion openapi.yaml
View file
Open in desktop

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

10 changes: 9 additions & 1 deletion openapi/components/schemas/customers/CustomerUpdateRequest.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,15 @@ required:
- customerType
properties:
customerType:
$ref: ./CustomerType.yaml
allOf:
- $ref: ./CustomerType.yaml
description: |
Must equal the existing customer's `customerType`. This field is required
on PATCH because it discriminates the request body shape (INDIVIDUAL vs
BUSINESS); it is not the way to change customer type. Requests that
submit a different `customerType` than the existing record will be
rejected with `INVALID_INPUT`. To change the legal classification of a
customer, create a new customer and migrate its accounts.
currencies:
type: array
items:
Expand Down
Loading