[BE] Check features test #97

.github/workflow/pint.yml

@@ -0,0 +1,23 @@
+name: PHP Linting (Pint)
+on:
+  workflow_dispatch:
+  pull_request:
+jobs:
+  phplint:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ github.head_ref }}
+      - name: Pinting
+        uses: aglipanci/[email protected]
+        with:
+          configPath: "pint.json"
+      - name: Commit changes
+        uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          commit_message: PHP Linting (Pint)
+          skip_fetch: true

app/Annotations/OpenApi/AnnotationsInfo.php

@@ -1,4 +1,4 @@
-<?php 
+<?php
 
 namespace App\Annotations\OpenApi;
 
@@ -8,12 +8,13 @@
  *   version="1.0.0",
  *   description="Documentation needed for the API Rest for the landing page to IT Academy. Some useful links below:
  *   [ITA Landing Backend](https://github.com/IT-Academy-BCN/ita-landing-backend)
- *   [ITA Landing Frontend](https://github.com/IT-Academy-BCN/ita-landing-frontend)"
+ *   [ITA Landing Frontend](https://github.com/IT-Academy-BCN/ita-landing-frontend)
+ *   This API supports both Catalan and Spanish languages using the 'Accept-Language' header.
+ *   The default language is Catalan.",
  * )
- *   @OA\Server(
- *     url="http://127.0.0.1:8000/api"
- *   )
+ * @OA\Server(
+ *   url="http://127.0.0.1:8000/api"
  * )
  */
 
-class AnnotationsInfo {}
+class AnnotationsInfo {}

app/Annotations/OpenApi/controllersAnnotations/appAnnotations/AnnotationsApps.php

@@ -1,4 +1,4 @@
-<?php 
+<?php
 
 namespace App\Annotations\OpenApi\controllersAnnotations\appAnnotations;
 
@@ -30,14 +30,32 @@ public function index() {}
  *       mediaType="application/json",
  *       @OA\Schema(
  *         @OA\Property(
- *           property="title",
- *           type="string",
- *           example="My application"
+ *           property="ca",
+ *           type="object",
+ *           @OA\Property(
+ *             property="title",
+ *             type="string",
+ *             example="Títol de la meva aplicació"
+ *           ),
+ *           @OA\Property(
+ *             property="description",
+ *             type="string",
+ *             example="Descripció de la meva aplicació"
+ *           ),
  *         ),
  *         @OA\Property(
- *           property="description",
- *           type="string",
- *           example="Description of my application"
+ *           property="es",
+ *           type="object",
+ *           @OA\Property(
+ *             property="title",
+ *             type="string",
+ *             example="Título de mi aplicación"
+ *           ),
+ *           @OA\Property(
+ *             property="description",
+ *             type="string",
+ *             example="Descripción de mi aplicación"
+ *           ),
  *         ),
  *         @OA\Property(
  *           property="url",
@@ -65,7 +83,7 @@ public function index() {}
  *   )
  * )
  */
-    public function store() {}
+   public function store() {}
 
     /**
  * @OA\Get(
@@ -89,10 +107,10 @@ public function store() {}
  *     description="Details of the application."
  *   )
  * )
- */  
-    public function show() {}
+ */
+   public function show() {}
 
-    /**
+/**
  * @OA\Put(
  *   path="/apps/{id}",
  *   tags={"Apps"},
@@ -115,21 +133,39 @@ public function show() {}
  *       mediaType="application/json",
  *       @OA\Schema(
  *         @OA\Property(
- *           property="title",
- *           type="string",
- *           example="New title of my application"
+ *           property="ca",
+ *           type="object",
+ *           @OA\Property(
+ *             property="title",
+ *             type="string",
+ *             example="Nou títol"
+ *           ),
+ *           @OA\Property(
+ *             property="description",
+ *             type="string",
+ *             example="Nova descripció"
+ *           ),
  *         ),
  *         @OA\Property(
- *           property="description",
- *           type="string",
- *           example="New description of my application"
+ *           property="es",
+ *           type="object",
+ *           @OA\Property(
+ *             property="title",
+ *             type="string",
+ *             example="Nuevo título"
+ *           ),
+ *           @OA\Property(
+ *             property="description",
+ *             type="string",
+ *             example="Nueva descripción"
+ *           ),
  *         ),
  *         @OA\Property(
  *           property="url",
  *           type="string",
  *           example="https://myapp.com/new-version"
  *         ),
- *          @OA\Property(
+ *         @OA\Property(
  *           property="github",
  *           type="string",
  *           example="https://github.com/IT-Academy-BCN/project-1"
@@ -149,9 +185,9 @@ public function show() {}
  *   )
  * )
  */
-    public function update() {}
+   public function update() {}
 
-    /**
+/**
  * @OA\Delete(
  *   path="/apps/{id}",
  *   tags={"Apps"},
@@ -174,5 +210,5 @@ public function update() {}
  *   )
  * )
  */
-    public function destroy() {}
-}
+   public function destroy() {}
+}

app/Annotations/OpenApi/controllersAnnotations/authAnnotations/AnnotationsAuth.php

@@ -1,10 +1,10 @@
-<?php 
+<?php
 
 namespace App\Annotations\OpenApi\controllersAnnotations\authAnnotations;
 
 class AnnotationsAuth {
 
-    /**
+/**
  * @OA\Post(
  *   path="/login",
  *   tags={"User"},
@@ -30,10 +30,9 @@ class AnnotationsAuth {
  *   ),
  *   @OA\Response(
  *     response="200",
- *     description="Access token for the user."
+ *     description="Access token for the user. The response message may vary based on user's language settings."
  *   )
  * )
  */
-
     public function loginUser() {}
-}
+}

app/Annotations/OpenApi/controllersAnnotations/codeAnnotations/AnnotationsCode.php

@@ -47,6 +47,5 @@ class AnnotationsCode {
      *     )
      * )
      */
-
     public function sendCodeByEmail() {}
-}
+}

app/Annotations/OpenApi/controllersAnnotations/collaboratorsAnnotations/AnnotationsCollaborators.php

@@ -1,10 +1,10 @@
-<?php 
+<?php
 
 namespace App\Annotations\OpenApi\controllersAnnotations\collaboratorsAnnotations;
 
 class AnnotationsCollaborators {
 
-    /**
+/**
  * @OA\Get(
  *   path="/collaborators/{area}",
  *   tags={"Collaborators"},
@@ -50,6 +50,5 @@ class AnnotationsCollaborators {
  *   )
  * )
  */
-
     public function index() {}
-}
+}

app/Annotations/OpenApi/controllersAnnotations/faqsAnnotations/AnnotationsFaqs.php

@@ -1,24 +1,24 @@
-<?php 
+<?php
 
 namespace App\Annotations\OpenApi\controllersAnnotations\faqsAnnotations;
 
 class AnnotationsFaqs {
 
-    /**
+/**
  * @OA\Get(
  *   path="/faqs",
  *   tags={"Faqs"},
  *   summary="Get list of frequently asked questions (FAQs)",
- *   description="This endpoint is used to get a list of all frequently asked questions.",  
+ *   description="This endpoint is used to get a list of all frequently asked questions.",
  * @OA\Response(
  *     response="200",
  *     description="Frequently asked questions list."
  *   )
  * )
  */
-    public function index() {}
+   public function index() {}
 
-    /**
+/**
  * @OA\Get(
  *   path="/faqs/{id}",
  *   tags={"Faqs"},
@@ -41,9 +41,9 @@ public function index() {}
  *   )
  * )
  */
-    public function show() {}
+   public function show() {}
 
-    /**
+/**
  * @OA\Post(
  *   path="/faqs",
  *   tags={"Faqs"},
@@ -55,14 +55,32 @@ public function show() {}
  *       mediaType="application/json",
  *       @OA\Schema(
  *         @OA\Property(
- *           property="title",
- *           type="string",
- *           example="My frequently asked question"
+ *           property="ca",
+ *           type="object",
+ *           @OA\Property(
+ *             property="title",
+ *             type="string",
+ *             example="Títol de la meva pregunta freqüent"
+ *           ),
+ *           @OA\Property(
+ *             property="description",
+ *             type="string",
+ *             example="Descripció de la meva pregunta freqüent"
+ *           ),
  *         ),
  *         @OA\Property(
- *           property="description",
- *           type="string",
- *           example="Description of my FAQ"
+ *           property="es",
+ *           type="object",
+ *           @OA\Property(
+ *             property="title",
+ *             type="string",
+ *             example="Título de mi pregunta frecuente"
+ *           ),
+ *           @OA\Property(
+ *             property="description",
+ *             type="string",
+ *             example="Descripción de mi pregunta frecuente"
+ *           ),
  *         )
  *       )
  *     )
@@ -74,9 +92,9 @@ public function show() {}
  *   )
  * )
  */
-    public function store() {}
+   public function store() {}
 
-    /** 
+/**
  * @OA\Put(
  *   path="/faqs/{id}",
  *   tags={"Faqs"},
@@ -98,14 +116,32 @@ public function store() {}
  *       mediaType="application/json",
  *       @OA\Schema(
  *         @OA\Property(
- *           property="title",
- *           type="string",
- *           example="New title of my FAQ"
+ *           property="ca",
+ *           type="object",
+ *           @OA\Property(
+ *             property="title",
+ *             type="string",
+ *             example="Nou títol de FAQ"
+ *           ),
+ *           @OA\Property(
+ *             property="description",
+ *             type="string",
+ *             example="Nova descripció de FAQ"
+ *           ),
  *         ),
  *         @OA\Property(
- *           property="description",
- *           type="string",
- *           example="New description of my FAQ"
+ *           property="es",
+ *           type="object",
+ *           @OA\Property(
+ *             property="title",
+ *             type="string",
+ *             example="Nueva descripción de FAQ"
+ *           ),
+ *           @OA\Property(
+ *             property="description",
+ *             type="string",
+ *             example="Nueva descripción de GAQ"
+ *           ),
  *         )
  *       )
  *     )
@@ -117,9 +153,9 @@ public function store() {}
  *   )
  * )
  */
-    public function update() {}
+   public function update() {}
 
-    /**
+/**
  * @OA\Delete(
  *   path="/faqs/{id}",
  *   tags={"Faqs"},
@@ -142,6 +178,5 @@ public function update() {}
  *   )
  * )
  */
-
-    public function delete() {}
-}
+   public function delete() {}
+}