Update payment.yaml

bigcommerce · Oct 3, 2024 · 25a5d18 · 25a5d18
1 parent 27e3ab2
commit 25a5d18
Showing 1 changed file with 6 additions and 5 deletions.
diff --git a/docs/b2b-edition/specs/api-v3/payment/payment.yaml b/docs/b2b-edition/specs/api-v3/payment/payment.yaml
@@ -36,7 +36,7 @@ paths:
                               properties:
                                 id:
                                   type: integer
-                                  description: Unique payment id
+                                  description: Unique payment ID
               examples:
                 example-1:
                   value:
@@ -91,7 +91,7 @@ paths:
                                   description: Is this code of payment enabled to the company.
                                 paymentId:
                                   type: integer
-                                  description: Unique payment id
+                                  description: Unique payment ID
               examples:
                 example-1:
                   value:
@@ -139,7 +139,7 @@ paths:
                       message: SUCCESS
                     data: []
         '400':
-          description: 'Update fail, double check code plz.'
+          description: 'Update fail, double check code please.'
           content:
             application/json:
               schema:
@@ -318,7 +318,7 @@ paths:
       operationId: get-company-payment-methods
       security:
         - authToken: []
-      description: 'Get all company payment methods, can use filter&search params'
+      description: 'Get all company payment methods, can use filter&search parameters.'
       parameters:
         - $ref: '#/components/parameters/orderBy'
         - $ref: '#/components/parameters/sortBy'
@@ -333,7 +333,7 @@ paths:
             type: string
           in: query
           name: q
-          description: 'The search params, support search in payment method code & payment method title'
+          description: 'The search parameters support search in payment method code & payment method title.'
   '/companies/{companyId}/credit':
     parameters:
       - schema:
@@ -654,6 +654,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: