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

Jump to bottom

docs: improve OpenAPI documentation #9359

Merged
merged 4 commits into from
Nov 27, 2023
Merged

docs: improve OpenAPI documentation #9359

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
534ebb9
docs: improve OpenAPI documentation
raphael0202 Nov 21, 2023
a196313
Update labeler.yml
teolemon Nov 22, 2023
5ceccfb
Update product_base.yaml
teolemon Nov 22, 2023
ffb0798
Update product_base.yaml
teolemon Nov 22, 2023
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
1 change: 1 addition & 0 deletions .github/labeler.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,7 @@ footer:

OpenAPI:
- docs/assets/api-rapidoc.html
- docs/api/ref/schemas/product_base.yaml

🐋 Docker:
- docker/**/*
Expand Down
8 changes: 6 additions & 2 deletions docs/api/ref/schemas/product_base.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,13 @@ properties:
description: |
The name of the product can also
be in many other languages like
product_name_fr (for french).
product_name_fr (for French).
product_quantity:
type: string
description: |
The size in g or ml for the whole product.
It's a normalized version of the quantity field.
example: "500"
quantity:
type: string
description: |
Expand All @@ -84,4 +88,4 @@ patternProperties:
type: string
description: |
This can be returned in many other languages
like generic_name_fr (for french).
like generic_name_fr (for French).
Loading