DEVDOCS-6566 - Updated to put Store Hash into auth info rather than p… (#1132)

…arameters for clarity

<!-- Ticket number or summary of work -->
# [DEVDOCS-6566]


## What changed?
* Adjusted placement of X-Store-Hash for clarity

## Release notes draft
* We've moved X-Store-Hash into authentication info rather than
parameters to clarify its usage.

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

ping { @bigcommerce/dev-docs-team }


[DEVDOCS-6566]:
https://bigcommercecloud.atlassian.net/browse/DEVDOCS-6566?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ

Author: bc-terra

docs/b2b-edition/specs/api-v3/address/address.yaml

@@ -22,10 +22,9 @@ tags:
   - name: Addresses
 security:
   - X-Auth-Token: []
+    X-Store-Hash: []
 paths:
   /countries:
-    parameters:
-      - $ref: "#/components/parameters/X-Store-Hash"
     get:
       summary: Get a Country
       tags:
@@ -121,8 +120,6 @@ paths:
                     meta:
                       message: Resource not found
   /states:
-    parameters:
-      - $ref: "#/components/parameters/X-Store-Hash"
     get:
       summary: Get a State
       tags:
@@ -395,8 +392,6 @@ paths:
                   - code
                   - data
                   - meta
-    parameters:
-      - $ref: "#/components/parameters/X-Store-Hash"
     post:
       summary: Create a Company Address
       operationId: post-companies-companyId-addresses
@@ -515,7 +510,6 @@ paths:
                       message: "Parameter Error"
   '/addresses/{addressId}':
     parameters:
-      - $ref: "#/components/parameters/X-Store-Hash"
       - schema:
           type: string
         name: addressId
@@ -652,8 +646,6 @@ paths:
               schema:
                 $ref: '#/components/schemas/responseNotFound'
   /addresses/bulk:
-    parameters:
-      - $ref: "#/components/parameters/X-Store-Hash"
     post:
       summary: Bulk Create Addresses
       operationId: post-addresses
@@ -887,8 +879,6 @@ paths:
                     meta:
                       message: "Parameter Error"
   /addresses/extra-fields:
-    parameters:
-      - $ref: "#/components/parameters/X-Store-Hash"
     get:
       summary: Get Address Extra Field Configs
       tags:
@@ -988,14 +978,6 @@ paths:
                   - meta
 components:
   parameters:
-    X-Store-Hash:
-      name: X-Store-Hash
-      in: header
-      required: true
-      schema:
-        type: string
-        example: abc123
-      description: The unique store hash associated with a BigCommerce store that has B2B Edition enabled.
     limit:
       name: limit
       in: query
@@ -1305,6 +1287,16 @@ components:
         - data
         - meta
   securitySchemes:
+    X-Store-Hash:
+      name: X-Store-Hash
+      description: |-
+        ### Authentication header
+
+        | Header | Argument | Description |
+        |:-------|:---------|:------------|
+        | `X-Store-Hash` | `store_hash` | The unique store hash associated with a BigCommerce store that has B2B Edition enabled. |
+      type: apiKey
+      in: header
     X-Auth-Token:
       name: X-Auth-Token
       description: |-

docs/b2b-edition/specs/api-v3/channel/channel.yaml

@@ -21,12 +21,11 @@ servers:
   - url: 'https://api-b2b.bigcommerce.com/api/v3/io'
 security:
   - X-Auth-Token: []
+    X-Store-Hash: []
 tags:
   - name: Channels
 paths:
   /channels:
-    parameters:
-      - $ref: "#/components/parameters/X-Store-Hash"
     get:
       summary: "Get all Channels"
       tags:
@@ -72,7 +71,6 @@ paths:
                     example: "Multi storefront is not enabled"
   /channels/{channel_id}:
     parameters:
-      - $ref: "#/components/parameters/X-Store-Hash"
       - name: channel_id
         in: path
         required: true
@@ -137,15 +135,6 @@ paths:
                     description: Error message.
                     example: "Channel does not exist"
 components:
-  parameters:
-    X-Store-Hash:
-      name: X-Store-Hash
-      in: header
-      required: true
-      schema:
-        type: string
-        example: abc123
-      description: The unique store hash associated with a BigCommerce store that has B2B Edition enabled.
   schemas:
     Channel:
       type: object
@@ -213,6 +202,16 @@ components:
           description: "The [Unix Timestap](https://www.unixtimestamp.com/) last update date for the channel."
           example: "1750437336"
   securitySchemes:
+    X-Store-Hash:
+      name: X-Store-Hash
+      description: |-
+        ### Authentication header
+
+        | Header | Argument | Description |
+        |:-------|:---------|:------------|
+        | `X-Store-Hash` | `store_hash` | The unique store hash associated with a BigCommerce store that has B2B Edition enabled. |
+      type: apiKey
+      in: header
     X-Auth-Token:
       name: X-Auth-Token
       description: |-

docs/b2b-edition/specs/api-v3/company/company.yaml

@@ -110,15 +110,14 @@ servers:
   - url: "https://api-b2b.bigcommerce.com/api/v3/io"
 security:
   - X-Auth-Token: []
+  - X-Store-Hash: []
 tags:
   - name: Companies
   - name: Company Roles and Permissions
   - name: Account Hierarchies
 
 paths:
   /companies:
-    parameters:
-      - $ref: "#/components/parameters/X-Store-Hash"
     get:
       tags:
         - Companies
@@ -487,7 +486,6 @@ paths:
       x-codegen-request-body-name: body
   /companies/{companyId}:
     parameters:
-      - $ref: "#/components/parameters/X-Store-Hash"
       - $ref: "#/components/parameters/companyId"
     get:
       tags:
@@ -631,7 +629,6 @@ paths:
                       message: This resource is not found.
   /customer-groups/{customerGroupId}/companies:
     parameters:
-      - $ref: "#/components/parameters/X-Store-Hash"
       - name: customerGroupId
         in: path
         required: true
@@ -777,8 +774,6 @@ paths:
         "404":
           $ref: "#/components/responses/ERROR_404_Data"
   /companies/bulk:
-    parameters:
-      - $ref: "#/components/parameters/X-Store-Hash"
     post:
       tags:
         - Companies
@@ -1064,7 +1059,6 @@ paths:
       x-codegen-request-body-name: body
   /companies/{companyId}/catalogs:
     parameters:
-      - $ref: "#/components/parameters/X-Store-Hash"
       - $ref: "#/components/parameters/companyId"
     put:
       tags:
@@ -1090,7 +1084,6 @@ paths:
           description: "Not Allowed; occurs if the store is using Independent Companies behavior"
   /companies/{companyId}/status:
     parameters:
-      - $ref: "#/components/parameters/X-Store-Hash"
       - $ref: "#/components/parameters/companyId"
     put:
       tags:
@@ -1118,8 +1111,6 @@ paths:
         "200":
           $ref: "#/components/responses/RESPONSE_200_UPDATE"
   /companies/extra-fields:
-    parameters:
-      - $ref: "#/components/parameters/X-Store-Hash"
     get:
       tags:
         - Companies
@@ -1273,8 +1264,6 @@ paths:
                                 - Manufacturing
                           x-internal: false
   /companies/permissions:
-    parameters:
-      - $ref: "#/components/parameters/X-Store-Hash"
     get:
       tags:
         - Company Roles and Permissions
@@ -1379,7 +1368,6 @@ paths:
       x-internal: false
   /companies/permissions/{permissionId}:
     parameters:
-      - $ref: "#/components/parameters/X-Store-Hash"
       - name: permissionId
         in: path
         required: true
@@ -1458,8 +1446,6 @@ paths:
           $ref: "#/components/responses/RESPONSE_200_Base"
       x-internal: false
   /companies/roles:
-    parameters:
-      - $ref: "#/components/parameters/X-Store-Hash"
     get:
       tags:
         - Company Roles and Permissions
@@ -1565,7 +1551,6 @@ paths:
       x-internal: false
   /companies/roles/{roleId}:
     parameters:
-      - $ref: "#/components/parameters/X-Store-Hash"
       - name: roleId
         in: path
         required: true
@@ -1661,7 +1646,6 @@ paths:
       x-internal: false
   /companies/{companyId}/attachments:
     parameters:
-      - $ref: "#/components/parameters/X-Store-Hash"
       - $ref: "#/components/parameters/companyId"
     get:
       tags:
@@ -1711,7 +1695,6 @@ paths:
           $ref: "#/components/responses/RESPONSE_200_ATTACHMENT"
   /companies/{companyId}/attachments/{attachmentId}:
     parameters:
-      - $ref: "#/components/parameters/X-Store-Hash"
       - $ref: "#/components/parameters/companyId"
       - name: attachmentId
         in: path
@@ -1732,7 +1715,6 @@ paths:
           $ref: "#/components/responses/RESPONSE_200_Base"
   /companies/{companyId}/subsidiaries:
     parameters:
-      - $ref: "#/components/parameters/X-Store-Hash"
       - $ref: "#/components/parameters/companyId"
     get:
       tags:
@@ -1821,7 +1803,6 @@ paths:
           $ref: "#/components/responses/ERROR_404_Parameter"
   /companies/{companyId}/subsidiaries/{childCompanyId}:
     parameters:
-      - $ref: "#/components/parameters/X-Store-Hash"
       - $ref: "#/components/parameters/companyId"
       - name: childCompanyId
         in: path
@@ -1868,7 +1849,6 @@ paths:
                                 "1": Invalid child company ID.
   /companies/{companyId}/parent:
     parameters:
-      - $ref: "#/components/parameters/X-Store-Hash"
       - $ref: "#/components/parameters/companyId"
     post:
       tags:
@@ -1948,7 +1928,6 @@ paths:
                       "1": The parent company has reached the maximum layer.
   /companies/{companyId}/hierarchy:
     parameters:
-      - $ref: "#/components/parameters/X-Store-Hash"
       - $ref: "#/components/parameters/companyId"
       - $ref: "#/components/parameters/paginationOffset"
       - $ref: "#/components/parameters/paginationLimit"
@@ -2659,14 +2638,6 @@ components:
                 meta:
                   message: SUCCESS
   parameters:
-    X-Store-Hash:
-      name: X-Store-Hash
-      in: header
-      required: true
-      schema:
-        type: string
-        example: abc123
-      description: The unique store hash associated with a BigCommerce store that has B2B Edition enabled.
     paginationLimit:
       name: limit
       in: query
@@ -2692,6 +2663,16 @@ components:
       description: Unique numeric ID of the Company account.
       example: 123456
   securitySchemes:
+    X-Store-Hash:
+      name: X-Store-Hash
+      description: |-
+        ### Authentication header
+
+        | Header | Argument | Description |
+        |:-------|:---------|:------------|
+        | `X-Store-Hash` | `store_hash` | The unique store hash associated with a BigCommerce store that has B2B Edition enabled. |
+      type: apiKey
+      in: header
     X-Auth-Token:
       name: X-Auth-Token
       description: |-