Merge remote-tracking branch 'origin/1.x' into 1.x

.github/workflows/qodana.yml

@@ -22,41 +22,8 @@ on:
       - '**'
 
 jobs:
-  qodana:
-    timeout-minutes: 15
-    runs-on: ubuntu-latest
-    permissions:
-      contents: write
-      pull-requests: write
-      checks: write
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          ref: ${{ github.event.pull_request.head.sha }}
-          fetch-depth: 0
-      - name: Install PHP
-        uses: shivammathur/setup-php@v2
-        with:
-          php-version: 8.2
-          extensions: curl, mbstring, openssl, pdo, pdo_sqlite
-          ini-values: memory_limit=-1, date.timezone='UTC'
-          coverage: xdebug
-          tools: composer:v2
-
-      - name: Validate composer.json and composer.lock
-        run: composer validate
-
-      - name: Add authentication for private pimcore packages
-        run: |
-          composer config repositories.private-packagist composer https://repo.pimcore.com/github-actions/
-          composer config --global --auth http-basic.repo.pimcore.com github-actions ${{ secrets.COMPOSER_PIMCORE_REPO_PACKAGIST_TOKEN }}
-
-      - name: Install dependencies
-        run: composer install --prefer-dist --no-progress --no-interaction
-      - name: 'Qodana Scan'
-        uses: JetBrains/qodana-action@latest
-        with:
-          use-caches: false
-          args: --baseline,qodana.sarif.json
-        env:
-          QODANA_TOKEN: ${{ secrets.QODANA_TOKEN }}
+  qodana-check-workflow:
+    uses: pimcore/workflows-collection-public/.github/workflows/reusable-qodana-check.yaml@main
+    secrets:
+      COMPOSER_PIMCORE_REPO_PACKAGIST_TOKEN: ${{ secrets.COMPOSER_PIMCORE_REPO_PACKAGIST_TOKEN }}
+      QODANA_TOKEN: ${{ secrets.QODANA_TOKEN }}

README.md

@@ -1,8 +1,18 @@
-# Studio Api
-todo
+---
+title: Studio Backend
+---
 
-## Features in a Nutshell
+# Pimcore Studio Backend
 
+The Pimcore Studio Backend serves as the central hub for API endpoints and RPC calls. 
+It provides a unified interface based on the OpenApi Specification for all backend calls which is accessible via swagger-ui.
+
+![Swagger UI](./doc/img/swagger-ui.png)
+
+It uses [zircote/swagger-php](https://github.com/zircote/swagger-php) attributes to generate the OpenApi Specification.
+
+Swagger-ui is available at `/studio/api/docs` and the OpenApi Specification is available at `/studio/api/docs.json`.
 
 ## Documentation Overview
+
 - [Installation](./doc/01_Installation.md)

doc/01_Installation.md

@@ -1,14 +1,14 @@
-# Installation of the Studio Api Bundle
+# Installation of the Studio Backend Bundle
 
 :::info
 
  This bundle is only supported on Pimcore Core Framework 11.
 
 :::
 
- ## Bundle Installation
+## Bundle Installation
 
-To install the Studio Api Bundle, follow the three steps below:
+To install the Studio Backend Bundle, follow the three steps below:
 
 1) Install the required dependencies:
 
@@ -33,3 +33,8 @@ return [
 ```bash
 bin/console pimcore:bundle:install PimcoreStudioBackendBundle
 ```
+
+## Setting up generic data index
+Pimcore Studio Backend also requires the installation and setup of the generic data index. 
+The bundle is required by default and also automatically enabled in the bundles.
+To install the generic data index refer to [Generic-Data-Index](https://github.com/pimcore/generic-data-index-bundle?tab=readme-ov-file)