-
Notifications
You must be signed in to change notification settings - Fork 857
Fix descriptions, add module ID to OpenAPI #2944
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.
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
Conversation
|
Review task created: https://virtocommerce.atlassian.net/browse/VCST-4080 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Test Suite: Test Suites/Modules/module_Assets
Tests: 13
Failures: 0
Errors: 0
Time: 7.328
Timestamp: 09-10-2025T04:47:50
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Test Suite: Test Suites/Modules/module_Assets
Tests: 13
Failures: 0
Errors: 0
Time: 7.154
Timestamp: 09-10-2025T04:58:13
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Test Suite: Test Suites/Modules/module_Assets
Tests: 13
Failures: 0
Errors: 0
Time: 7.581
Timestamp: 09-10-2025T22:21:23
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Test Suite: Test Suites/Modules/module_Assets
Tests: 13
Failures: 0
Errors: 0
Time: 7.608
Timestamp: 09-10-2025T22:31:05
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Test Suite: Test Suites/Modules/module_Assets
Tests: 13
Failures: 0
Errors: 0
Time: 8.639
Timestamp: 13-10-2025T10:19:52
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Test Suite: Test Suites/Modules/module_Assets
Tests: 13
Failures: 0
Errors: 0
Time: 7.539
Timestamp: 30-10-2025T10:29:10



Description
x-virtocommerce-module-idextension to operations and tagsP.S. Please test changes in swagger UI in Safari
swagger.json:
{ "paths": [ ... { "delete": { "tags": [ "Catalog" ], "summary": "Deletes catalog by id", "description": "Deletes catalog by id", "operationId": "CatalogModuleCatalogs_DeleteCatalog", "parameters": [ ], "responses": { ... }, "security": [ ... ], "x-virtocommerce-module-id": "VirtoCommerce.Catalog" }, } ... ], "tags": [ ... { "name": "Catalog", "description": "Easily manage your products, categories, variations, and properties", "x-virtocommerce-module-id": "VirtoCommerce.Catalog" } ... ] }UI:

These changes make OpenAPI json more AI-friendly (and to be honest - human-friendly too :)
References
QA-test:
Jira-link:
Artifact URL:
Image tag:
ghcr.io/VirtoCommerce/platform:3.914.0-pr-2944-453c-api-descriptions-453c6b35