Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 0 additions & 15 deletions .github/workflows/build-and-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -77,21 +77,6 @@ jobs:
version: latest
working-directory: ${{ matrix.go-module }}
args: "--verbose --print-issued-lines --print-linter-name --out-${NO_FUTURE}format colored-line-number --timeout 300s --max-issues-per-linter 0 --max-same-issues 0"
# FIXME Send coverage to code climate
#
# - if: ${{ startsWith(matrix.os, 'ubuntu') }}
# name: Test [${{ matrix.go-module }} on ${{ matrix.os }}] & Publish Code Coverage
# uses: paambaati/codeclimate-action@v2.7.5
# env:
# CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
# with:
# debug: true
# workingDirectory: ${{ matrix.go-module }}
# coverageCommand: go test -race -cover -v -coverprofile ${{ matrix.go-module }}_coverage.out ./...
# prefix: github.com/ARM-software/${{ github.event.repository.name }}/${{ matrix.go-module }}
# coverageLocations:
# "${{github.workspace}}/${{ matrix.go-module }}/${{ matrix.go-module }}_coverage.out:gocov"
# - if: ${{ startsWith(matrix.os, 'windows') || startsWith(matrix.os, 'macOS') }}
- name: Test ${{ matrix.go-module }} on ${{ matrix.os }}
run: go test -race -cover -v ./...
working-directory: ${{ matrix.go-module }}
5 changes: 3 additions & 2 deletions .github/workflows/update-client.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,9 @@ jobs:
token: ${{ secrets.GIT_SECRET }}
repository: Arm-Debug/API-Uniform-Contract
path: API-Uniform-Contract
ref: production
- uses: actions/upload-artifact@master
ref: main
# FIXME set to `production`
- uses: actions/upload-artifact@4.6.2
with:
name: all-service-flat
path: API-Uniform-Contract/all/1/
Expand Down
11 changes: 1 addition & 10 deletions .secrets.baseline
Original file line number Diff line number Diff line change
Expand Up @@ -105,15 +105,6 @@
}
],
"results": {
"client/docs/AuthorizationAPI.md": [
{
"type": "Base64 High Entropy String",
"filename": "client/docs/AuthorizationAPI.md",
"hashed_secret": "b6c30ab47db0e58093620b979821ff3a0f14226d",
"is_verified": false,
"line_number": 39
}
],
"client/docs/FPGAJobsAPI.md": [
{
"type": "Hex High Entropy String",
Expand Down Expand Up @@ -149,5 +140,5 @@
}
]
},
"generated_at": "2025-06-19T13:33:59Z"
"generated_at": "2025-06-19T15:05:40Z"
}
11 changes: 0 additions & 11 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,17 +49,6 @@ If you want to manually run all pre-commit hooks on a repository without creatin

To run individual hooks use `pre-commit run <hook_id>`.

## Code Climate

Code Climate is integrated with our GitHub flow. Failing the configured rules will yield a pull request not mergeable.

If you prefer to view the Code Climate report on your machine, prior to sending a pull request, you can use the [cli provided by Code Climate](https://docs.codeclimate.com/docs/command-line-interface).

Plugins for various tools are also available:
- [Atom](https://docs.codeclimate.com/docs/code-climate-atom-package)
- [PyCharm](https://plugins.jetbrains.com/plugin/13306-code-cleaner-with-code-climate-cli)
- [Vim](https://docs.codeclimate.com/docs/vim-plugin)

# Dependency upgrades

For dependency upgrades, dependabot is relied upon and news files are auto-generated in order to document such change. Nonetheless, due to a change in [GitHub actions](https://github.blog/changelog/2021-02-19-github-actions-workflows-triggered-by-dependabot-prs-will-run-with-read-only-permissions), secrets are not available in the build triggered by the pull request unless they are [re-run manually](https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/automating-dependabot-with-github-actions#manually-re-running-a-workflow). So please re-run every dependabot PR CI jobs.
Expand Down
1 change: 1 addition & 0 deletions changes/20250613164851.misc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
:memo: Remove code climate references
1 change: 1 addition & 0 deletions changes/20250616131104.feature
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Updated client due to schema changes
1 change: 1 addition & 0 deletions changes/20250619151146.feature
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Updated client due to schema changes
20 changes: 20 additions & 0 deletions client/.openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ api_build_jobs.go
api_cmsis_builders.go
api_cmsis_intellisense_builders.go
api_deprecation_notice.go
api_fpga_admin.go
api_fpga_connection.go
api_fpga_entitlements.go
api_fpga_jobs.go
api_fpga_payloads.go
api_fpgas.go
Expand Down Expand Up @@ -54,6 +56,7 @@ docs/EmbeddedBuildJobItems.md
docs/EmbeddedCmsisBuilderItems.md
docs/EmbeddedCmsisIntellisenseItems.md
docs/EmbeddedEndpointDeprecationNoticeItems.md
docs/EmbeddedFPGAAdminItem.md
docs/EmbeddedFPGAConnectionItems.md
docs/EmbeddedFPGAItems.md
docs/EmbeddedFPGAJobItems.md
Expand All @@ -74,12 +77,17 @@ docs/EndpointDeprecationNotice.md
docs/EndpointDeprecationNoticeCollection.md
docs/EndpointDeprecationNoticeLinks.md
docs/ErrorResponse.md
docs/FPGAAdminAPI.md
docs/FPGAAdminCollection.md
docs/FPGAAdminItem.md
docs/FPGACollection.md
docs/FPGACollectionLinks.md
docs/FPGAConnectionAPI.md
docs/FPGAConnectionCollection.md
docs/FPGAConnectionItem.md
docs/FPGAConnectionItemLinks.md
docs/FPGAEntitlementItem.md
docs/FPGAEntitlementsAPI.md
docs/FPGAItem.md
docs/FPGAItemLinks.md
docs/FPGAJobCollection.md
Expand All @@ -93,6 +101,7 @@ docs/FPGAPayloadRepositories.md
docs/FPGAPayloadsAPI.md
docs/FPGATarget.md
docs/FPGATargetID.md
docs/FPGAUARTConnection.md
docs/FPGAWorkload.md
docs/FPGAsAPI.md
docs/FieldObject.md
Expand Down Expand Up @@ -134,6 +143,8 @@ docs/RetainBuildJobRequest.md
docs/RetainWorkspaceRequest.md
docs/RootResourceAPI.md
docs/SimpleCollection.md
docs/TokenIntrospectionRequestItem.md
docs/TokenIntrospectionResponseItem.md
docs/ToolchainTypes.md
docs/UserCollection.md
docs/UserInviteItem.md
Expand Down Expand Up @@ -193,6 +204,7 @@ model_embedded_build_job_items.go
model_embedded_cmsis_builder_items.go
model_embedded_cmsis_intellisense_items.go
model_embedded_endpoint_deprecation_notice_items.go
model_embedded_fpga_admin_item.go
model_embedded_fpga_connection_items.go
model_embedded_fpga_items.go
model_embedded_fpga_job_items.go
Expand All @@ -214,11 +226,14 @@ model_endpoint_deprecation_notice_collection.go
model_endpoint_deprecation_notice_links.go
model_error_response.go
model_field_object.go
model_fpga_admin_collection.go
model_fpga_admin_item.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
model_fpga_entitlement_item.go
model_fpga_item.go
model_fpga_item_links.go
model_fpga_job_collection.go
Expand All @@ -231,6 +246,7 @@ model_fpga_payload_repositories.go
model_fpga_target.go
model_fpga_target_id.go
model_fpga_workload.go
model_fpgauart_connection.go
model_generic_work_job_collection.go
model_generic_work_job_item.go
model_generic_work_job_item_links.go
Expand Down Expand Up @@ -264,6 +280,8 @@ model_resource_type_permission_item_links.go
model_retain_build_job_request.go
model_retain_workspace_request.go
model_simple_collection.go
model_token_introspection_request_item.go
model_token_introspection_response_item.go
model_toolchain_types.go
model_user_collection.go
model_user_invite_item.go
Expand Down Expand Up @@ -298,7 +316,9 @@ test/api_build_jobs_test.go
test/api_cmsis_builders_test.go
test/api_cmsis_intellisense_builders_test.go
test/api_deprecation_notice_test.go
test/api_fpga_admin_test.go
test/api_fpga_connection_test.go
test/api_fpga_entitlements_test.go
test/api_fpga_jobs_test.go
test/api_fpga_payloads_test.go
test/api_fpgas_test.go
Expand Down
13 changes: 13 additions & 0 deletions client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,7 @@ Class | Method | HTTP request | Description
*AuthenticationAPI* | [**GetUser**](docs/AuthenticationAPI.md#getuser) | **Get** /users/{userName} | Get user information
*AuthenticationAPI* | [**InviteUser**](docs/AuthenticationAPI.md#inviteuser) | **Post** /users/invite | Invite a user.
*AuthenticationAPI* | [**ListUsers**](docs/AuthenticationAPI.md#listusers) | **Get** /users/ | List all users
*AuthenticationAPI* | [**TokenIntrospect**](docs/AuthenticationAPI.md#tokenintrospect) | **Post** /token/introspect | Introspect a token.
*AuthorizationAPI* | [**CheckEntitlements**](docs/AuthorizationAPI.md#checkentitlements) | **Post** /entitlements/check | Check permissions on a resource.
*AuthorizationAPI* | [**GetResourceInstanceEntitlements**](docs/AuthorizationAPI.md#getresourceinstanceentitlements) | **Get** /users/{userName}/entitlements/{resourceType}/instances/{resourceInstanceName} | Return details of the user&#39;s permissions for a resource instance.
*AuthorizationAPI* | [**GetResourceTypeEntitlements**](docs/AuthorizationAPI.md#getresourcetypeentitlements) | **Get** /users/{userName}/entitlements/{resourceType} | Return details of the user&#39;s permissions for a resource type.
Expand All @@ -137,10 +138,15 @@ Class | Method | HTTP request | Description
*CMSISIntellisenseBuildersAPI* | [**StartCmsisIntellisense**](docs/CMSISIntellisenseBuildersAPI.md#startcmsisintellisense) | **Post** /cmsis-intellisense/{builderName} | Initiate a compilation database generation using the specified CMSIS Intellisense Builder.
*DeprecationNoticeAPI* | [**GetDeprecationNotice**](docs/DeprecationNoticeAPI.md#getdeprecationnotice) | **Get** /deprecations/{operationName} | Return details of specific endpoint deprecation notice.
*DeprecationNoticeAPI* | [**ListDeprecatedEndpoints**](docs/DeprecationNoticeAPI.md#listdeprecatedendpoints) | **Get** /deprecations/ | Get the endpoints that have been deprecated with some notice.
*FPGAAdminAPI* | [**AddFPGAAdmin**](docs/FPGAAdminAPI.md#addfpgaadmin) | **Post** /fpga-admins | Add a user to the FPGA admin group
*FPGAAdminAPI* | [**ListFPGAAdmins**](docs/FPGAAdminAPI.md#listfpgaadmins) | **Get** /fpga-admins | List all the members of the FPGA admin group
*FPGAAdminAPI* | [**RemoveFPGAAdmin**](docs/FPGAAdminAPI.md#removefpgaadmin) | **Delete** /fpga-admins/{fpgaAdminName} | Remove a user from the FPGA admin group
*FPGAConnectionAPI* | [**GetFpgaConnection**](docs/FPGAConnectionAPI.md#getfpgaconnection) | **Get** /fpga-connections/{connectionName} | Get connection information
*FPGAConnectionAPI* | [**ListFpgaConnections**](docs/FPGAConnectionAPI.md#listfpgaconnections) | **Get** /fpga-connections/ | List available FPGA connections.
*FPGAConnectionAPI* | [**StartFpgaConnection**](docs/FPGAConnectionAPI.md#startfpgaconnection) | **Get** /fpga-connections/{connectionName}/connect | starts a websocket connection
*FPGAConnectionAPI* | [**TerminateFpgaConnection**](docs/FPGAConnectionAPI.md#terminatefpgaconnection) | **Post** /fpga-connections/{connectionName}/terminate | Terminates all websocket connections to the application running on the FPGA
*FPGAEntitlementsAPI* | [**GetFpgaEntitlement**](docs/FPGAEntitlementsAPI.md#getfpgaentitlement) | **Get** /fpga-entitlements/{fpgaEntitlementName} | Return details of specific FPGA entitlement.
*FPGAEntitlementsAPI* | [**UpdateFPGAEntitlement**](docs/FPGAEntitlementsAPI.md#updatefpgaentitlement) | **Put** /fpga-entitlements | Update an FPGA entitlement that defines which users are permitted to interact with an FPGA.
*FPGAJobsAPI* | [**CancelFpgaJob**](docs/FPGAJobsAPI.md#cancelfpgajob) | **Post** /fpga-jobs/{jobName}/cancel | Cancel an FPGA job.
*FPGAJobsAPI* | [**ClearFpgaJobArtefact**](docs/FPGAJobsAPI.md#clearfpgajobartefact) | **Delete** /fpga-jobs/{jobName}/artefacts/{artefactName}/artefact | Clear the job artefact.
*FPGAJobsAPI* | [**CreateFpgaJobArtefactManager**](docs/FPGAJobsAPI.md#createfpgajobartefactmanager) | **Post** /fpga-jobs/{jobName}/artefacts/ | Create a job artefact manager.
Expand Down Expand Up @@ -265,6 +271,7 @@ Class | Method | HTTP request | Description
- [EmbeddedCmsisBuilderItems](docs/EmbeddedCmsisBuilderItems.md)
- [EmbeddedCmsisIntellisenseItems](docs/EmbeddedCmsisIntellisenseItems.md)
- [EmbeddedEndpointDeprecationNoticeItems](docs/EmbeddedEndpointDeprecationNoticeItems.md)
- [EmbeddedFPGAAdminItem](docs/EmbeddedFPGAAdminItem.md)
- [EmbeddedFPGAConnectionItems](docs/EmbeddedFPGAConnectionItems.md)
- [EmbeddedFPGAItems](docs/EmbeddedFPGAItems.md)
- [EmbeddedFPGAJobItems](docs/EmbeddedFPGAJobItems.md)
Expand All @@ -285,11 +292,14 @@ Class | Method | HTTP request | Description
- [EndpointDeprecationNoticeCollection](docs/EndpointDeprecationNoticeCollection.md)
- [EndpointDeprecationNoticeLinks](docs/EndpointDeprecationNoticeLinks.md)
- [ErrorResponse](docs/ErrorResponse.md)
- [FPGAAdminCollection](docs/FPGAAdminCollection.md)
- [FPGAAdminItem](docs/FPGAAdminItem.md)
- [FPGACollection](docs/FPGACollection.md)
- [FPGACollectionLinks](docs/FPGACollectionLinks.md)
- [FPGAConnectionCollection](docs/FPGAConnectionCollection.md)
- [FPGAConnectionItem](docs/FPGAConnectionItem.md)
- [FPGAConnectionItemLinks](docs/FPGAConnectionItemLinks.md)
- [FPGAEntitlementItem](docs/FPGAEntitlementItem.md)
- [FPGAItem](docs/FPGAItem.md)
- [FPGAItemLinks](docs/FPGAItemLinks.md)
- [FPGAJobCollection](docs/FPGAJobCollection.md)
Expand All @@ -301,6 +311,7 @@ Class | Method | HTTP request | Description
- [FPGAPayloadRepositories](docs/FPGAPayloadRepositories.md)
- [FPGATarget](docs/FPGATarget.md)
- [FPGATargetID](docs/FPGATargetID.md)
- [FPGAUARTConnection](docs/FPGAUARTConnection.md)
- [FPGAWorkload](docs/FPGAWorkload.md)
- [FieldObject](docs/FieldObject.md)
- [GenericWorkJobCollection](docs/GenericWorkJobCollection.md)
Expand Down Expand Up @@ -336,6 +347,8 @@ Class | Method | HTTP request | Description
- [RetainBuildJobRequest](docs/RetainBuildJobRequest.md)
- [RetainWorkspaceRequest](docs/RetainWorkspaceRequest.md)
- [SimpleCollection](docs/SimpleCollection.md)
- [TokenIntrospectionRequestItem](docs/TokenIntrospectionRequestItem.md)
- [TokenIntrospectionResponseItem](docs/TokenIntrospectionResponseItem.md)
- [ToolchainTypes](docs/ToolchainTypes.md)
- [UserCollection](docs/UserCollection.md)
- [UserInviteItem](docs/UserInviteItem.md)
Expand Down
Loading