Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add object titles def to improve SDK generation #10902

Merged
merged 9 commits into from
Oct 17, 2024
Merged

docs: add object titles def to improve SDK generation #10902

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
79a0bf8
fix: correct element_type to type in element.yaml schema
shinjigi Oct 13, 2024
f516054
fix: simplify get_product_by_barcode.yaml definition
shinjigi Oct 13, 2024
4476646
fix: structure and schema correction for better circula ref. and code…
shinjigi Oct 13, 2024
468e5d9
fix: correct type from int to integer in api.yml
shinjigi Oct 13, 2024
bf7a2ee
fix: correct property definitions in add_or_edit_a_product.yaml
shinjigi Oct 13, 2024
5617af4
Merge branch 'fix-api-def-add-or-edit-product-schema'
shinjigi Oct 13, 2024
344cf09
fix: improve ingredient schema with descriptions and correct types
shinjigi Oct 13, 2024
f7cd24d
Merge branch 'main' of https://github.com/shinjigi/openfoodfacts-server
shinjigi Oct 15, 2024
f06bba8
docs: add titles to various schema files
shinjigi Oct 15, 2024
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
2 changes: 2 additions & 0 deletions docs/api/ref/schemas/image.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
type: object
title: image
description: |
This object represent an image that was uploaded to a product.
"imgid" is an integer which is a sequential number unique to each picture.
properties:
sizes:
title: image_sizes
type: object
description: |
The available image sizes for the product (both reduced and full).
Expand Down
1 change: 1 addition & 0 deletions docs/api/ref/schemas/image_size.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
type: object
title: image_size
properties:
h:
type: integer
Expand Down
1 change: 1 addition & 0 deletions docs/api/ref/schemas/knowledge_panels/elements/table_element.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ properties:
type: array
items:
type: object
title: table_column
properties:
type:
type: string
Expand Down
1 change: 1 addition & 0 deletions docs/api/ref/schemas/product_attribute_groups.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ properties:
type: array
description: Each element is an attribute that can help compute a personal ranking for the product
items:
title: product_attribute_group
type: object
properties:
id:
Expand Down
4 changes: 4 additions & 0 deletions docs/api/ref/schemas/product_ecoscore.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
type: object
title: product_ecoscore
description: |
Fields related to Eco-Score for a product.

Expand All @@ -7,6 +8,7 @@ description: |
properties:
ecoscore_data:
type: object
title: ecoscore_data
description: |
An object about a lot of details about data needed for Eco-Score computation
and complementary data of interest.
Expand All @@ -20,6 +22,7 @@ properties:
aggregated_origins:
type: array
items:
title: adjustments_origin_of_ingredient_aggregated
type: object
properties:
origin:
Expand Down Expand Up @@ -74,6 +77,7 @@ properties:
type: array
items:
type: object
title: adjustments_packaging_item
properties:
ecoscore_material_score:
type: integer
Expand Down
1 change: 1 addition & 0 deletions docs/api/ref/schemas/product_extended.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
title: product_extended
type: object
properties:
additives_original_tags:
Expand Down
3 changes: 3 additions & 0 deletions docs/api/ref/schemas/product_images.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
type: object
title: product_images
description: |
Information about Images of a product.

Expand All @@ -14,6 +15,7 @@ properties:
description: |
This contains properties for all images contained on the product.
type: object
title: product_images
properties:
1:
type: object
Expand Down Expand Up @@ -47,6 +49,7 @@ properties:

selected_images:
type: object
title: product_selected_images
description: |
URL for selected (important) images of the product.

Expand Down
2 changes: 2 additions & 0 deletions docs/api/ref/schemas/product_meta.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@ properties:
type: array
items:
type: object
title: product_meta_source
properties:
fields:
type: array
Expand Down Expand Up @@ -115,6 +116,7 @@ properties:
- string
sources_fields:
type: object
title: product_meta_source_fields
properties:
org-gs1:
type: object
Expand Down
1 change: 1 addition & 0 deletions docs/api/ref/schemas/product_misc.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
type: object
title: product_misc
description: |
Miscellaneous but important fields of a product
properties:
Expand Down
1 change: 1 addition & 0 deletions docs/api/ref/schemas/product_nutrition.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
type: object
title: product_nutrition
description: |
Nutrition fields of a product

Expand Down
Loading