docs: add object titles def to improve SDK generation #10902
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Removed unnecessary nested structure. - Directly referenced `product.yaml` schema for the `product` property.
…gen recognition in nutrients.yaml - Add schema ref. - Add `type: object` to specify the schema type. - Ensured proper structure and readability. - Add title for better SDK generation - ref update on dependent file
- schema, style and explode are attribute for parameters, not for obj properties. - Corrected the definition of the `brands`, `labels`, `categories` properties to be an array of strings. - Completed the definition of the `labels` property. - Ensure conformity with OpenAPI 3.1 specification.
- Support better the self reference (SDK client gen compliant). - Add descriptions for all properties. - Ensure all types are correct and conform to OpenAPI 3.1 specification.
Added title fields to multiple schema files in the OpenAPI definition. These titles will be used to generate class names in the client libraries. - Added `title` fields to the following schemas: - image.yaml - image_size.yaml - knowledge_panels/elements/table_element.yaml - product_attribute_groups.yaml - product_ecoscore.yaml - product_extended.yaml - product_images.yaml - product_meta.yaml - product_misc.yaml - product_nutrition.yaml The `title` field is used to generate class names in client libraries. For more details, see [OpenAPI Generator Customization](https://openapi-generator.tech/docs/customization/#inline-schema-naming).
github-actions
bot
added
📚 Documentation
|
shinjigi
changed the title
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #10902 +/- ##
==========================================
- Coverage 49.54% 49.07% -0.48%
==========================================
Files 67 77 +10
Lines 20650 22179 +1529
Branches 4980 5303 +323
==========================================
+ Hits 10231 10884 +653
- Misses 9131 9963 +832
- Partials 1288 1332 +44 ☔ View full report in Codecov by Sentry. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What
This pull request addresses errors encountered during the conversion to TypeScript client for the
api.ymlfile and its dependencies using @openapitools/[email protected] (GH). The changes include:Screenshot
Related issue(s) and discussion
Additional Notes
Thank you for your cooperation!