IBX-9058: Swap openapi.summary→openapi.description, name→openapi.summary

[adriendupuis]

🎫 Issue	IBX-9058

Related PRs:

Same fix:

• ibexa/activity-log#120
• ibexa/calendar#69
• ibexa/cart#121
• ibexa/corporate-account#283
• ibexa/order-management#146
• ibexa/payment#168
• ibexa/product-catalog#1285
• ibexa/segmentation#124
• ibexa/shipping#106
• ibexa/taxonomy#322

Same ticket:

• IBX-9058: Adapt schemas to OpenAPI 3.1 #157
• IBX-9058: Set OpenAPI schema info #158
• IBX-9058: Fix OpenApi type/$ref/oneOf usage #159

Description:

Before :

• The name was used as operationId in the export which can't contain spaces, redocly lint was throwing many "Operation operationId should not have URL invalid characters."
• The extracted schema contained useless generated descriptions.

paths:
  /bookmark:
    get:
      operationId: 'List of bookmarks'
      summary: 'Lists bookmarked Locations for the current user.'
      description: 'Retrieves a BookmarkListController resource.'

After:

• operationId are generated.

paths:
  /bookmark:
    get:
      operationId: api_bookmark_get
      summary: 'List of bookmarks'
      description: 'Lists bookmarked Locations for the current user.'

Swapping scripts:

For current ibexa/rest

find src/lib/Server/Controller -name '*.php' \
  -exec perl -i -p0e 's/^        summary:/        description:/mgis' {} \; \
  -exec perl -i -p0e 's/^    name:/    summary:/mgis' {} \; \
  -exec perl -i -p0e 's/(    summary: [^\n]+)\n(    openapi: [^\n]+)/$2\n    $1/gis' {} \; \
  -exec perl -i -p0e 's/(    summary: [^\n]+)\n(    extraProperties: [^\n]+)\n(    openapi: [^\n]+)/$2\n$3\n    $1/gis' {} \; \
;

For other packages:

find src/bundle/Controller/REST -name '*.php' \
  -exec perl -i -p0e 's/^        summary:/        description:/mgis' {} \; \
  -exec perl -i -p0e 's/^    name:/    summary:/mgis' {} \; \
  -exec perl -i -p0e 's/(    summary: [^\n]+)\n(    openapi: [^\n]+)/$2\n    $1/gis' {} \; \
  -exec perl -i -p0e 's/(    summary: [^\n]+)\n(    extraProperties: [^\n]+)\n(    openapi: [^\n]+)/$2\n$3\n    $1/gis' {} \; \
;

For QA:

Documentation:

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud