Skip to content

Commit aae2ffd

Browse files
TomA-RTomA-R
authored
DEVDOCS-6658 Replace placeholder values with realistic examples in API specs and docs (#1202)
# [DEVDOCS-6658] ## What changed? Replace placeholder values with realistic examples in API specs and docs [DEVDOCS-6658]: https://bigcommercecloud.atlassian.net/browse/DEVDOCS-6658?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
1 parent 9e819c7 commit aae2ffd

25 files changed

+188
-188
lines changed

‎docs/b2b-edition/specs/api-v2/openAPI.yaml‎

Lines changed: 49 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1002,11 +1002,11 @@ paths:
10021002
"label": "12dxqwdsa",
10031003
"firstName": "Bundle",
10041004
"lastName": "Smith",
1005-
"addressLine1": "Street.1",
1006-
"addressLine2": "",
1005+
"addressLine1": "123 Main Street",
1006+
"addressLine2": "Suite 200",
10071007
"city": "New York",
1008-
"zipCode": "110202",
1009-
"phoneNumber": "",
1008+
"zipCode": "10001",
1009+
"phoneNumber": "555-123-4567",
10101010
"country": {
10111011
"countryName": "United States",
10121012
"countryCode": "US"
@@ -1031,11 +1031,11 @@ paths:
10311031
"label": "12dxqwdsa",
10321032
"firstName": "Bundle",
10331033
"lastName": "Smith",
1034-
"addressLine1": "Street.1",
1035-
"addressLine2": "",
1034+
"addressLine1": "123 Main Street",
1035+
"addressLine2": "Suite 200",
10361036
"city": "New York",
1037-
"zipCode": "110202",
1038-
"phoneNumber": "",
1037+
"zipCode": "10001",
1038+
"phoneNumber": "555-123-4567",
10391039
"country": {
10401040
"countryName": "United States",
10411041
"countryCode": "US"
@@ -1445,11 +1445,11 @@ paths:
14451445
"label": "12dxqwdsa",
14461446
"firstName": "Bundle",
14471447
"lastName": "Smith",
1448-
"addressLine1": "Street.1",
1449-
"addressLine2": "",
1448+
"addressLine1": "123 Main Street",
1449+
"addressLine2": "Suite 200",
14501450
"city": "New York",
1451-
"zipCode": "110202",
1452-
"phoneNumber": "",
1451+
"zipCode": "10001",
1452+
"phoneNumber": "555-123-4567",
14531453
"country": {
14541454
"countryName": "United States",
14551455
"countryCode": "US"
@@ -1473,11 +1473,11 @@ paths:
14731473
"label": "12dxqwdsa",
14741474
"firstName": "Bundle",
14751475
"lastName": "Smith",
1476-
"addressLine1": "Street.1",
1477-
"addressLine2": "",
1476+
"addressLine1": "123 Main Street",
1477+
"addressLine2": "Suite 200",
14781478
"city": "New York",
1479-
"zipCode": "110202",
1480-
"phoneNumber": "",
1479+
"zipCode": "10001",
1480+
"phoneNumber": "555-123-4567",
14811481
"country": {
14821482
"countryName": "United States",
14831483
"countryCode": "US"
@@ -1740,17 +1740,17 @@ paths:
17401740
example:
17411741
code: 200
17421742
data:
1743-
addressLine1: ""
1744-
addressLine2: ""
1743+
addressLine1: "123 Main Street"
1744+
addressLine2: "Suite 200"
17451745
catalogId: "1"
1746-
catalogName: testCatalogName
1746+
catalogName: Main Catalog
17471747
city: Paris
17481748
companyEmail: contact@example.com
17491749
companyId: "35"
1750-
companyName: CropTest1
1750+
companyName: Acme Corporation
17511751
companyStatus: "1"
1752-
country: French
1753-
description: CropTest
1752+
country: France
1753+
description: Acme Corporation
17541754
extraFields:
17551755
- dataType: "2"
17561756
fieldName: extraStr1
@@ -1970,19 +1970,19 @@ paths:
19701970
source: |2
19711971
19721972
curl --location --request PUT 'https://api-b2b.bigcommerce.com/api/v2/io/companies/23' --header 'authToken: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdG9yZV9oYXNoIjoiZjJvc3hqam54aiIsImRiIjoiZGVmYXVsdCIsImVtYWlsIjoiYnJ1Y2UuaHVhbmdAc2lsa3NvZnR3YXJlLmNvbSJ9._DQFg-3FgtztdQVCGU5Gxfv8j8V3U9Ssaw7ARxUU6pY' --header 'Content-Type: application/json' --data-raw '{
1973-
"companyName": "test3.23-22",
1973+
"companyName": "Acme Corporation",
19741974
"phoneNumber": 122331212,
19751975
"companyEmail": "contact@acme.com",
1976-
"addressLine1": "xxxx",
1977-
"addressLine2": "",
1976+
"addressLine1": "123 Main Street",
1977+
"addressLine2": "Suite 200",
19781978
19791979
}'
19801980
- lang: Python
19811981
source: "\n import requests\n\n \
19821982
\ url = \"https://api-b2b.bigcommerce.com/api/v2/io/companies/23\"\n\
1983-
\n payload = \"{\n\t\"companyName\": \"test3.23-22\"\
1984-
,\n\t\"phoneNumber\": 122331212,\n\t\"companyEmail\": \"test@test.com\"\
1985-
,\n\t\"addressLine1\": \"xxxx\",\n\t\"addressLine2\": \"\",\n\n}\"\n \
1983+
\n payload = \"{\n\t\"companyName\": \"Acme Corporation\"\
1984+
,\n\t\"phoneNumber\": \"555-123-4567\",\n\t\"companyEmail\": \"contact@acme.com\"\
1985+
,\n\t\"addressLine1\": \"123 Main Street\",\n\t\"addressLine2\": \"Suite 200\",\n\n}\"\n \
19861986
\ headers = {\n 'authToken':\
19871987
\ 'eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdG9yZV9oYXNoIjoiZjJvc3hqam54aiIsImRiIjoiZGVmYXVsdCIsImVtYWlsIjoiYnJ1Y2UuaHVhbmdAc2lsa3NvZnR3YXJlLmNvbSJ9._DQFg-3FgtztdQVCGU5Gxfv8j8V3U9Ssaw7ARxUU6pY',\n\
19881988
\ 'Content-Type': 'application/json'\n \
@@ -1993,9 +1993,9 @@ paths:
19931993
source: "\n var myHeaders = new Headers();\n \
19941994
\ myHeaders.append(\"authToken\", \"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdG9yZV9oYXNoIjoiZjJvc3hqam54aiIsImRiIjoiZGVmYXVsdCIsImVtYWlsIjoiYnJ1Y2UuaHVhbmdAc2lsa3NvZnR3YXJlLmNvbSJ9._DQFg-3FgtztdQVCGU5Gxfv8j8V3U9Ssaw7ARxUU6pY\"\
19951995
);\n myHeaders.append(\"Content-Type\", \"application/json\"\
1996-
);\n\n var raw = \"{\n\t\"companyName\": \"test3.23-22\"\
1997-
,\n\t\"phoneNumber\": 122331212,\n\t\"companyEmail\": \"test@test.com\"\
1998-
,\n\t\"addressLine1\": \"xxxx\",\n\t\"addressLine2\": \"\",\n\n}\";\n\n\
1996+
);\n\n var raw = \"{\n\t\"companyName\": \"Acme Corporation\"\
1997+
,\n\t\"phoneNumber\": \"555-123-4567\",\n\t\"companyEmail\": \"contact@acme.com\"\
1998+
,\n\t\"addressLine1\": \"123 Main Street\",\n\t\"addressLine2\": \"Suite 200\",\n\n}\";\n\n\
19991999
\ var requestOptions = {\n \
20002000
\ method: 'PUT',\n headers: myHeaders,\n \
20012001
\ body: raw,\n redirect:\
@@ -3465,7 +3465,7 @@ paths:
34653465
firstName: "John"
34663466
id: "123"
34673467
lastName: "Smith"
3468-
phoneNumber: ""
3468+
phoneNumber: "555-123-4567"
34693469
role: "1"
34703470
updatedAt: "1574999690"
34713471
uuid: A123456
@@ -4329,7 +4329,7 @@ paths:
43294329
firstName: "John"
43304330
id: "123"
43314331
lastName: "Smith"
4332-
phoneNumber: ""
4332+
phoneNumber: "555-123-4567"
43334333
role: "1"
43344334
updatedAt: "1574999690"
43354335
uuid: A123456
@@ -4513,7 +4513,7 @@ paths:
45134513
- Order
45144514
deprecated: true
45154515
summary: Update Company Order With BC OrderId
4516-
description: "Update order, billingAddress and products can not be omitted.\
4516+
description: "Update order, billingAddress and products cannot be omitted.\
45174517
\ products can be two format. \n 1. Product with variants. \n 2. Base product"
45184518
operationId: orders_update
45194519
parameters:
@@ -4611,7 +4611,7 @@ paths:
46114611
\ updated in a /POST, but using a /PUT to update the order will\
46124612
\ return a 400 error. The field ‘external_id’ cannot be written\
46134613
\ to. Please remove it from your request before trying again.\
4614-
\ It can not be overwritten once set.."
4614+
\ It cannot be overwritten once set.."
46154615
externalMerchantId:
46164616
type: string
46174617
description: Id of the external merchant.
@@ -6622,18 +6622,18 @@ paths:
66226622
code: 200
66236623
data:
66246624
list:
6625-
- addressLine1: ""
6626-
addressLine2: ""
6625+
- addressLine1: "123 Main Street"
6626+
addressLine2: "Suite 200"
66276627
catalogId: "2"
6628-
city: ""
6629-
companyEmail: kobe.tian@bunldeb2b.com
6628+
city: "San Francisco"
6629+
companyEmail: contact@acme.com
66306630
companyId: "34"
6631-
companyName: KobeCropTest111
6632-
country: ","
6633-
description: KobeCropTest111
6631+
companyName: Acme Corporation
6632+
country: "US"
6633+
description: Acme Corporation
66346634
salesRepCount: "2"
6635-
state: ""
6636-
zipCode: ""
6635+
state: "CA"
6636+
zipCode: "94102"
66376637
pagination:
66386638
limit: 10
66396639
offset: 0
@@ -6837,15 +6837,15 @@ paths:
68376837
example:
68386838
code: 200
68396839
data:
6840-
addressLine1: ""
6841-
addressLine2: ""
6840+
addressLine1: "123 Main Street"
6841+
addressLine2: "Suite 200"
68426842
catalogId: "1"
68436843
city: Paris
68446844
companyId: "35"
6845-
companyName: CropTest1
6845+
companyName: Acme Corporation
68466846
companyStatus: "1"
6847-
country: French
6848-
description: CropTest
6847+
country: France
6848+
description: Acme Corporation
68496849
state: BC
68506850
zipCode: "1032332"
68516851
message: SUCCESS

‎docs/b2b-edition/specs/api-v3/invoice-management.yaml‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -360,25 +360,25 @@ paths:
360360
description: Sales Tax
361361
orderDate: 1616809386
362362
billingAddress:
363-
city: 成都
364-
state: District of Columbia
363+
city: San Francisco
364+
state: California
365365
country: United States
366-
street1: tianfuwujie
367-
street2: ruanjianyuan
368-
zipCode: "123"
369-
lastName: xu
370-
firstName: stanton
366+
street1: 123 Main Street
367+
street2: Suite 200
368+
zipCode: "94102"
369+
lastName: Smith
370+
firstName: John
371371
customFields: {}
372372
customerFields: {}
373373
shippingAddresses:
374-
- city: 成都
375-
state: District of Columbia
374+
- city: San Francisco
375+
state: California
376376
country: United States
377-
street1: tianfuwujie
378-
street2: ruanjianyuan
379-
zipCode: "123"
380-
lastName: xu
381-
firstName: stanton
377+
street1: 123 Main Street
378+
street2: Suite 200
379+
zipCode: "94102"
380+
lastName: Smith
381+
firstName: John
382382
customFields: {}
383383
details:
384384
shipments:

‎docs/b2b-edition/specs/api-v3/super_admin/super_admin.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -661,7 +661,7 @@ components:
661661
fieldValue:
662662
type: string
663663
description: "Value for the custom field."
664-
example: "foo"
664+
example: "Custom Field Value"
665665
isAssigned:
666666
type: boolean
667667
description: "Indicates whether the Super Admin should be assigned to the Company. A value of `true` indicates the assignment will be added or will remain if already assigned. A value of `false` indicates the assignment will be removed or remain so if already unassigned."

‎docs/b2b-edition/specs/storefront/app/address.yaml‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1509,15 +1509,15 @@ paths:
15091509
limit: 10
15101510
q: ''
15111511
filters:
1512-
firstName: ''
1513-
lastName: ''
1514-
address: ''
1515-
city: ''
1516-
country: ''
1517-
state: ''
1518-
phoneNumber: ''
1519-
zipCode: ''
1520-
label: ''
1512+
firstName: 'John'
1513+
lastName: 'Smith'
1514+
address: '123 Main Street'
1515+
city: 'San Francisco'
1516+
country: 'United States'
1517+
state: 'CA'
1518+
phoneNumber: '555-123-4567'
1519+
zipCode: '94102'
1520+
label: 'Home'
15211521
addressType:
15221522
isShipping: '1'
15231523
isBilling: '1'

‎docs/b2b-edition/specs/storefront/app/backend.yaml‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -301,7 +301,7 @@ paths:
301301
example-1:
302302
email: levi.tuo@silksoftware.com
303303
username: levi.tuo
304-
phoneNumber: ''
304+
phoneNumber: '555-123-4567'
305305
status: '1'
306306
roleId: '23'
307307
properties:
@@ -358,7 +358,7 @@ paths:
358358
isOwner: '0'
359359
isInnerSalesRep: '0'
360360
username: levi.tuo
361-
phoneNumber: ''
361+
phoneNumber: '555-123-4567'
362362
pagination:
363363
totalCount: 1
364364
offset: 0
@@ -453,7 +453,7 @@ paths:
453453
isOwner: '0'
454454
isInnerSalesRep: '0'
455455
username: username
456-
phoneNumber: ''
456+
phoneNumber: '555-123-4567'
457457
pagination:
458458
totalCount: 1
459459
offset: 0
@@ -509,7 +509,7 @@ paths:
509509
roleId: '23'
510510
roleName: Administrator
511511
username: levi.tuo
512-
phoneNumber: ''
512+
phoneNumber: '555-123-4567'
513513
properties:
514514
code:
515515
type: number
@@ -564,7 +564,7 @@ paths:
564564
roleId: '23'
565565
roleName: Administrator
566566
username: username
567-
phoneNumber: ''
567+
phoneNumber: '555-123-4567'
568568
operationId: get-backend-users-user_id
569569
description: Get backend user info
570570
x-internal: true
@@ -619,7 +619,7 @@ paths:
619619
example-1:
620620
email: levi.tuo@silksoftware.com
621621
username: levi.tuo
622-
phoneNumber: ''
622+
phoneNumber: '555-123-4567'
623623
status: '1'
624624
roleId: '23'
625625
properties:

‎docs/b2b-edition/specs/storefront/app/company.yaml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1435,7 +1435,7 @@ paths:
14351435
id: '7831'
14361436
firstName: levi
14371437
lastName: tuo
1438-
phoneNumber: ''
1438+
phoneNumber: '555-123-4567'
14391439
role: '0'
14401440
email: levi.tuo@silksoftware.com
14411441
properties:
@@ -1496,7 +1496,7 @@ paths:
14961496
id: '7831'
14971497
firstName: first name
14981498
lastName: last name
1499-
phoneNumber: ''
1499+
phoneNumber: '555-123-4567'
15001500
role: '0'
15011501
email: example@example.com
15021502
user not sxist:
@@ -1943,7 +1943,7 @@ paths:
19431943
data:
19441944
list:
19451945
- id: '7831'
1946-
phoneNumber: ''
1946+
phoneNumber: '555-123-4567'
19471947
role: '0'
19481948
email: levi.tuo@silksoftware.com
19491949
uuid: ''
@@ -1984,7 +1984,7 @@ paths:
19841984
data:
19851985
list:
19861986
- id: '7831'
1987-
phoneNumber: ''
1987+
phoneNumber: '555-123-4567'
19881988
role: '0'
19891989
email: exmaple@example.com
19901990
uuid: ''

0 commit comments

Comments
 (0)