docs-util: add publishable api key header parameter to store routes O…

…AS (medusajs#10747) * docs-util: add publishable api key header parameter to store routes OAS * fix oas
noubase · Jan 22, 2025 · 205e0b7 · 205e0b7
1 parent be1845e
commit 205e0b7
Show file tree

Hide file tree

Showing 92 changed files with 1,268 additions and 76 deletions.
diff --git a/www/apps/api-reference/components/Tags/Operation/DescriptionSection/Parameters/index.tsx b/www/apps/api-reference/components/Tags/Operation/DescriptionSection/Parameters/index.tsx
@@ -18,6 +18,11 @@ const TagsOperationDescriptionSectionParameters = ({
     required: [],
     properties: {},
   }
+  const headerParameters: SchemaObject = {
+    type: "object",
+    required: [],
+    properties: {},
+  }
 
   parameters.forEach((parameter) => {
     const parameterObject = {
@@ -37,11 +42,27 @@ const TagsOperationDescriptionSectionParameters = ({
         queryParameters.required?.push(parameter.name)
       }
       queryParameters.properties[parameter.name] = parameterObject
+    } else if (parameter.in === "header") {
+      if (parameter.required) {
+        headerParameters.required?.push(parameter.name)
+      }
+      headerParameters.properties[parameter.name] = parameterObject
     }
   })
 
   return (
     <>
+      {Object.values(headerParameters.properties).length > 0 && (
+        <>
+          <h3 className="border-medusa-border-base border-b py-1.5">
+            Header Parameters
+          </h3>
+          <TagOperationParameters
+            schemaObject={headerParameters}
+            topLevel={true}
+          />
+        </>
+      )}
       {Object.values(pathParameters.properties).length > 0 && (
         <>
           <h3 className="border-medusa-border-base border-b py-1.5">

diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionPriceRule.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionPriceRule.yaml
@@ -17,8 +17,13 @@ properties:
     title: id
     description: The price rule's ID.
   value:
-    type: string
-    title: value
+    oneOf:
+      - type: string
+        title: value
+        description: The price rule's value.
+      - type: number
+        title: value
+        description: The price rule's value.
     description: The price rule's value.
   operator:
     type: string

diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionRule.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionRule.yaml
@@ -26,18 +26,8 @@ properties:
     description: The shipping option rule's operator.
     example: eq
   value:
-    oneOf:
-      - type: string
-        title: value
-        description: The rule's value.
-        example: '"true"'
-      - type: array
-        description: The rule's values.
-        items:
-          type: string
-          title: value
-          description: A rule's value
-          example: '"true"'
+    type: string
+    title: value
   shipping_option_id:
     type: string
     title: shipping_option_id

diff --git a/www/apps/api-reference/specs/admin/openapi.full.yaml b/www/apps/api-reference/specs/admin/openapi.full.yaml
@@ -53046,8 +53046,13 @@ components:
           title: id
           description: The price rule's ID.
         value:
-          type: string
-          title: value
+          oneOf:
+            - type: string
+              title: value
+              description: The price rule's value.
+            - type: number
+              title: value
+              description: The price rule's value.
           description: The price rule's value.
         operator:
           type: string
@@ -53126,18 +53131,8 @@ components:
           description: The shipping option rule's operator.
           example: eq
         value:
-          oneOf:
-            - type: string
-              title: value
-              description: The rule's value.
-              example: '"true"'
-            - type: array
-              description: The rule's values.
-              items:
-                type: string
-                title: value
-                description: A rule's value
-                example: '"true"'
+          type: string
+          title: value
         shipping_option_id:
           type: string
           title: shipping_option_id

diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminShippingOptionPriceRule.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminShippingOptionPriceRule.yaml
@@ -17,8 +17,13 @@ properties:
     title: id
     description: The price rule's ID.
   value:
-    type: string
-    title: value
+    oneOf:
+      - type: string
+        title: value
+        description: The price rule's value.
+      - type: number
+        title: value
+        description: The price rule's value.
     description: The price rule's value.
   operator:
     type: string

diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminShippingOptionRule.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminShippingOptionRule.yaml
@@ -26,18 +26,8 @@ properties:
     description: The shipping option rule's operator.
     example: eq
   value:
-    oneOf:
-      - type: string
-        title: value
-        description: The rule's value.
-        example: '"true"'
-      - type: array
-        description: The rule's values.
-        items:
-          type: string
-          title: value
-          description: A rule's value
-          example: '"true"'
+    type: string
+    title: value
   shipping_option_id:
     type: string
     title: shipping_option_id