Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion content/docs/Product-Opener/(api)/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
31 changes: 31 additions & 0 deletions content/docs/Product-Opener/(api)/schemas/index.mdx
Original file line number Diff line number Diff line change
@@ -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.
29 changes: 29 additions & 0 deletions content/docs/Product-Opener/(api)/schemas/schemas/index.mdx
Original file line number Diff line number Diff line change
@@ -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.
18 changes: 18 additions & 0 deletions content/docs/Product-Opener/(api)/schemas/schemas/ingredient.mdx
Original file line number Diff line number Diff line change
@@ -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

<APIPage document={"./specfiles-json/schemas-only.json"} operations={[{"path":"/ingredient","method":"get"}]} webhooks={[]} hasHead={false} />
5 changes: 5 additions & 0 deletions content/docs/Product-Opener/(api)/schemas/schemas/meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"title": "API Schemas",
"description": "Complete schema definitions for Product Opener API",
"defaultOpen": false
}
18 changes: 18 additions & 0 deletions content/docs/Product-Opener/(api)/schemas/schemas/nutrient.mdx
Original file line number Diff line number Diff line change
@@ -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

<APIPage document={"./specfiles-json/schemas-only.json"} operations={[{"path":"/nutrient","method":"get"}]} webhooks={[]} hasHead={false} />
18 changes: 18 additions & 0 deletions content/docs/Product-Opener/(api)/schemas/schemas/product.mdx
Original file line number Diff line number Diff line change
@@ -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

<APIPage document={"./specfiles-json/schemas-only.json"} operations={[{"path":"/product","method":"get"}]} webhooks={[]} hasHead={false} />
Original file line number Diff line number Diff line change
@@ -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

<APIPage document={"./specfiles-json/schemas-only.json"} operations={[{"path":"/product_attribute_groups","method":"get"}]} webhooks={[]} hasHead={false} />
18 changes: 18 additions & 0 deletions content/docs/Product-Opener/(api)/schemas/schemas/product_base.mdx
Original file line number Diff line number Diff line change
@@ -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

<APIPage document={"./specfiles-json/schemas-only.json"} operations={[{"path":"/product_base","method":"get"}]} webhooks={[]} hasHead={false} />
Original file line number Diff line number Diff line change
@@ -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

<APIPage document={"./specfiles-json/schemas-only.json"} operations={[{"path":"/product_eco_score","method":"get"}]} webhooks={[]} hasHead={false} />
Original file line number Diff line number Diff line change
@@ -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

<APIPage document={"./specfiles-json/schemas-only.json"} operations={[{"path":"/product_extended","method":"get"}]} webhooks={[]} hasHead={false} />
Original file line number Diff line number Diff line change
@@ -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

<APIPage document={"./specfiles-json/schemas-only.json"} operations={[{"path":"/product_images","method":"get"}]} webhooks={[]} hasHead={false} />
Original file line number Diff line number Diff line change
@@ -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

<APIPage document={"./specfiles-json/schemas-only.json"} operations={[{"path":"/product_ingredients","method":"get"}]} webhooks={[]} hasHead={false} />
Original file line number Diff line number Diff line change
@@ -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

<APIPage document={"./specfiles-json/schemas-only.json"} operations={[{"path":"/product_knowledge_panels","method":"get"}]} webhooks={[]} hasHead={false} />
Original file line number Diff line number Diff line change
@@ -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

<APIPage document={"./specfiles-json/schemas-only.json"} operations={[{"path":"/product_metadata","method":"get"}]} webhooks={[]} hasHead={false} />
18 changes: 18 additions & 0 deletions content/docs/Product-Opener/(api)/schemas/schemas/product_misc.mdx
Original file line number Diff line number Diff line change
@@ -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

<APIPage document={"./specfiles-json/schemas-only.json"} operations={[{"path":"/product_misc","method":"get"}]} webhooks={[]} hasHead={false} />
Original file line number Diff line number Diff line change
@@ -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

<APIPage document={"./specfiles-json/schemas-only.json"} operations={[{"path":"/product_nutriscore","method":"get"}]} webhooks={[]} hasHead={false} />
Original file line number Diff line number Diff line change
@@ -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

<APIPage document={"./specfiles-json/schemas-only.json"} operations={[{"path":"/product_nutrition","method":"get"}]} webhooks={[]} hasHead={false} />
Original file line number Diff line number Diff line change
@@ -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

<APIPage document={"./specfiles-json/schemas-only.json"} operations={[{"path":"/product_quality","method":"get"}]} webhooks={[]} hasHead={false} />
Loading