Skip to content

Conversation

@asvishnyakov
Copy link
Member

@asvishnyakov asvishnyakov commented Oct 9, 2025

Description

  • Fixes API descriptions on platforms with case-sensitive file systems (Linux)
  • Properly implements descriptions on tags (tags on operations are strings, i.e. description was omitted from API spec generation)
  • Adds x-virtocommerce-module-id extension to operations and tags

P.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:
image

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

@vc-ci
Copy link
Contributor

vc-ci commented Oct 9, 2025

Review task created: https://virtocommerce.atlassian.net/browse/VCST-4080

cursor[bot]

This comment was marked as outdated.

cursor[bot]

This comment was marked as outdated.

Copy link
Contributor

@vc-ci vc-ci left a 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

Copy link
Contributor

@vc-ci vc-ci left a 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

@asvishnyakov asvishnyakov changed the title Fix API descriptions, add module ID to API Fix descriptions, add module ID to OpenAPI Oct 9, 2025
@OlegoO OlegoO requested a review from artem-dudarev October 9, 2025 06:57
Copy link
Contributor

@vc-ci vc-ci left a 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

Copy link
Contributor

@vc-ci vc-ci left a 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

Copy link
Contributor

@vc-ci vc-ci left a 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

@sonarqubecloud
Copy link

Copy link
Contributor

@vc-ci vc-ci left a 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

@artem-dudarev artem-dudarev merged commit 9c8ab5f into dev Oct 30, 2025
21 of 22 checks passed
@artem-dudarev artem-dudarev deleted the fix/api-descriptions branch October 30, 2025 10:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants