Skip to content
This repository has been archived by the owner on Jan 15, 2024. It is now read-only.

Commit

Permalink
Add readOnly in a lot of places
Browse files Browse the repository at this point in the history
  • Loading branch information
Sarah Riehl committed Dec 21, 2023
1 parent 6258713 commit 4b34561
Showing 1 changed file with 23 additions and 11 deletions.
34 changes: 23 additions & 11 deletions reference/customers.v2.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -606,8 +606,9 @@ paths:
properties:
id:
type: integer
description: ID of this customer address. READ-ONLY
description: ID of this customer address. Read-Only.
example: 3
readOnly: true
customer_id:
type: integer
description: ID of the associated customer.
Expand Down Expand Up @@ -649,8 +650,9 @@ paths:
example: United States
country_iso2:
type: string
description: 2-letter ISO Alpha-2 code for the customer’s country. READ-ONLY
description: 2-letter ISO Alpha-2 code for the customer’s country. Read-Only.
example: US
readOnly: true
phone:
type: string
description: The customer’s phone number.
Expand Down Expand Up @@ -1143,15 +1145,18 @@ components:
properties:
id:
type: integer
description: Unique numeric ID of this customer. This is a READ-ONLY field; do not set or modify its value in a POST or PUT request.
description: Unique numeric ID of this customer. This is a Read-Only field; do not set or modify its value in a POST or PUT request.
example: 1
readOnly: true
date_created:
type: string
description: Date on which the customer registered from the storefront or was created in the control panel. This is a READ-ONLY field; do not set or modify its value in a POST or PUT request.
description: Date on which the customer registered from the storefront or was created in the control panel. This is a Read-Only field; do not set or modify its value in a POST or PUT request.
readOnly: true
date_modified:
type: string
description: |
Date on which the customer updated their details in the storefront or was updated in the control panel. This is a READ-ONLY field; do not set or modify its value in a POST or PUT request.
Date on which the customer updated their details in the storefront or was updated in the control panel. This is a Read-Only field; do not set or modify its value in a POST or PUT request.
readOnly: true
- $ref: '#/components/schemas/customer_Base'
x-internal: false
x-examples: {}
Expand Down Expand Up @@ -1198,12 +1203,14 @@ components:
properties:
id:
type: integer
description: ID of this customer address. READ-ONLY
description: ID of this customer address. Read-Only.
example: 3
readOnly: true
country_iso2:
type: string
description: 2-letter ISO Alpha-2 code for the customer’s country. READ-ONLY
description: 2-letter ISO Alpha-2 code for the customer’s country. Read-Only.
example: US
readOnly: true
- $ref: '#/components/schemas/customerAddress_Base'
x-internal: false
customerGroup_Full:
Expand Down Expand Up @@ -1473,8 +1480,9 @@ components:
example: /customers/5/addresses
form_fields:
type: array
description: Array of custom fields. This is a READ-ONLY field; do not set or modify its value in a POST or PUT request.
description: Array of custom fields. This is a Read-Only field; do not set or modify its value in a POST or PUT request.
nullable: true
readOnly: true
items:
title: Form Fields
type: object
Expand All @@ -1501,8 +1509,9 @@ components:
properties:
id:
type: integer
description: Unique numeric ID of this customer. This is a READ-ONLY field; do not set or modify its value in a POST or PUT request.
description: Unique numeric ID of this customer. This is a Read-Only field; do not set or modify its value in a POST or PUT request.
example: 1
readOnly: true
_authentication:
type: object
properties:
Expand Down Expand Up @@ -1535,11 +1544,13 @@ components:
example: '1234567890'
date_created:
type: string
description: Date on which the customer registered from the storefront or was created in the control panel. This is a READ-ONLY field; do not set or modify its value in a POST or PUT request.
description: Date on which the customer registered from the storefront or was created in the control panel. This is a Read-Only field; do not set or modify its value in a POST or PUT request.
readOnly: true
date_modified:
type: string
description: |-
Date on which the customer updated their details in the storefront or was updated in the control panel. This is a READ-ONLY field; do not set or modify its value in a POST or PUT request.
readOnly: true
store_credit:
type: string
description: The amount of credit the customer has. (Float, Float as String, Integer)
Expand Down Expand Up @@ -1577,7 +1588,8 @@ components:
example: /customers/5/addresses
form_fields:
type: array
description: Array of custom fields. This is a READ-ONLY field; do not set or modify its value in a POST or PUT request.
description: Array of custom fields. This is a Read-Only field; do not set or modify its value in a POST or PUT request.
readOnly: true
items:
title: Form Fields
type: object
Expand Down

0 comments on commit 4b34561

Please sign in to comment.