Add workflow to generate API specs and clients with a manual trigger

.github/workflows/generate-api-client.yml

@@ -2,29 +2,28 @@ name: OpenAPI
 
 on:
   pull_request:
+    types: [opened, synchronize, labeled, reopened]
     paths:
       - 'server/application-server/**'
       - '.github/workflows/generate-api-client.yml'
   push:
     paths:
       - 'server/application-server/openapi.yaml'
       - 'webapp/src/app/core/modules/openapi/**'
+    branches: [develop]
   workflow_dispatch:
 
-concurrency:
-  group: generate-api-client
-  cancel-in-progress: true
-
 jobs:
   generate-api-client:
-    name: Verify API Specs and Client
+    name: Verify API Specs and Client (add autocommit-openapi label to PR to auto-commit changes)
     runs-on: ubuntu-latest
 
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
         with:
           ref: ${{ github.event.pull_request.head.ref }}
+          persist-credentials: false # otherwise, the token used is the GITHUB_TOKEN, instead of your personal access token.
           fetch-depth: 0
 
       - name: Set up Node.js
@@ -56,4 +55,26 @@ jobs:
             echo "Changes detected in the API client directory."
             echo "NO_CHANGES_DETECTED=false" >> $GITHUB_ENV
             exit 1
-          fi
+          fi
+
+      - name: Commit files
+        if: ${{ always() && contains(github.event.pull_request.labels.*.name, 'autocommit-openapi') }}
+        run: |
+          echo "Committing and pushing changes..."
+          git config --local user.name "github-actions[bot]"
+          git config --local user.email "github-actions[bot]@users.noreply.github.com"
+          git commit -a -m "chore: update API specs and client"
+
+      - name: Push changes
+        if: ${{ always() && contains(github.event.pull_request.labels.*.name, 'autocommit-openapi') }}
+        uses: ad-m/github-push-action@master
+        with:
+          github_token: ${{ secrets.GH_PAT }}
+          branch: ${{ github.event.pull_request.head.ref  }}
+
+      - name: Remove autocommit-openapi label
+        if: ${{ always() && contains(github.event.pull_request.labels.*.name, 'autocommit-openapi') }}
+        run: |
+          echo "Removing the autocommit-openapi label..."
+          curl --silent --fail-with-body -X DELETE -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \
+          https://api.github.com/repos/${{ github.repository }}/issues/${{ github.event.pull_request.number }}/labels/autocommit-openapi

package.json

@@ -7,7 +7,7 @@
     "generate:api:clean": "rimraf webapp/src/app/core/modules/openapi",
     "generate:api:application-server-specs": "cd server/application-server && mvn verify -DskipTests=true && node ../../scripts/clean-openapi-specs.js",
     "generate:api:application-server-client": "npx openapi-generator-cli generate -i server/application-server/openapi.yaml -g typescript-angular -o webapp/src/app/core/modules/openapi --additional-properties fileNaming=kebab-case,withInterfaces=true --generate-alias-as-model",
-    "generate:api": "npm run generate:api:clean && npm run generate:api:application-server-client && npm run generate:api:application-server-specs"
+    "generate:api": "npm run generate:api:application-server-specs && npm run generate:api:clean && npm run generate:api:application-server-client"
   },
   "devDependencies": {
     "@openapitools/openapi-generator-cli": "2.13.5",

server/application-server/openapi.yaml

@@ -22,10 +22,11 @@ paths:
       operationId: getAllHellos
       responses:
         "200":
-          description: A list of all Hello entities
+          description: A set of all Hello entities
           content:
             application/json:
               schema:
+                uniqueItems: true
                 type: array
                 items:
                   $ref: "#/components/schemas/Hello"

server/application-server/src/main/java/de/tum/in/www1/hephaestus/hello/HelloController.java

@@ -1,6 +1,7 @@
 package de.tum.in.www1.hephaestus.hello;
 
 import java.util.List;
+import java.util.Set;
 
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PostMapping;
@@ -20,10 +21,10 @@ public HelloController(HelloService helloService) {
   /**
    * Retrieves all {@link Hello} entities.
    * 
-   * @return A list of all Hello entities
+   * @return A set of all Hello entities
    */
   @GetMapping
-  public List<Hello> getAllHellos() {
+  public Set<Hello> getAllHellos() {
     return helloService.getAllHellos();
   }
 

server/application-server/src/main/java/de/tum/in/www1/hephaestus/hello/HelloService.java

@@ -2,6 +2,8 @@
 
 import java.time.Instant;
 import java.util.List;
+import java.util.Set;
+import java.util.stream.Collectors;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -21,12 +23,12 @@ public HelloService(HelloRepository helloRepository) {
   /**
    * Retrieves all {@link Hello} entities from the repository.
    * 
-   * @return A list of all Hello entities
+   * @return A set of all Hello entities
    */
-  public List<Hello> getAllHellos() {
+  public Set<Hello> getAllHellos() {
     var hellos = helloRepository.findAll();
     logger.info("Getting Hellos: {}", hellos);
-    return helloRepository.findAll();
+    return helloRepository.findAll().stream().collect(Collectors.toSet());
   }
 
   /**

webapp/src/app/core/modules/openapi/api/hello.service.ts

@@ -162,9 +162,9 @@ export class HelloService implements HelloServiceInterface {
      * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
      * @param reportProgress flag to report request and response progress.
      */
-    public getAllHellos(observe?: 'body', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext, transferCache?: boolean}): Observable<Array<Hello>>;
-    public getAllHellos(observe?: 'response', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext, transferCache?: boolean}): Observable<HttpResponse<Array<Hello>>>;
-    public getAllHellos(observe?: 'events', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext, transferCache?: boolean}): Observable<HttpEvent<Array<Hello>>>;
+    public getAllHellos(observe?: 'body', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext, transferCache?: boolean}): Observable<Set<Hello>>;
+    public getAllHellos(observe?: 'response', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext, transferCache?: boolean}): Observable<HttpResponse<Set<Hello>>>;
+    public getAllHellos(observe?: 'events', reportProgress?: boolean, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext, transferCache?: boolean}): Observable<HttpEvent<Set<Hello>>>;
     public getAllHellos(observe: any = 'body', reportProgress: boolean = false, options?: {httpHeaderAccept?: 'application/json', context?: HttpContext, transferCache?: boolean}): Observable<any> {
 
         let localVarHeaders = this.defaultHeaders;
@@ -204,7 +204,7 @@ export class HelloService implements HelloServiceInterface {
         }
 
         let localVarPath = `/hello`;
-        return this.httpClient.request<Array<Hello>>('get', `${this.configuration.basePath}${localVarPath}`,
+        return this.httpClient.request<Set<Hello>>('get', `${this.configuration.basePath}${localVarPath}`,
             {
                 context: localVarHttpContext,
                 responseType: <any>responseType_,

webapp/src/app/core/modules/openapi/api/hello.serviceInterface.ts

@@ -34,6 +34,6 @@ export interface HelloServiceInterface {
      * Retrieves all {@link Hello Hello} entities.
      * Retrieves all {@link Hello Hello} entities.
      */
-    getAllHellos(extraHttpRequestParams?: any): Observable<Array<Hello>>;
+    getAllHellos(extraHttpRequestParams?: any): Observable<Set<Hello>>;
 
 }