Update payment.yaml

bigcommerce · Oct 3, 2024 · 03d9272 · 03d9272
1 parent d2393e6
commit 03d9272
Showing 1 changed file with 19 additions and 18 deletions.
diff --git a/docs/b2b-edition/specs/api-v3/invoice_management/payment/payment.yaml b/docs/b2b-edition/specs/api-v3/invoice_management/payment/payment.yaml
@@ -12,6 +12,7 @@ components:
   securitySchemes:
     authToken:
       name: authToken
+      description: An API key is a token that you provide when making API calls. Include the token in a header parameter called `authToken`.
       type: apiKey
       in: header
   responses:
@@ -355,7 +356,7 @@ paths:
                             type: number
                         channelId:
                           type: string
-                          description: BigCommerce channel id
+                          description: BigCommerce channel ID
                         channelName:
                           type: string
                       required:
@@ -573,7 +574,7 @@ paths:
             type: string
           in: query
           name: q
-          description: 'Keyword queries are performed on fields corresponding to the value of "searchBy" or, if "searchBy" is empty, on all fields supported by "searchBy"'
+          description: 'Keyword queries are performed on fields corresponding to the value of "searchBy" or, if "searchBy" is empty, on all fields supported by "searchBy".'
         - schema:
             type: string
           in: query
@@ -583,7 +584,7 @@ paths:
             type: number
           in: query
           name: invoiceId
-          description: Query by invoice id
+          description: Query by invoice ID
         - schema:
             type: number
             enum:
@@ -600,15 +601,15 @@ paths:
             type: array
           in: query
           name: channelIds
-          description: BigCommerce channel ids. Do not use this parameter if you do not have opened multi-storefront
+          description: BigCommerce channel IDs. Do not use this parameter if you do not have an opened multi-storefront.
   '/payments/{paymentId}':
     parameters:
       - schema:
           type: number
         name: paymentId
         in: path
         required: true
-        description: Payment Id
+        description: Payment ID
     get:
       summary: Get Payment Detail
       tags:
@@ -821,7 +822,7 @@ paths:
                           type: number
                       channelId:
                         type: string
-                        description: BigCommerce channel id
+                        description: BigCommerce channel ID
                       channelName:
                         type: string
                   meta:
@@ -944,7 +945,7 @@ paths:
         name: paymentId
         in: path
         required: true
-        description: Payment Id
+        description: Payment ID
     get:
       summary: Get a Payment Operations
       tags:
@@ -968,11 +969,11 @@ paths:
                     properties:
                       allowedOperations:
                         type: array
-                        description: A list of allowable action codes for current payments
+                        description: A list of allowable action codes for current payments.
                         items: {}
                       allowedStatuses:
                         type: array
-                        description: The list of states that the current payment allows to modify
+                        description: The list of states that the current payment allows to modify.
                         items: {}
                   meta:
                     type: object
@@ -1064,7 +1065,7 @@ paths:
               properties:
                 operationCode:
                   type: number
-                  description: 'Payment operation code, list of allowed operations of this payment'
+                  description: 'Payment operation code, list of allowed operations of this payment.'
                   enum:
                     - 0
                     - 1
@@ -1089,7 +1090,7 @@ paths:
         name: paymentId
         in: path
         required: true
-        description: Payment Id
+        description: Payment ID
     put:
       summary: Update Payment Processing Status
       tags:
@@ -1194,7 +1195,7 @@ paths:
                     type: array
                     uniqueItems: true
                     minItems: 1
-                    description: 'contains payment transaction information, varies from different payment gateway，depends on payment gateway'
+                    description: 'Contains payment transaction information, depends and varies on payment gateway'
                     items:
                       type: object
                       properties:
@@ -1344,7 +1345,7 @@ paths:
                   type: string
                 customerId:
                   type: string
-                  description: B2B Edition Company Id
+                  description: B2B Edition Company ID
                 externalCustomerId:
                   type: string
                 payerName:
@@ -1363,10 +1364,10 @@ paths:
                     - 3
                     - 4
                   example: 3
-                  description: 'payment status, 3 as default '
+                  description: 'payment status, 3 is default'
                 channelId:
                   type: integer
-                  description: BigCommerce channel id
+                  description: BigCommerce channel ID
               required:
                 - lineItems
                 - currency
@@ -1393,7 +1394,7 @@ paths:
         name: paymentId
         in: path
         required: true
-        description: Payment Id
+        description: Payment ID
     put:
       summary: Update a Offline Payment
       tags:
@@ -1470,7 +1471,7 @@ paths:
                   type: string
                 customerId:
                   type: string
-                  description: B2B Edition Company Id
+                  description: B2B Edition Company ID
                 externalCustomerId:
                   type: string
                 payerName:
@@ -1479,7 +1480,7 @@ paths:
                   description: Default is "Store Offline Payment " if no value is passed in.
                 payerCustomerId:
                   type: string
-                  description: The default is the same as the customerId
+                  description: The default is the same as the customerId.
                 processingStatus:
                   type: number
                   default: 3