fix: update response (#1)

bigcommerce · Jan 16, 2025 · 43fec3c · 43fec3c
1 parent a97f308
commit 43fec3c
Showing 1 changed file with 49 additions and 80 deletions.
diff --git a/docs/b2b-edition/specs/api-v3/company/company.yaml b/docs/b2b-edition/specs/api-v3/company/company.yaml
@@ -3090,9 +3090,6 @@ paths:
               schema:
                 type: object
                 properties:
-                  code:
-                    type: number
-                    default: 200
                   data:
                     type: array
                     items:
@@ -3130,7 +3127,6 @@ paths:
               examples:
                 Examples 1:
                   value:
-                    code: 200
                     data: 
                       - companyStatus: 1
                         companyId: 123
@@ -3147,32 +3143,27 @@ paths:
                 application/json:
                   schema:
                     required:
-                      - code
-                      - data
-                      - meta
+                      - status
+                      - title
+                      - errors
                     type: object
                     properties:
-                      code:
+                      status:
                         type: number
-                      data:
-                        type: object
-                        properties: 
-                          errMsg:
-                            type: string
-                      meta:
+                      title:
+                        type: string
+                      errors:
                         type: object
                         properties:
-                          message:
+                          index:
                             type: string
                   examples:
                     parameter error:
                       value:
-                        code: 404
-                        data: {
-                          errMsg: Company does not exist.
-                        }
-                        meta:
-                          message: Not found error.
+                        status: 404
+                        title: Company Does not Exist.
+                        errors:
+                          "1": Company Does not Exist.
   /companies/{companyId}/subsidiaries/{childCompanyId}:
     parameters:
       - schema:
@@ -3204,32 +3195,27 @@ paths:
                       application/json:
                         schema:
                           required:
-                            - code
-                            - data
-                            - meta
+                            - status
+                            - title
+                            - errors
                           type: object
                           properties:
-                            code:
+                            status:
                               type: number
-                            data:
-                              type: object
-                              properties: 
-                                errMsg:
-                                  type: string
-                            meta:
+                            title:
+                              type: string
+                            errors:
                               type: object
                               properties:
-                                message:
+                                index:
                                   type: string
                         examples:
                           parameter error:
                             value:
-                              code: 400
-                              data: {
-                                errMsg: Invalid child company ID.
-                              }
-                              meta:
-                                message: Parameter error.
+                              status: 400
+                              title: Parameter error.
+                              errors:
+                                "1": Invalid child company ID.
   /companies/{companyId}/parent:
     parameters:
       - $ref: "#/components/parameters/companyId"
@@ -3260,9 +3246,6 @@ paths:
               schema:
                 type: object
                 properties:
-                  code:
-                    type: number
-                    default: 201
                   meta:
                     type: object
                     properties:
@@ -3272,7 +3255,7 @@ paths:
               examples:
                 success:
                   value:
-                    code: 201
+                    data: []
                     meta:
                       message: SUCCESS
         "400":
@@ -3281,32 +3264,27 @@ paths:
             application/json:
               schema:
                 required:
-                  - code
-                  - data
-                  - meta
+                  - status
+                  - title
+                  - errors
                 type: object
                 properties:
-                  code:
+                  status:
                     type: number
-                  data:
-                    type: object
-                    properties: 
-                      errMsg:
-                        type: string
-                  meta:
+                  title:
+                    type: string
+                  errors:
                     type: object
                     properties:
-                      message:
+                      index:
                         type: string
               examples:
                 parameter error:
                   value:
-                    code: 400
-                    data: {
-                      errMsg: The parent company has reached the maximum layer.
-                    }
-                    meta:
-                      message: The parent company has reached the maximum layer.
+                    status: 400
+                    title: Parameter Error.
+                    errors:
+                      "1": The parent company has reached the maximum layer.
   /companies/{companyId}/hierarchy:
     parameters:
       - $ref: "#/components/parameters/companyId"
@@ -3341,9 +3319,6 @@ paths:
               schema:
                 type: object
                 properties:
-                  code:
-                    type: number
-                    default: 200
                   data:
                     type: array
                     items:
@@ -3422,7 +3397,6 @@ paths:
               examples:
                 Examples 1:
                   value:
-                    code: 200
                     data: 
                       - companyId: 1
                         companyName: "Company A"
@@ -3459,32 +3433,27 @@ paths:
                 application/json:
                   schema:
                     required:
-                      - code
-                      - data
-                      - meta
+                      - status
+                      - title
+                      - errors
                     type: object
                     properties:
-                      code:
+                      status:
                         type: number
-                      data:
-                        type: object
-                        properties: 
-                          errMsg:
-                            type: string
-                      meta:
+                      title:
+                        type: string
+                      errors:
                         type: object
                         properties:
-                          message:
+                          index:
                             type: string
                   examples:
                     parameter error:
                       value:
-                        code: 404
-                        data: {
-                          errMsg: Company does not exist.
-                        }
-                        meta:
-                          message: Not found error.
+                        status: 404
+                        title: Parameter Error.
+                        errors:
+                          "1": Company does not exist.
 components:
   securitySchemes:
     authToken: