Skip to content

Commit b52cd71

Browse files
authored
DEVDOCS-6658 Replace placeholder values with realistic examples in B2B Edition API specifications (#1183)
# [DEVDOCS-6658] ## What changed? Replace placeholder values with realistic examples in B2B Edition API specifications ## Release notes draft None [DEVDOCS-6658]: https://bigcommercecloud.atlassian.net/browse/DEVDOCS-6658?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
1 parent 7518232 commit b52cd71

File tree

12 files changed

+192
-192
lines changed

12 files changed

+192
-192
lines changed

docs/b2b-edition/models/address/address.yaml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -129,15 +129,15 @@ examples:
129129
isDefaultBilling: true
130130
isDefaultShipping: true
131131
isShipping: true
132-
phoneNumber: '11111111111'
132+
phoneNumber: '555-123-4567'
133133
zipCode: '78751'
134134
companyId: 1840
135135
extraFields:
136136
- fieldName: fax
137-
fieldValue: 111-222
137+
fieldValue: "555-123-4567"
138138
fieldType: 0
139139
- fieldName: tax code
140-
fieldValue: apple
140+
fieldValue: "TAX-12345"
141141
fieldType: 0
142142
countryName: United States
143143
countryCode: US
@@ -155,17 +155,17 @@ examples:
155155
isDefaultBilling: true
156156
isDefaultShipping: true
157157
isShipping: true
158-
phoneNumber: '11111111111'
158+
phoneNumber: '555-123-4567'
159159
zipCode: '78751'
160160
companyId: 1840
161161
countryName: United States
162162
countryCode: US
163163
stateCode: TX
164164
stateName: Texas
165-
label: string
165+
label: "Home Address"
166166
extraFields:
167-
- fieldName: string
168-
fieldValue: string
167+
- fieldName: "fax"
168+
fieldValue: "555-123-4567"
169169
fieldType: 0
170170
externalId: '1'
171171
channelId: 1

docs/b2b-edition/models/company/company.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,12 +55,12 @@ x-examples:
5555
state: State of Texas
5656
zipCode: '100000'
5757
country: US
58-
companyEmail: dev.b2b@test.net
58+
companyEmail: contact@example.com
5959
phoneNumber: '9090980'
6060
catalogName: catalog
6161
adminFirstName: Tom
6262
adminLastName: Cat
63-
adminEmail: dev.b2b@test.net
63+
adminEmail: admin@example.com
6464
adminPhoneNumber: 1223312
6565
title: Company Model
6666
x-internal: false

docs/b2b-edition/models/company/company_base.yaml

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ properties:
5959
companyEmail:
6060
type: string
6161
format: email
62-
example: dev.b2b@test.net
62+
example: admin@example.com
6363
maxLength: 200
6464
description: Contact email of this company.
6565
companyPhone:
@@ -88,13 +88,13 @@ properties:
8888
minLength: 1
8989
maxLength: 100
9090
description: Email address of the company's administrator.
91-
example: dev.b2b@test.net
91+
example: admin@example.com
9292
adminPhoneNumber:
9393
type: string
9494
minLength: 1
9595
maxLength: 100
9696
description: Phone number of the company's administrator.
97-
example: '1223312'
97+
example: '555-123-4567'
9898
example:
9999
companyName: Tesla
100100
bcGroupName: Tesla-RandomStr
@@ -105,11 +105,11 @@ example:
105105
state: State of Texas
106106
zipCode: '100000'
107107
country: US
108-
companyEmail: dev.b2b@test.net
109-
companyPhone: '9090980'
110-
catalogName: catalog
111-
adminFirstName: Tom
112-
adminLastName: Cat
113-
adminEmail: dev.b2b@test.net
114-
adminPhoneNumber: '1223312'
108+
companyEmail: contact@example.com
109+
companyPhone: '555-123-4567'
110+
catalogName: "Main Catalog"
111+
adminFirstName: "John"
112+
adminLastName: "Doe"
113+
adminEmail: admin@example.com
114+
adminPhoneNumber: '555-987-6543'
115115
x-internal: false

docs/b2b-edition/models/company/company_bulk_create.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ properties:
4141
companyEmail:
4242
type: string
4343
format: email
44-
example: dev.b2b@test.net
44+
example: contact@example.com
4545
maxLength: 200
4646
description: Contact email of this company.
4747
companyPhone:
@@ -70,7 +70,7 @@ properties:
7070
minLength: 1
7171
maxLength: 100
7272
description: Email address of the company's administrator.
73-
example: dev.b2b@test.net
73+
example: contact@example.com
7474
adminPhoneNumber:
7575
type: string
7676
minLength: 1
@@ -85,11 +85,11 @@ example:
8585
state: State of Texas
8686
zipCode: '100000'
8787
country: US
88-
companyEmail: dev.b2b@test.net
88+
companyEmail: contact@example.com
8989
companyPhone: '9090980'
9090
catalogName: catalog
9191
adminFirstName: Tom
9292
adminLastName: Cat
93-
adminEmail: dev.b2b@test.net
93+
adminEmail: admin@example.com
9494
adminPhoneNumber: '1223312'
9595
x-internal: false

0 commit comments

Comments
 (0)