Skip to content

Commit

Permalink
B2b-1354: [update] add missing objects and response (#586)
Browse files Browse the repository at this point in the history 
<!-- Ticket number or summary of work -->
# [B2B-1354](https://bigcommercecloud.atlassian.net/browse/B2B-1354)


## What changed?
<!-- Provide a bulleted list in the present tense -->

These changes are far away in PR
[578](#578) and
[580](#580), they were
accidentally deleted, and resubmit in this PR
* add some missing object properties
* add missing response

## Release notes draft
<!-- Provide an entry for the release notes using simple, conversational
language. Don't be too technical. Explain how the change will benefit
the merchant and link to the feature.

Examples:
* The newly-released [X feature] is now available to use. Now, you’ll be
able to [perform Y action].
* We're happy to announce [X feature], which can help you [perform Y
action].
* [X feature] helps you to create [Y response] using the [Z query
parameter]. Now, you can deliver [ex, localized shopping experiences for
your customers].
* Fixed a bug in the [X endpoint]. Now the [Y field] will appear when
you click [Z option]. -->
N/A

## Anything else?
<!-- Add related PRs, salient notes, additional ticket numbers, etc. -->
N/A


[B2B-1354]:
https://bigcommercecloud.atlassian.net/browse/B2B-1354?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
  • Loading branch information
@JamessenLiu
JamessenLiu authored Oct 17, 2024
1 parent 1e73676 commit 02e1275
Show file tree
Hide file tree
Showing 10 changed files with 135 additions and 59 deletions.
39 changes: 37 additions & 2 deletions docs/b2b-edition/models/invoice_portal/invoice.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ x-examples:
lastName: string
firstName: string
customFields: {}
customerFields: string
customerFields: {}
shippingAddresses:
- city: string
state: string
Expand Down Expand Up @@ -98,7 +98,7 @@ examples:
lastName: string
firstName: string
customFields: {}
customerFields: string
customerFields: {}
shippingAddresses:
- city: string
state: string
Expand Down Expand Up @@ -268,9 +268,23 @@ properties:
minLength: 1
customFields:
type: object
properties:
key:
type: string
description: custom field key
value:
type: string
description: custom field value
customerFields:
type: object
description: User-defined additional fields
properties:
key:
type: string
description: custom field key
value:
type: string
description: custom field value
shippingAddresses:
type: array
uniqueItems: true
Expand Down Expand Up @@ -305,6 +319,13 @@ properties:
minLength: 1
customFields:
type: object
properties:
key:
type: string
description: custom field key
value:
type: string
description: custom field value
required:
- city
- state
Expand Down Expand Up @@ -341,6 +362,13 @@ properties:
description: comments
customFields:
type: object
properties:
key:
type: string
description: custom field key
value:
type: string
description: custom field value
required:
- addressIndex
- shipDate
Expand Down Expand Up @@ -392,6 +420,13 @@ properties:
description: product description or product name
customFields:
type: object
properties:
key:
type: string
description: custom field key
value:
type: string
description: custom field value
unitDiscount:
type: object
description: product unit discount
Expand Down
8 changes: 4 additions & 4 deletions docs/b2b-edition/specs/api-v3/invoice_management/invoice/invoice.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ paths:
lastName: xu
firstName: stanton
customFields: {}
customerFields: 123
customerFields: {}
shippingAddresses:
- city: 成都
state: District of Columbia
Expand Down Expand Up @@ -225,7 +225,7 @@ paths:
lastName: string
firstName: string
customFields: {}
customerFields: string
customerFields: {}
shippingAddresses:
- city: string
state: string
Expand Down Expand Up @@ -366,7 +366,7 @@ paths:
lastName: string
firstName: string
customFields: {}
customerFields: string
customerFields: {}
shippingAddresses:
- city: string
state: string
Expand Down Expand Up @@ -1225,7 +1225,7 @@ paths:
lastName: test
firstName: test
customFields: {}
customerFields: ''
customerFields: {}
shippingAddresses:
- city: montreal
state: California
Expand Down
19 changes: 11 additions & 8 deletions docs/b2b-edition/specs/api-v3/invoice_management/payment/payment.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -142,12 +142,10 @@ components:
data:
type: object
required:
- lineItems
- errMsg
properties:
lineItems':
type: array
items:
type: string
errMsg:
type: string
required:
- code
- meta
Expand All @@ -159,9 +157,7 @@ components:
meta:
message: Parameter Error
data:
lineItems:
required:
- lineItems
errMsg: Invalid request data
paths:
/payments:
get:
Expand Down Expand Up @@ -748,6 +744,13 @@ paths:
type: array
items:
type: object
properties:
type:
type: string
description:
type: string
amount:
type: number
moduleData:
type: object
required:
Expand Down
5 changes: 3 additions & 2 deletions docs/b2b-edition/specs/api-v3/user/user.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -874,9 +874,10 @@ components:
errMsg:
type: object
required:
- '{field name}'
- 'fieldName'
properties:
'{field name}':
fieldName:
description: The field name is a variable and depends on fields in request body.
type: array
items:
type: string
Expand Down
35 changes: 31 additions & 4 deletions docs/b2b-edition/specs/storefront/storefront/catalog.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,16 @@ paths:
option_values:
type: array
items:
properties: {}
type: object
properties:
id:
type: integer
label:
type: string
option_id:
type: integer
option_display_name:
type: string
variantSku:
type: string
minLength: 1
Expand All @@ -137,13 +146,22 @@ paths:
categories:
type: array
items:
properties: {}
type: integer
price:
type: number
option:
type: array
items:
properties: {}
type: object
properties:
id:
type: integer
label:
type: string
option_id:
type: integer
option_display_name:
type: string
isVisible:
type: string
minLength: 1
Expand Down Expand Up @@ -303,7 +321,16 @@ paths:
option:
type: array
items:
properties: {}
type: object
properties:
id:
type: integer
label:
type: string
option_id:
type: integer
option_display_name:
type: string
minQuantity:
type: number
description: Order quantity minimum
Expand Down
53 changes: 18 additions & 35 deletions docs/b2b-edition/specs/storefront/storefront/company.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4379,7 +4379,6 @@ paths:
/users/validations/existence:
get:
summary: Check Existence of Customer Email
responses: {}
operationId: get-users-validations-existence
description: |-
> This endpoint is deprecated.
Expand Down Expand Up @@ -4408,41 +4407,25 @@ paths:
in: query
name: extraFieldValue
description: Extra field value
requestBody:
content:
application/json:
schema:
description: ''
type: object
properties:
code:
type: number
message:
type: string
minLength: 1
data:
type: object
properties: {}
required:
- code
- message
- data
x-examples:
responses:
'200':
description: OK
content:
application/json:
schema:
description: ''
type: object
properties:
code:
type: number
message:
type: string
examples:
example-1:
code: 40010
message: User does not exist
data: {}
examples:
User does not exist:
value:
code: 40010
message: User does not exist
data: {}
example-1:
value:
code: 200
message: SUCCESS
data: {}
value:
code: 200
message: Success

tags:
- User
/users:
Expand Down
21 changes: 21 additions & 0 deletions docs/b2b-edition/specs/storefront/storefront/order.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1123,6 +1123,17 @@ paths:
type: array
items:
type: object
properties:
id:
type: string
amount:
type: string
name:
type: string
code:
type: string
target:
type: string
product_options:
type: array
uniqueItems: true
Expand Down Expand Up @@ -1187,6 +1198,11 @@ paths:
type: array
items:
type: object
properties:
name:
type: string
value:
type: string
required:
- id
- order_id
Expand Down Expand Up @@ -1376,6 +1392,11 @@ paths:
type: array
items:
type: object
properties:
name:
type: string
value:
type: string
required:
- id
- order_id
Expand Down
4 changes: 2 additions & 2 deletions docs/b2b-edition/specs/storefront/storefront/quote.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -946,7 +946,7 @@ paths:
errorMessage:
type: array
items:
properties: {}
type: string
required:
- totalCount
- createCount
Expand Down Expand Up @@ -1064,7 +1064,7 @@ paths:
errorMessage:
type: array
items:
properties: {}
type: string
required:
- totalCount
- createCount
Expand Down
5 changes: 5 additions & 0 deletions docs/b2b-edition/specs/storefront/storefront/rfq.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -863,6 +863,11 @@ paths:
type: array
items:
type: object
properties:
date:
type: integer
message:
type: string
productList:
type: array
uniqueItems: true
Expand Down
5 changes: 3 additions & 2 deletions docs/b2b-edition/specs/storefront/storefront/store.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,7 @@ paths:
default_for_country_codes:
type: array
items:
type: object
type: string
currency_code:
type: string
minLength: 1
Expand Down Expand Up @@ -356,7 +356,8 @@ paths:
type: integer
enabled_currencies:
type: array
items: {}
items:
type: string
default_currency:
type: string
required:
Expand Down

0 comments on commit 02e1275

Please sign in to comment.