✨ Extend the code generator for JobItems (#75)

### Description
This change refactors the generator to be able to handle multiple types
of generation, and extends it with a new type for JobItems, which are
schemas that have the property `x-job: true`.

The code generated for the the JobItems implements missing methods that
would make these JobItem types satisfy the `IAsynchronousJob` interface
defined
[here](https://github.com/ARM-software/embedded-development-services-client-utils/blob/main/utils/job/interfaces.go).

- [X]  This change is covered by existing or additional automated tests.
- [ ] Manual testing has been performed (and evidence provided) as
automated testing was not feasible.
- [ ] Additional tests are not required for this change (e.g.
documentation update).

---------

Co-authored-by: aorabdel <aorabdel@users.noreply.github.com>

Author: aorabdel

.github/workflows/update-client.yml

@@ -93,7 +93,8 @@ jobs:
       run: |
         cd generator
         go mod tidy
-        go run main.go -i ../all-service-definition/all-def-flat.yaml -o ../extensions/extension_entities.gen.go
+        go run main.go -i ../all-service-definition/all-def-flat.yaml -o ../extensions/extension_entities.gen.go -t templates/entities.go.tmpl -g collections
+        go run main.go -i ../all-service-definition/all-def-flat.yaml -o ../extensions/extension_jobs.gen.go -t templates/jobs.go.tmpl -g jobs
     - name: Copy extensions to client
       run: |
         if [ -d ./extensions/ ] ; then cp -r extensions/. ${{ env.go_module }}/ ; fi

.secrets.baseline

@@ -91,15 +91,33 @@
     {
       "path": "detect_secrets.filters.regex.should_exclude_file",
       "pattern": [
+        ".*go\\.sum$",
         ".*\\.html$",
         ".*\\.properties$",
-        "^\\.git[\\\\/]",
-        ".*go\\.sum$",
-        "^workflows/.*"
+        "ci.yml",
+        "\\.git"
       ]
     }
   ],
   "results": {
+    "client/docs/AuthorizationAPI.md": [
+      {
+        "type": "Base64 High Entropy String",
+        "filename": "client/docs/AuthorizationAPI.md",
+        "hashed_secret": "b6c30ab47db0e58093620b979821ff3a0f14226d",
+        "is_verified": false,
+        "line_number": 36
+      }
+    ],
+    "client/docs/FPGAJobsAPI.md": [
+      {
+        "type": "Hex High Entropy String",
+        "filename": "client/docs/FPGAJobsAPI.md",
+        "hashed_secret": "a971ecb6f8d59edcdb891d80bc3965504aa1f6ec",
+        "is_verified": false,
+        "line_number": 199
+      }
+    ],
     "client/docs/WorkspaceAPI.md": [
       {
         "type": "Hex High Entropy String",
@@ -126,5 +144,5 @@
       }
     ]
   },
-  "generated_at": "2024-05-03T09:46:30Z"
+  "generated_at": "2025-03-25T15:29:18Z"
 }

changes/20250325112617.feature

@@ -0,0 +1 @@
+:sparkles: Extend the code generator for JobItems, which are schemas that have `x-job: true`

changes/20250325115157.feature

@@ -0,0 +1 @@
+Updated client due to schema changes

changes/20250325122844.feature

@@ -0,0 +1 @@
+Updated client due to schema changes

client/.openapi-generator/FILES

@@ -3,6 +3,7 @@
 README.md
 api/openapi.yaml
 api_authentication.go
+api_authorization.go
 api_build_jobs.go
 api_cmsis_builders.go
 api_cmsis_intellisense_builders.go
@@ -29,6 +30,7 @@ docs/ArtefactManagerCollection.md
 docs/ArtefactManagerItem.md
 docs/ArtefactManagerLinks.md
 docs/AuthenticationAPI.md
+docs/AuthorizationAPI.md
 docs/BuildJobCollection.md
 docs/BuildJobItem.md
 docs/BuildJobItemLinks.md
@@ -71,6 +73,7 @@ docs/EndpointDeprecationNoticeCollection.md
 docs/EndpointDeprecationNoticeLinks.md
 docs/ErrorResponse.md
 docs/FPGACollection.md
+docs/FPGACollectionLinks.md
 docs/FPGAConnectionAPI.md
 docs/FPGAConnectionCollection.md
 docs/FPGAConnectionItem.md
@@ -84,6 +87,7 @@ docs/FPGAJobsAPI.md
 docs/FPGAPayloadCollection.md
 docs/FPGAPayloadItem.md
 docs/FPGAPayloadItemLinks.md
+docs/FPGAPayloadRepositories.md
 docs/FPGAPayloadsAPI.md
 docs/FPGAsAPI.md
 docs/FieldObject.md
@@ -114,6 +118,7 @@ docs/PATCreationItem.md
 docs/PATItem.md
 docs/PATItemLinks.md
 docs/PagingMetadata.md
+docs/PermissionItem.md
 docs/PersonalAccessTokenAPI.md
 docs/RetainBuildJobRequest.md
 docs/RetainWorkspaceRequest.md
@@ -196,6 +201,7 @@ model_endpoint_deprecation_notice_links.go
 model_error_response.go
 model_field_object.go
 model_fpga_collection.go
+model_fpga_collection_links.go
 model_fpga_connection_collection.go
 model_fpga_connection_item.go
 model_fpga_connection_item_links.go
@@ -207,6 +213,7 @@ model_fpga_job_item_links.go
 model_fpga_payload_collection.go
 model_fpga_payload_item.go
 model_fpga_payload_item_links.go
+model_fpga_payload_repositories.go
 model_generic_work_job_collection.go
 model_generic_work_job_item.go
 model_generic_work_job_item_links.go
@@ -231,6 +238,7 @@ model_pat_collection.go
 model_pat_creation_item.go
 model_pat_item.go
 model_pat_item_links.go
+model_permission_item.go
 model_retain_build_job_request.go
 model_retain_workspace_request.go
 model_simple_collection.go
@@ -261,6 +269,7 @@ model_workspace_source_item.go
 model_workspace_source_item_links.go
 response.go
 test/api_authentication_test.go
+test/api_authorization_test.go
 test/api_build_jobs_test.go
 test/api_cmsis_builders_test.go
 test/api_cmsis_intellisense_builders_test.go

client/README.md

@@ -112,6 +112,7 @@ Class | Method | HTTP request | Description
 *AuthenticationAPI* | [**CreateUser**](docs/AuthenticationAPI.md#createuser) | **Post** /users/ | Create a user.
 *AuthenticationAPI* | [**GetMe**](docs/AuthenticationAPI.md#getme) | **Get** /users/me | Get my user information
 *AuthenticationAPI* | [**GetUser**](docs/AuthenticationAPI.md#getuser) | **Get** /users/{name} | Get user information
+*AuthorizationAPI* | [**CheckPermission**](docs/AuthorizationAPI.md#checkpermission) | **Post** /entitlements/check | Check permissions on a resource.
 *BuildJobsAPI* | [**CancelBuildJob**](docs/BuildJobsAPI.md#cancelbuildjob) | **Post** /build-jobs/{jobName}/cancel | Cancel a Build Job
 *BuildJobsAPI* | [**DeleteBuildJob**](docs/BuildJobsAPI.md#deletebuildjob) | **Delete** /build-jobs/{jobName} | Delete a Build Job
 *BuildJobsAPI* | [**GetBuildArtefact**](docs/BuildJobsAPI.md#getbuildartefact) | **Get** /build-jobs/{jobName}/artefacts/{artefactName} | Download the named Build Artefact for the given Build Job.
@@ -153,13 +154,13 @@ Class | Method | HTTP request | Description
 *FPGAJobsAPI* | [**RetainFpgaJob**](docs/FPGAJobsAPI.md#retainfpgajob) | **Post** /fpga-jobs/{jobName}/retain | Update how long an FPGA job will be retained before automatic deletion.
 *FPGAJobsAPI* | [**StartFpgaJob**](docs/FPGAJobsAPI.md#startfpgajob) | **Post** /fpgas/{fpgaName} | Initiate a job on an FPGA.
 *FPGAJobsAPI* | [**UploadFpgaJobArtefact**](docs/FPGAJobsAPI.md#uploadfpgajobartefact) | **Put** /fpga-jobs/{jobName}/artefacts/{artefactName}/artefact | Upload and replace the named artefact.
-*FPGAPayloadsAPI* | [**CreateFPGAPayload**](docs/FPGAPayloadsAPI.md#createfpgapayload) | **Post** /fpgas/{fpgaName}/payloads | Create an FPGA payload.
+*FPGAPayloadsAPI* | [**CreateFPGAPayload**](docs/FPGAPayloadsAPI.md#createfpgapayload) | **Post** /repositories/{repositoryName}/payloads | Create an FPGA payload.
 *FPGAPayloadsAPI* | [**CreateFPGAPayloadUploadSession**](docs/FPGAPayloadsAPI.md#createfpgapayloaduploadsession) | **Post** /payloads/{fpgaPayloadName}/upload-session | Create upload session for FPGA payload.
 *FPGAPayloadsAPI* | [**DeleteFpgaPayload**](docs/FPGAPayloadsAPI.md#deletefpgapayload) | **Delete** /payloads/{fpgaPayloadName} | Delete an FPGA payload.
 *FPGAPayloadsAPI* | [**GetFpgaPayload**](docs/FPGAPayloadsAPI.md#getfpgapayload) | **Get** /payloads/{fpgaPayloadName} | Return details of specific FPGA payload.
 *FPGAPayloadsAPI* | [**GetFpgaPayloadUploadOptions**](docs/FPGAPayloadsAPI.md#getfpgapayloaduploadoptions) | **Options** /payloads | Return service TUS protocol support.
 *FPGAPayloadsAPI* | [**GetFpgaPayloadUploadProgress**](docs/FPGAPayloadsAPI.md#getfpgapayloaduploadprogress) | **Head** /payloads/{fpgaPayloadName} | Return FPGA payload upload progress.
-*FPGAPayloadsAPI* | [**ListFPGAPayloads**](docs/FPGAPayloadsAPI.md#listfpgapayloads) | **Get** /fpgas/{fpgaName}/payloads | List payloads for an FPGA.
+*FPGAPayloadsAPI* | [**ListFPGAPayloads**](docs/FPGAPayloadsAPI.md#listfpgapayloads) | **Get** /repositories/{repositoryName}/payloads | List payloads in a repository.
 *FPGAPayloadsAPI* | [**ListPayloads**](docs/FPGAPayloadsAPI.md#listpayloads) | **Get** /payloads | List payloads.
 *FPGAPayloadsAPI* | [**UploadPayload**](docs/FPGAPayloadsAPI.md#uploadpayload) | **Patch** /payloads/{fpgaPayloadName} | Upload part of a payload.
 *FPGAsAPI* | [**CommissionFpga**](docs/FPGAsAPI.md#commissionfpga) | **Post** /fpgas/ | Commission a new FPGA.
@@ -278,6 +279,7 @@ Class | Method | HTTP request | Description
  - [EndpointDeprecationNoticeLinks](docs/EndpointDeprecationNoticeLinks.md)
  - [ErrorResponse](docs/ErrorResponse.md)
  - [FPGACollection](docs/FPGACollection.md)
+ - [FPGACollectionLinks](docs/FPGACollectionLinks.md)
  - [FPGAConnectionCollection](docs/FPGAConnectionCollection.md)
  - [FPGAConnectionItem](docs/FPGAConnectionItem.md)
  - [FPGAConnectionItemLinks](docs/FPGAConnectionItemLinks.md)
@@ -289,6 +291,7 @@ Class | Method | HTTP request | Description
  - [FPGAPayloadCollection](docs/FPGAPayloadCollection.md)
  - [FPGAPayloadItem](docs/FPGAPayloadItem.md)
  - [FPGAPayloadItemLinks](docs/FPGAPayloadItemLinks.md)
+ - [FPGAPayloadRepositories](docs/FPGAPayloadRepositories.md)
  - [FieldObject](docs/FieldObject.md)
  - [GenericWorkJobCollection](docs/GenericWorkJobCollection.md)
  - [GenericWorkJobItem](docs/GenericWorkJobItem.md)
@@ -314,6 +317,7 @@ Class | Method | HTTP request | Description
  - [PATItem](docs/PATItem.md)
  - [PATItemLinks](docs/PATItemLinks.md)
  - [PagingMetadata](docs/PagingMetadata.md)
+ - [PermissionItem](docs/PermissionItem.md)
  - [RetainBuildJobRequest](docs/RetainBuildJobRequest.md)
  - [RetainWorkspaceRequest](docs/RetainWorkspaceRequest.md)
  - [SimpleCollection](docs/SimpleCollection.md)