diff --git a/content/docs/Product-Opener/(api)/index.mdx b/content/docs/Product-Opener/(api)/index.mdx index 7b5ba80..5e6cc1c 100644 --- a/content/docs/Product-Opener/(api)/index.mdx +++ b/content/docs/Product-Opener/(api)/index.mdx @@ -7,8 +7,12 @@ description: Product Opener API documentation Welcome to the Product Opener API documentation. +## Schemas + +- **[Schemas](schemas/schemas/)** - API schema definitions for the last version of the API +- **[API and Product Schema Change Log](../api/ref-api-and-product-schema-change-log/)** - Reference for API and product schema changes + ## API Versions -- **[Schemas](schemas/schemas/)** - API schema definitions - **[V2 API](v2/)** - Legacy API endpoints - **[V3 API](v3/)** - Current API endpoints \ No newline at end of file diff --git a/content/docs/Product-Opener/(api)/schemas/index.mdx b/content/docs/Product-Opener/(api)/schemas/index.mdx new file mode 100644 index 0000000..c01bd75 --- /dev/null +++ b/content/docs/Product-Opener/(api)/schemas/index.mdx @@ -0,0 +1,31 @@ +--- +title: API Schemas +description: Complete schema definitions for Product Opener API +--- + +# API Schemas + +This section contains the complete schema definitions for the Product Opener API. Each schema defines the structure and validation rules for API responses and data models. + +The schemas are for the last version of the API. See the [API and Product Schema Change Log](../api/ref-api-and-product-schema-change-log/) if you use an earlier version. + +## Available Schemas + +- [Product](product) - Complete product data structure +- [Product Base](product_base) - Base product information +- [Product Misc](product_misc) - Miscellaneous product data +- [Product Tags](product_tags) - Product categorization tags +- [Product Images](product_images) - Product image information +- [Product Eco Score](product_eco_score) - Environmental impact scoring +- [Product Ingredients](product_ingredients) - Ingredient data +- [Product Nutrition](product_nutrition) - Nutritional information +- [Product Nutriscore](product_nutriscore) - Nutriscore data +- [Product Quality](product_quality) - Product quality metrics +- [Product Extended](product_extended) - Extended product information +- [Product Metadata](product_metadata) - Product metadata +- [Product Knowledge Panels](product_knowledge_panels) - Knowledge panel data +- [Product Attribute Groups](product_attribute_groups) - Product attributes +- [Ingredient](ingredient) - Individual ingredient structure +- [Nutrient](nutrient) - Nutrient information + +Each schema page shows the complete JSON schema definition that can be used for validation and documentation purposes. \ No newline at end of file diff --git a/content/docs/Product-Opener/(api)/schemas/schemas/index.mdx b/content/docs/Product-Opener/(api)/schemas/schemas/index.mdx new file mode 100644 index 0000000..f5f571b --- /dev/null +++ b/content/docs/Product-Opener/(api)/schemas/schemas/index.mdx @@ -0,0 +1,29 @@ +--- +title: API Schemas +description: Complete schema definitions for Product Opener API +--- + +# API Schemas + +This section contains the complete schema definitions for the Product Opener API. Each schema defines the structure and validation rules for API responses and data models. + +## Available Schemas + +- [Product](product) - Complete product data structure +- [Product Base](product_base) - Base product information +- [Product Misc](product_misc) - Miscellaneous product data +- [Product Tags](product_tags) - Product categorization tags +- [Product Images](product_images) - Product image information +- [Product Eco Score](product_eco_score) - Environmental impact scoring +- [Product Ingredients](product_ingredients) - Ingredient data +- [Product Nutrition](product_nutrition) - Nutritional information +- [Product Nutriscore](product_nutriscore) - Nutriscore data +- [Product Quality](product_quality) - Product quality metrics +- [Product Extended](product_extended) - Extended product information +- [Product Metadata](product_metadata) - Product metadata +- [Product Knowledge Panels](product_knowledge_panels) - Knowledge panel data +- [Product Attribute Groups](product_attribute_groups) - Product attributes +- [Ingredient](ingredient) - Individual ingredient structure +- [Nutrient](nutrient) - Nutrient information + +Each schema page shows the complete JSON schema definition that can be used for validation and documentation purposes. \ No newline at end of file diff --git a/content/docs/Product-Opener/(api)/schemas/schemas/ingredient.mdx b/content/docs/Product-Opener/(api)/schemas/schemas/ingredient.mdx new file mode 100644 index 0000000..4e1c0b1 --- /dev/null +++ b/content/docs/Product-Opener/(api)/schemas/schemas/ingredient.mdx @@ -0,0 +1,18 @@ +--- +title: Ingredient Schema +full: true +_openapi: + method: GET + route: /ingredient + toc: [] + structuredData: + headings: [] + contents: + - content: Schema definition for Ingredient +--- + +{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */} + +Schema definition for Ingredient + + \ No newline at end of file diff --git a/content/docs/Product-Opener/(api)/schemas/schemas/meta.json b/content/docs/Product-Opener/(api)/schemas/schemas/meta.json new file mode 100644 index 0000000..873b5c7 --- /dev/null +++ b/content/docs/Product-Opener/(api)/schemas/schemas/meta.json @@ -0,0 +1,5 @@ +{ + "title": "API Schemas", + "description": "Complete schema definitions for Product Opener API", + "defaultOpen": false +} diff --git a/content/docs/Product-Opener/(api)/schemas/schemas/nutrient.mdx b/content/docs/Product-Opener/(api)/schemas/schemas/nutrient.mdx new file mode 100644 index 0000000..f6ec950 --- /dev/null +++ b/content/docs/Product-Opener/(api)/schemas/schemas/nutrient.mdx @@ -0,0 +1,18 @@ +--- +title: Nutrient Schema +full: true +_openapi: + method: GET + route: /nutrient + toc: [] + structuredData: + headings: [] + contents: + - content: Schema definition for Nutrient +--- + +{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */} + +Schema definition for Nutrient + + \ No newline at end of file diff --git a/content/docs/Product-Opener/(api)/schemas/schemas/product.mdx b/content/docs/Product-Opener/(api)/schemas/schemas/product.mdx new file mode 100644 index 0000000..4f128fc --- /dev/null +++ b/content/docs/Product-Opener/(api)/schemas/schemas/product.mdx @@ -0,0 +1,18 @@ +--- +title: Product Schema +full: true +_openapi: + method: GET + route: /product + toc: [] + structuredData: + headings: [] + contents: + - content: Schema definition for Product +--- + +{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */} + +Schema definition for Product + + \ No newline at end of file diff --git a/content/docs/Product-Opener/(api)/schemas/schemas/product_attribute_groups.mdx b/content/docs/Product-Opener/(api)/schemas/schemas/product_attribute_groups.mdx new file mode 100644 index 0000000..085c615 --- /dev/null +++ b/content/docs/Product-Opener/(api)/schemas/schemas/product_attribute_groups.mdx @@ -0,0 +1,18 @@ +--- +title: Product-Attribute-Groups Schema +full: true +_openapi: + method: GET + route: /product_attribute_groups + toc: [] + structuredData: + headings: [] + contents: + - content: Schema definition for Product-Attribute-Groups +--- + +{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */} + +Schema definition for Product-Attribute-Groups + + \ No newline at end of file diff --git a/content/docs/Product-Opener/(api)/schemas/schemas/product_base.mdx b/content/docs/Product-Opener/(api)/schemas/schemas/product_base.mdx new file mode 100644 index 0000000..8cc4eb5 --- /dev/null +++ b/content/docs/Product-Opener/(api)/schemas/schemas/product_base.mdx @@ -0,0 +1,18 @@ +--- +title: Product-Base Schema +full: true +_openapi: + method: GET + route: /product_base + toc: [] + structuredData: + headings: [] + contents: + - content: Schema definition for Product-Base +--- + +{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */} + +Schema definition for Product-Base + + \ No newline at end of file diff --git a/content/docs/Product-Opener/(api)/schemas/schemas/product_eco_score.mdx b/content/docs/Product-Opener/(api)/schemas/schemas/product_eco_score.mdx new file mode 100644 index 0000000..171b1e5 --- /dev/null +++ b/content/docs/Product-Opener/(api)/schemas/schemas/product_eco_score.mdx @@ -0,0 +1,18 @@ +--- +title: Product-Eco-Score Schema +full: true +_openapi: + method: GET + route: /product_eco_score + toc: [] + structuredData: + headings: [] + contents: + - content: Schema definition for Product-Eco-Score +--- + +{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */} + +Schema definition for Product-Eco-Score + + \ No newline at end of file diff --git a/content/docs/Product-Opener/(api)/schemas/schemas/product_extended.mdx b/content/docs/Product-Opener/(api)/schemas/schemas/product_extended.mdx new file mode 100644 index 0000000..54c4536 --- /dev/null +++ b/content/docs/Product-Opener/(api)/schemas/schemas/product_extended.mdx @@ -0,0 +1,18 @@ +--- +title: Product-Extended Schema +full: true +_openapi: + method: GET + route: /product_extended + toc: [] + structuredData: + headings: [] + contents: + - content: Schema definition for Product-Extended +--- + +{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */} + +Schema definition for Product-Extended + + \ No newline at end of file diff --git a/content/docs/Product-Opener/(api)/schemas/schemas/product_images.mdx b/content/docs/Product-Opener/(api)/schemas/schemas/product_images.mdx new file mode 100644 index 0000000..7a73891 --- /dev/null +++ b/content/docs/Product-Opener/(api)/schemas/schemas/product_images.mdx @@ -0,0 +1,18 @@ +--- +title: Product-Images Schema +full: true +_openapi: + method: GET + route: /product_images + toc: [] + structuredData: + headings: [] + contents: + - content: Schema definition for Product-Images +--- + +{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */} + +Schema definition for Product-Images + + \ No newline at end of file diff --git a/content/docs/Product-Opener/(api)/schemas/schemas/product_ingredients.mdx b/content/docs/Product-Opener/(api)/schemas/schemas/product_ingredients.mdx new file mode 100644 index 0000000..695ecd9 --- /dev/null +++ b/content/docs/Product-Opener/(api)/schemas/schemas/product_ingredients.mdx @@ -0,0 +1,18 @@ +--- +title: Product-Ingredients Schema +full: true +_openapi: + method: GET + route: /product_ingredients + toc: [] + structuredData: + headings: [] + contents: + - content: Schema definition for Product-Ingredients +--- + +{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */} + +Schema definition for Product-Ingredients + + \ No newline at end of file diff --git a/content/docs/Product-Opener/(api)/schemas/schemas/product_knowledge_panels.mdx b/content/docs/Product-Opener/(api)/schemas/schemas/product_knowledge_panels.mdx new file mode 100644 index 0000000..891d6e0 --- /dev/null +++ b/content/docs/Product-Opener/(api)/schemas/schemas/product_knowledge_panels.mdx @@ -0,0 +1,18 @@ +--- +title: Product-Knowledge-Panels Schema +full: true +_openapi: + method: GET + route: /product_knowledge_panels + toc: [] + structuredData: + headings: [] + contents: + - content: Schema definition for Product-Knowledge-Panels +--- + +{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */} + +Schema definition for Product-Knowledge-Panels + + \ No newline at end of file diff --git a/content/docs/Product-Opener/(api)/schemas/schemas/product_metadata.mdx b/content/docs/Product-Opener/(api)/schemas/schemas/product_metadata.mdx new file mode 100644 index 0000000..2ec82dc --- /dev/null +++ b/content/docs/Product-Opener/(api)/schemas/schemas/product_metadata.mdx @@ -0,0 +1,18 @@ +--- +title: Product-Metadata Schema +full: true +_openapi: + method: GET + route: /product_metadata + toc: [] + structuredData: + headings: [] + contents: + - content: Schema definition for Product-Metadata +--- + +{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */} + +Schema definition for Product-Metadata + + \ No newline at end of file diff --git a/content/docs/Product-Opener/(api)/schemas/schemas/product_misc.mdx b/content/docs/Product-Opener/(api)/schemas/schemas/product_misc.mdx new file mode 100644 index 0000000..99da514 --- /dev/null +++ b/content/docs/Product-Opener/(api)/schemas/schemas/product_misc.mdx @@ -0,0 +1,18 @@ +--- +title: Product-Misc Schema +full: true +_openapi: + method: GET + route: /product_misc + toc: [] + structuredData: + headings: [] + contents: + - content: Schema definition for Product-Misc +--- + +{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */} + +Schema definition for Product-Misc + + \ No newline at end of file diff --git a/content/docs/Product-Opener/(api)/schemas/schemas/product_nutriscore.mdx b/content/docs/Product-Opener/(api)/schemas/schemas/product_nutriscore.mdx new file mode 100644 index 0000000..f80355f --- /dev/null +++ b/content/docs/Product-Opener/(api)/schemas/schemas/product_nutriscore.mdx @@ -0,0 +1,18 @@ +--- +title: Product-Nutriscore Schema +full: true +_openapi: + method: GET + route: /product_nutriscore + toc: [] + structuredData: + headings: [] + contents: + - content: Schema definition for Product-Nutriscore +--- + +{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */} + +Schema definition for Product-Nutriscore + + \ No newline at end of file diff --git a/content/docs/Product-Opener/(api)/schemas/schemas/product_nutrition.mdx b/content/docs/Product-Opener/(api)/schemas/schemas/product_nutrition.mdx new file mode 100644 index 0000000..1dbb57e --- /dev/null +++ b/content/docs/Product-Opener/(api)/schemas/schemas/product_nutrition.mdx @@ -0,0 +1,18 @@ +--- +title: Product-Nutrition Schema +full: true +_openapi: + method: GET + route: /product_nutrition + toc: [] + structuredData: + headings: [] + contents: + - content: Schema definition for Product-Nutrition +--- + +{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */} + +Schema definition for Product-Nutrition + + \ No newline at end of file diff --git a/content/docs/Product-Opener/(api)/schemas/schemas/product_quality.mdx b/content/docs/Product-Opener/(api)/schemas/schemas/product_quality.mdx new file mode 100644 index 0000000..28441b3 --- /dev/null +++ b/content/docs/Product-Opener/(api)/schemas/schemas/product_quality.mdx @@ -0,0 +1,18 @@ +--- +title: Product-Quality Schema +full: true +_openapi: + method: GET + route: /product_quality + toc: [] + structuredData: + headings: [] + contents: + - content: Schema definition for Product-Quality +--- + +{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */} + +Schema definition for Product-Quality + + \ No newline at end of file diff --git a/content/docs/Product-Opener/(api)/schemas/schemas/product_tags.mdx b/content/docs/Product-Opener/(api)/schemas/schemas/product_tags.mdx new file mode 100644 index 0000000..9b4a7b8 --- /dev/null +++ b/content/docs/Product-Opener/(api)/schemas/schemas/product_tags.mdx @@ -0,0 +1,18 @@ +--- +title: Product-Tags Schema +full: true +_openapi: + method: GET + route: /product_tags + toc: [] + structuredData: + headings: [] + contents: + - content: Schema definition for Product-Tags +--- + +{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */} + +Schema definition for Product-Tags + + \ No newline at end of file