docusaurus-plugin-generate-schema-docs 1.2.0 → 1.3.0

package/__tests__/__fixtures__/static/schemas/components/product.json

@@ -1,211 +1,125 @@
 {
-    "$schema": "https://json-schema.org/draft/2020-12/schema",
-    "$id": "https://tracking-docs-demo.buchert.digital/schemas/components/product.json",
-    "title": "A Product",
-    "description": "A product object representing an item for use within a purchase event, based on Google Analytics 4 ecommerce event specifications.",
-    "type": "object",
-    "properties": {
-        "item_id": {
-            "type": "string",
-            "description": "The ID of the item. Either item_id or item_name is required.",
-            "examples": [
-                "SKU_12345",
-                "PROD_98765"
-            ]
-        },
-        "item_name": {
-            "type": "string",
-            "description": "The name of the item. Either item_id or item_name is required.",
-            "examples": [
-                "Stan and Friends Tee",
-                "Blue Running Shoes"
-            ]
-        },
-        "affiliation": {
-            "type": "string",
-            "description": "A product affiliation to indicate a supplier or store. Note: affiliation is only available at the item level.",
-            "examples": [
-                "Google Merchandise Store",
-                "Nike Store"
-            ]
-        },
-        "coupon": {
-            "type": "string",
-            "description": "The coupon name/code associated with the item. Coupon parameters at event and item levels are independent.",
-            "examples": [
-                "SUMMER_FUN",
-                "WELCOME20",
-                "SAVE10"
-            ]
-        },
-        "discount": {
-            "type": "number",
-            "description": "The monetary value of the discount per unit applied to the item.",
-            "examples": [
-                2.22,
-                5.00,
-                10.50
-            ]
-        },
-        "index": {
-            "type": "number",
-            "description": "The index or position of the item in a list.",
-            "examples": [
-                0,
-                1,
-                2
-            ]
-        },
-        "item_brand": {
-            "type": "string",
-            "description": "The brand of the item.",
-            "examples": [
-                "Google",
-                "Nike",
-                "Adidas"
-            ]
-        },
-        "item_category": {
-            "type": "string",
-            "description": "The category of the item. If used as part of a category hierarchy or taxonomy, this is the first category.",
-            "examples": [
-                "Apparel",
-                "Footwear",
-                "Electronics"
-            ]
-        },
-        "item_category2": {
-            "type": "string",
-            "description": "The second category hierarchy or additional taxonomy of the item.",
-            "examples": [
-                "Adult",
-                "Women",
-                "Men"
-            ]
-        },
-        "item_category3": {
-            "type": "string",
-            "description": "The third category hierarchy or additional taxonomy of the item.",
-            "examples": [
-                "Shirts",
-                "Shoes",
-                "Boots"
-            ]
-        },
-        "item_category4": {
-            "type": "string",
-            "description": "The fourth category hierarchy or additional taxonomy of the item.",
-            "examples": [
-                "Crew",
-                "Running",
-                "Casual"
-            ]
-        },
-        "item_category5": {
-            "type": "string",
-            "description": "The fifth category hierarchy or additional taxonomy of the item.",
-            "examples": [
-                "Short sleeve",
-                "Long distance",
-                "Lightweight"
-            ]
-        },
-        "item_list_id": {
-            "type": "string",
-            "description": "The ID of the list in which the item was presented to the user. If set, item_list_id at the event level is ignored. If not set, item_list_id at the event level is used if available.",
-            "examples": [
-                "related_products",
-                "search_results",
-                "recommendations"
-            ]
-        },
-        "item_list_name": {
-            "type": "string",
-            "description": "The name of the list in which the item was presented to the user. If set, item_list_name at the event level is ignored. If not set, item_list_name at the event level is used if available.",
-            "examples": [
-                "Related Products",
-                "Search Results",
-                "Recommended Items"
-            ]
-        },
-        "item_variant": {
-            "type": "string",
-            "description": "The item variant or unique code or description for additional item details/options.",
-            "examples": [
-                "green",
-                "Blue Size 10",
-                "M-Black"
-            ]
-        },
-        "location_id": {
-            "type": "string",
-            "description": "The physical location associated with the item, such as the location of a brick-and-mortar store. It is recommended to use the Google Place ID that corresponds to the associated item. A custom location ID can also be used. Note: location_id is only available at the item level.",
-            "examples": [
-                "ChIJIQBpAG2ahYAR_6128GcTUEo",
-                "store_123",
-                "location_sf"
-            ]
-        },
-        "price": {
-            "type": "number",
-            "description": "The price of the item in the specified currency unit. If a discount is applied to the item, set price to the reduced per-unit price and provide the per-unit price discount in the discount parameter.",
-            "examples": [
-                10.01,
-                21.01,
-                89.99
-            ]
-        },
-        "quantity": {
-            "type": "number",
-            "description": "The item quantity. If not set, quantity is set to 1.",
-            "examples": [
-                1,
-                2,
-                3
-            ]
-        },
-        "promotion_id": {
-            "type": "string",
-            "description": "The ID of the promotion associated with the item.",
-            "examples": [
-                "P_12345",
-                "PROMO_001"
-            ]
-        },
-        "promotion_name": {
-            "type": "string",
-            "description": "The name of the promotion associated with the item.",
-            "examples": [
-                "Summer Sale",
-                "Black Friday",
-                "Flash Deal"
-            ]
-        },
-        "creative_name": {
-            "type": "string",
-            "description": "The name of the promotion creative.",
-            "examples": [
-                "summer_banner2",
-                "holiday_email_v1"
-            ]
-        },
-        "creative_slot": {
-            "type": "string",
-            "description": "The name of the creative slot associated with the item.",
-            "examples": [
-                "featured_app_1",
-                "top_banner",
-                "sidebar"
-            ]
-        },
-        "google_business_vertical": {
-            "type": "string",
-            "description": "The business vertical for the item (e.g., 'retail').",
-            "examples": [
-                "retail",
-                "ecommerce"
-            ]
-        }
-    },
-    "required": []
-}
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://tracking-docs-demo.buchert.digital/schemas/components/product.json",
+  "title": "A Product",
+  "description": "A product object representing an item for use within a purchase event, based on Google Analytics 4 ecommerce event specifications.",
+  "type": "object",
+  "properties": {
+    "item_id": {
+      "type": "string",
+      "description": "The ID of the item. Either item_id or item_name is required.",
+      "examples": ["SKU_12345", "PROD_98765"]
+    },
+    "item_name": {
+      "type": "string",
+      "description": "The name of the item. Either item_id or item_name is required.",
+      "examples": ["Stan and Friends Tee", "Blue Running Shoes"]
+    },
+    "affiliation": {
+      "type": "string",
+      "description": "A product affiliation to indicate a supplier or store. Note: affiliation is only available at the item level.",
+      "examples": ["Google Merchandise Store", "Nike Store"]
+    },
+    "coupon": {
+      "type": "string",
+      "description": "The coupon name/code associated with the item. Coupon parameters at event and item levels are independent.",
+      "examples": ["SUMMER_FUN", "WELCOME20", "SAVE10"]
+    },
+    "discount": {
+      "type": "number",
+      "description": "The monetary value of the discount per unit applied to the item.",
+      "examples": [2.22, 5.0, 10.5]
+    },
+    "index": {
+      "type": "number",
+      "description": "The index or position of the item in a list.",
+      "examples": [0, 1, 2]
+    },
+    "item_brand": {
+      "type": "string",
+      "description": "The brand of the item.",
+      "examples": ["Google", "Nike", "Adidas"]
+    },
+    "item_category": {
+      "type": "string",
+      "description": "The category of the item. If used as part of a category hierarchy or taxonomy, this is the first category.",
+      "examples": ["Apparel", "Footwear", "Electronics"]
+    },
+    "item_category2": {
+      "type": "string",
+      "description": "The second category hierarchy or additional taxonomy of the item.",
+      "examples": ["Adult", "Women", "Men"]
+    },
+    "item_category3": {
+      "type": "string",
+      "description": "The third category hierarchy or additional taxonomy of the item.",
+      "examples": ["Shirts", "Shoes", "Boots"]
+    },
+    "item_category4": {
+      "type": "string",
+      "description": "The fourth category hierarchy or additional taxonomy of the item.",
+      "examples": ["Crew", "Running", "Casual"]
+    },
+    "item_category5": {
+      "type": "string",
+      "description": "The fifth category hierarchy or additional taxonomy of the item.",
+      "examples": ["Short sleeve", "Long distance", "Lightweight"]
+    },
+    "item_list_id": {
+      "type": "string",
+      "description": "The ID of the list in which the item was presented to the user. If set, item_list_id at the event level is ignored. If not set, item_list_id at the event level is used if available.",
+      "examples": ["related_products", "search_results", "recommendations"]
+    },
+    "item_list_name": {
+      "type": "string",
+      "description": "The name of the list in which the item was presented to the user. If set, item_list_name at the event level is ignored. If not set, item_list_name at the event level is used if available.",
+      "examples": ["Related Products", "Search Results", "Recommended Items"]
+    },
+    "item_variant": {
+      "type": "string",
+      "description": "The item variant or unique code or description for additional item details/options.",
+      "examples": ["green", "Blue Size 10", "M-Black"]
+    },
+    "location_id": {
+      "type": "string",
+      "description": "The physical location associated with the item, such as the location of a brick-and-mortar store. It is recommended to use the Google Place ID that corresponds to the associated item. A custom location ID can also be used. Note: location_id is only available at the item level.",
+      "examples": ["ChIJIQBpAG2ahYAR_6128GcTUEo", "store_123", "location_sf"]
+    },
+    "price": {
+      "type": "number",
+      "description": "The price of the item in the specified currency unit. If a discount is applied to the item, set price to the reduced per-unit price and provide the per-unit price discount in the discount parameter.",
+      "examples": [10.01, 21.01, 89.99]
+    },
+    "quantity": {
+      "type": "number",
+      "description": "The item quantity. If not set, quantity is set to 1.",
+      "examples": [1, 2, 3]
+    },
+    "promotion_id": {
+      "type": "string",
+      "description": "The ID of the promotion associated with the item.",
+      "examples": ["P_12345", "PROMO_001"]
+    },
+    "promotion_name": {
+      "type": "string",
+      "description": "The name of the promotion associated with the item.",
+      "examples": ["Summer Sale", "Black Friday", "Flash Deal"]
+    },
+    "creative_name": {
+      "type": "string",
+      "description": "The name of the promotion creative.",
+      "examples": ["summer_banner2", "holiday_email_v1"]
+    },
+    "creative_slot": {
+      "type": "string",
+      "description": "The name of the creative slot associated with the item.",
+      "examples": ["featured_app_1", "top_banner", "sidebar"]
+    },
+    "google_business_vertical": {
+      "type": "string",
+      "description": "The business vertical for the item (e.g., 'retail').",
+      "examples": ["retail", "ecommerce"]
+    }
+  },
+  "required": []
+}

package/__tests__/__fixtures__/static/schemas/nested/child-event.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://example.com/schemas/nested/child-event.json",
+  "title": "Child Event",
+  "type": "object",
+  "oneOf": [
+    { "$ref": "./grandchild-a.json" },
+    { "$ref": "./grandchild-b.json" }
+  ]
+}

package/__tests__/__fixtures__/static/schemas/nested/grandchild-a.json

@@ -0,0 +1,9 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://example.com/schemas/nested/grandchild-a.json",
+  "title": "Grandchild A",
+  "type": "object",
+  "properties": {
+    "prop_a": { "type": "string" }
+  }
+}

package/__tests__/__fixtures__/static/schemas/nested/grandchild-b.json

@@ -0,0 +1,9 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://example.com/schemas/nested/grandchild-b.json",
+  "title": "Grandchild B",
+  "type": "object",
+  "properties": {
+    "prop_b": { "type": "string" }
+  }
+}

package/__tests__/__fixtures__/static/schemas/nested/parent-event.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://example.com/schemas/nested/parent-event.json",
+  "title": "Parent Event",
+  "type": "object",
+  "oneOf": [{ "$ref": "./child-event.json" }]
+}

package/__tests__/__fixtures__/static/schemas/root-any-of-event.json

@@ -0,0 +1,34 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://tracking-docs-demo.buchert.digital/schemas/1.2.0/root-any-of-event.json",
+  "title": "Root AnyOf Event",
+  "description": "An example event that has anyOf at the root level.",
+  "type": "object",
+  "properties": {
+    "event": {
+      "type": "string",
+      "const": "any_of_event"
+    }
+  },
+  "anyOf": [
+    {
+      "title": "Has Param C",
+      "properties": {
+        "param_c": {
+          "type": "string",
+          "examples": ["example_c"],
+          "description": "This is the description for Param C."
+        }
+      }
+    },
+    {
+      "title": "Has Param D",
+      "properties": {
+        "param_d": {
+          "type": "boolean",
+          "examples": [true]
+        }
+      }
+    }
+  ]
+}

package/__tests__/__fixtures__/static/schemas/root-choice-event.json

@@ -0,0 +1,36 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://example.com/root-choice-event.schema.json",
+  "title": "Root Choice Event",
+  "description": "An example event that has oneOf at the root level.",
+  "oneOf": [
+    {
+      "title": "Option A",
+      "type": "object",
+      "properties": {
+        "event": {
+          "type": "string",
+          "const": "option_a"
+        },
+        "param_a": {
+          "type": "string",
+          "examples": ["example_a"]
+        }
+      }
+    },
+    {
+      "title": "Option B",
+      "type": "object",
+      "properties": {
+        "event": {
+          "type": "string",
+          "const": "option_b"
+        },
+        "param_b": {
+          "type": "integer",
+          "examples": [123]
+        }
+      }
+    }
+  ]
+}

package/__tests__/__fixtures__/validateSchemas/circular-schema.json

@@ -1,8 +1,8 @@
 {
-    "title": "Circular Schema",
-    "type": "object",
-    "properties": {
-        "name": { "type": "string" },
-        "parent": { "$ref": "#" }
-    }
+  "title": "Circular Schema",
+  "type": "object",
+  "properties": {
+    "name": { "type": "string" },
+    "parent": { "$ref": "#" }
+  }
 }

package/__tests__/__fixtures__/validateSchemas/components/referenced.json

@@ -1,8 +1,10 @@
 {
-    "$schema": "https://json-schema.org/draft/2020-12/schema",
-    "$id": "components/referenced.json",
-    "title": "Referenced Component",
-    "type": "object",
-    "properties": { "prop": { "type": "string", "examples": ["component prop"] } },
-    "required": ["prop"]
-}
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "components/referenced.json",
+  "title": "Referenced Component",
+  "type": "object",
+  "properties": {
+    "prop": { "type": "string", "examples": ["component prop"] }
+  },
+  "required": ["prop"]
+}

package/__tests__/__fixtures__/validateSchemas/invalid-example-schema.json

@@ -1,8 +1,8 @@
 {
-    "$schema": "https://json-schema.org/draft/2020-12/schema",
-    "$id": "invalid-example-schema",
-    "title": "Invalid Example Schema",
-    "type": "object",
-    "properties": { "age": { "type": "number", "examples": ["not-a-number"] } },
-    "required": ["age"]
-}
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "invalid-example-schema",
+  "title": "Invalid Example Schema",
+  "type": "object",
+  "properties": { "age": { "type": "number", "examples": ["not-a-number"] } },
+  "required": ["age"]
+}

package/__tests__/__fixtures__/validateSchemas/main-schema-with-missing-ref.json

@@ -1,8 +1,8 @@
 {
-    "$schema": "https://json-schema.org/draft/2020-12/schema",
-    "$id": "main-schema-with-missing-ref",
-    "title": "Main Schema with Missing Ref",
-    "type": "object",
-    "properties": { "component": { "$ref": "non-existent-component.json" } },
-    "required": ["component"]
-}
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "main-schema-with-missing-ref",
+  "title": "Main Schema with Missing Ref",
+  "type": "object",
+  "properties": { "component": { "$ref": "non-existent-component.json" } },
+  "required": ["component"]
+}

package/__tests__/__fixtures__/validateSchemas/main-schema-with-ref.json

@@ -1,8 +1,8 @@
 {
-    "$schema": "https://json-schema.org/draft/2020-12/schema",
-    "$id": "main-schema-with-ref",
-    "title": "Main Schema with Ref",
-    "type": "object",
-    "properties": { "component": { "$ref": "components/referenced.json" } },
-    "required": ["component"]
-}
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "main-schema-with-ref",
+  "title": "Main Schema with Ref",
+  "type": "object",
+  "properties": { "component": { "$ref": "components/referenced.json" } },
+  "required": ["component"]
+}

package/__tests__/__fixtures__/validateSchemas/no-example-schema.json

@@ -1,12 +1,12 @@
 {
-    "$schema": "https://json-schema.org/draft/2020-12/schema",
-    "$id": "no-valid-example-schema",
-    "title": "No Valid Example Schema",
-    "type": "object",
-    "properties": {
-        "some_prop": {
-            "description": "This property has no type or example, so it won't be in the generated example."
-        }
-    },
-    "required": ["some_prop"]
-}
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "no-valid-example-schema",
+  "title": "No Valid Example Schema",
+  "type": "object",
+  "properties": {
+    "some_prop": {
+      "description": "This property has no type or example, so it won't be in the generated example."
+    }
+  },
+  "required": ["some_prop"]
+}

package/__tests__/__fixtures__/validateSchemas/schema-A.json

@@ -1,7 +1,7 @@
 {
-    "title": "Schema A",
-    "type": "object",
-    "properties": {
-        "b": { "$ref": "schema-B.json" }
-    }
+  "title": "Schema A",
+  "type": "object",
+  "properties": {
+    "b": { "$ref": "schema-B.json" }
+  }
 }

package/__tests__/__fixtures__/validateSchemas/schema-B.json

@@ -1,7 +1,7 @@
 {
-    "title": "Schema B",
-    "type": "object",
-    "properties": {
-        "a": { "$ref": "schema-A.json" }
-    }
+  "title": "Schema B",
+  "type": "object",
+  "properties": {
+    "a": { "$ref": "schema-A.json" }
+  }
 }

package/__tests__/__fixtures__/validateSchemas/valid-schema.json

@@ -1,8 +1,8 @@
 {
-    "$schema": "https://json-schema.org/draft/2020-12/schema",
-    "$id": "valid-schema",
-    "title": "Valid Schema",
-    "type": "object",
-    "properties": { "name": { "type": "string", "examples": ["Test"] } },
-    "required": ["name"]
-}
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "valid-schema",
+  "title": "Valid Schema",
+  "type": "object",
+  "properties": { "name": { "type": "string", "examples": ["Test"] } },
+  "required": ["name"]
+}