Adjust language openapi data

Author: tischsoic

src/bundle/Resources/api_platform/base.yml

@@ -3,9 +3,12 @@ schemas:
         type: object
         required:
             - _media-type
-            - _href
         properties:
             _media-type:
+                xml:
+                    attribute: true
                 type: string
             _href:
+                xml:
+                    attribute: true
                 type: string

src/bundle/Resources/api_platform/language_schemas.yml

@@ -2,15 +2,14 @@ schemas:
     Language:
         allOf:
             - ref: "#/components/schemas/BaseObject"
-            - type: object
-              description: This class represents a language in the Repository.
+            - description: This class represents a language in the Repository.
+              type: object
               required:
-                  - id
+                  - languageId
                   - languageCode
                   - name
-                  - enabled
               properties:
-                  id:
+                  languageId:
                       description: The language ID (auto generated).
                       type: integer
                   languageCode:
@@ -19,11 +18,29 @@ schemas:
                   name:
                       description: Human readable name of the language.
                       type: string
-                  enabled:
-                      description: Indicates if the language is enabled or not.
-                      type: boolean
+    LanguageWrapper:
+        type: object
+        required:
+            - Language
+        properties:
+            Language:
+                $ref: "#/components/schemas/Language"
     LanguageList:
-        description: List of languages.
-        type: array
-        items:
-            $ref: "#/components/schemas/Language"
+        allOf:
+            - ref: "#/components/schemas/BaseObject"
+            - description: List of languages.
+              type: object
+              required:
+                  - Language
+              properties:
+                  Language:
+                      type: array
+                      items:
+                          $ref: "#/components/schemas/Language"
+    LanguageListWrapper:
+        type: object
+        required:
+            - LanguageList
+        properties:
+            LanguageList:
+                $ref: "#/components/schemas/LanguageList"

src/bundle/Resources/config/api_platform.yml

@@ -42,4 +42,3 @@ services:
             $files:
                 - '@@IbexaRestBundle/Resources/api_platform/base.yml'
                 - '@@IbexaRestBundle/Resources/api_platform/language_schemas.yml'
-

src/lib/Server/Controller/Language.php

@@ -20,9 +20,27 @@
 #[Get(
     uriTemplate: '/languages',
     openapi: new Model\Operation(
+        extensionProperties: [
+            'x-visib' => '555'
+        ],
         tags: [
             'Language attr on Controller',
         ],
+        parameters: [
+            new Model\Parameter(
+                name: 'Accept',
+                description: 'If set, the list is returned in XML or JSON format.',
+                required: true,
+                in: 'header',
+                schema: [
+                    'description' => 'If set, the list is returned in XML or JSON format.',
+                    'example' => 'application/vnd.ibexa.api.LanguageList+xml
+application/vnd.ibexa.api.LanguageList+json
+',
+                    'type' => 'string',
+                ],
+            ),
+        ],
         responses: [
             Response::HTTP_OK => [
                 'content' => [
@@ -48,7 +66,7 @@
                     ],
                     'application/vnd.ibexa.api.LanguageList+json' => [
                         'schema' => [
-                            '$ref' => '#/components/schemas/LanguageList',
+                            '$ref' => '#/components/schemas/LanguageListWrapper',
                         ],
                         'example' => [
                             'LanguageList' => [
@@ -87,6 +105,29 @@
         tags: [
             'Language attr on Controller',
         ],
+        parameters: [
+            new Model\Parameter(
+                name: 'code',
+                in: 'path',
+                required: true,
+                schema: [
+                    'type' => 'string',
+                ],
+            ),
+            new Model\Parameter(
+                name: 'Accept',
+                description: 'If set, the language is returned in XML or JSON format.',
+                required: true,
+                in: 'header',
+                schema: [
+                    'description' => 'If set, the language is returned in XML or JSON format.',
+                    'example' => 'application/vnd.ibexa.api.Language+xml
+application/vnd.ibexa.api.Language+json
+',
+                    'type' => 'string',
+                ],
+            ),
+        ],
         responses: [
             Response::HTTP_OK => [
                 'content' => [
@@ -95,17 +136,17 @@
                             '$ref' => '#/components/schemas/Language',
                         ],
                         'example' => <<<XML
-                        <?xml version="1.0" encoding="UTF-8"?>
-                        <Language media-type="application/vnd.ibexa.api.Language+xml" href="/api/ibexa/v2/languages/eng-GB">
-                            <languageId>2</languageId>
-                            <languageCode>eng-GB</languageCode>
-                            <name>English (United Kingdom)</name>
-                        </Language>
+                          <?xml version="1.0" encoding="UTF-8"?>
+                          <Language media-type="application/vnd.ibexa.api.Language+xml" href="/api/ibexa/v2/languages/eng-GB">
+                           <languageId>2</languageId>
+                           <languageCode>eng-GB</languageCode>
+                           <name>English (United Kingdom)</name>
+                          </Language>
                         XML
                     ],
                     'application/vnd.ibexa.api.Language+json' => [
                         'schema' => [
-                            '$ref' => '#/components/schemas/Language',
+                            '$ref' => '#/components/schemas/LanguageWrapper',
                         ],
                         'example' => [
                             'Language' => [
@@ -121,16 +162,6 @@
             ],
         ],
         summary: 'Get language',
-        parameters: [
-            new Model\Parameter(
-                name: 'code',
-                in: 'path',
-                required: true,
-                schema: [
-                    'type' => 'string',
-                ],
-            ),
-        ],
     ),
     name: 'languages_code',
 )]