Skip to content

docs: add "Get started with the API" developer guide #4761

docs: add "Get started with the API" developer guide

docs: add "Get started with the API" developer guide #4761

Triggered via pull request August 13, 2026 07:03
Status Success
Total duration 40m 18s
Artifacts 5

ci-cd.yml

on: pull_request
get-commit-message
11s
get-commit-message
Matrix: codeql / analyze
test  /  generate-matrix
4s
test / generate-matrix
Matrix: test / test
sonarcloud
6s
sonarcloud
ketryx_report_and_check  /  ketryx_report_and_check
1m 11s
ketryx_report_and_check / ketryx_report_and_check
Matrix: package_publish / build_native
Waiting for pending jobs
docker_publish  /  docker_publish
docker_publish / docker_publish
package_publish  /  package_publish
package_publish / package_publish
Fit to window
Zoom out
Zoom in

Annotations

4 errors, 13 warnings, and 1 notice
test / test (macos-15-intel, true)
Process completed with exit code 1.
test / test (macos-15-intel, true)
Failed to CreateArtifact: Unable to make request: ENOTFOUND If you are using self-hosted runners, please make sure your runner has access to all GitHub endpoints: https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners#communication-between-self-hosted-runners-and-github
test / test (macos-15-intel, true)
Process completed with exit code 2.
ketryx_report_and_check / ketryx_report_and_check
Failure reporting build to Ketryx: GitHub authentication failed while syncing change request 713. Check that the repository credentials are valid.
audit / audit
Retention days cannot be greater than the maximum allowed retention set within the repository. Using 14 instead.
test / test (ubuntu-24.04-arm, true)
Node.js 20 is deprecated. The following actions target Node.js 20 but are being forced to run on Node.js 24: SpicyPizza/create-envfile@ace6d4f5d7802b600276c23ca417e669f1a06f6f. For more information see: https://github.blog/changelog/2025-09-19-deprecation-of-node-20-on-github-actions-runners/
test / test (ubuntu-24.04-arm, true)
Unexpected input(s) 'envkey_AIGNOSTICS_API_ROOT', 'envkey_AIGNOSTICS_CLIENT_ID_DEVICE', 'envkey_AIGNOSTICS_REFRESH_TOKEN', 'envkey_AIGNOSTICS_SENTRY_ENABLED', 'envkey_AIGNOSTICS_SENTRY_DSN', 'envkey_AIGNOSTICS_SENTRY_DEBUG', 'envkey_AIGNOSTICS_SENTRY_SEND_DEFAULT_PII', 'envkey_AIGNOSTICS_SENTRY_SAMPLE_RATE', 'envkey_AIGNOSTICS_SENTRY_TRACES_SAMPLE_RATE', 'envkey_AIGNOSTICS_SENTRY_PROFILES_SAMPLE_RATE', valid inputs are ['file_name', 'directory', 'fail_on_empty', 'sort_keys']
test / test (ubuntu-latest, false)
Node.js 20 is deprecated. The following actions target Node.js 20 but are being forced to run on Node.js 24: codecov/test-results-action@0fa95f0e1eeaafde2c782583b36b28ad0d8c77d3, SpicyPizza/create-envfile@ace6d4f5d7802b600276c23ca417e669f1a06f6f. For more information see: https://github.blog/changelog/2025-09-19-deprecation-of-node-20-on-github-actions-runners/
test / test (ubuntu-latest, false)
This action is being deprecated in favor of 'codecov-action'. Please update CI accordingly to use 'codecov-action@v5' with 'report_type: test_results'. The 'codecov-action' should and can be run at least once for coverage and once for test results
test / test (ubuntu-latest, false)
Unexpected input(s) 'envkey_AIGNOSTICS_API_ROOT', 'envkey_AIGNOSTICS_CLIENT_ID_DEVICE', 'envkey_AIGNOSTICS_REFRESH_TOKEN', 'envkey_AIGNOSTICS_SENTRY_ENABLED', 'envkey_AIGNOSTICS_SENTRY_DSN', 'envkey_AIGNOSTICS_SENTRY_DEBUG', 'envkey_AIGNOSTICS_SENTRY_SEND_DEFAULT_PII', 'envkey_AIGNOSTICS_SENTRY_SAMPLE_RATE', 'envkey_AIGNOSTICS_SENTRY_TRACES_SAMPLE_RATE', 'envkey_AIGNOSTICS_SENTRY_PROFILES_SAMPLE_RATE', valid inputs are ['file_name', 'directory', 'fail_on_empty', 'sort_keys']
test / test (windows-latest, true)
Node.js 20 is deprecated. The following actions target Node.js 20 but are being forced to run on Node.js 24: SpicyPizza/create-envfile@ace6d4f5d7802b600276c23ca417e669f1a06f6f. For more information see: https://github.blog/changelog/2025-09-19-deprecation-of-node-20-on-github-actions-runners/
test / test (windows-latest, true)
Unexpected input(s) 'envkey_AIGNOSTICS_API_ROOT', 'envkey_AIGNOSTICS_CLIENT_ID_DEVICE', 'envkey_AIGNOSTICS_REFRESH_TOKEN', 'envkey_AIGNOSTICS_SENTRY_ENABLED', 'envkey_AIGNOSTICS_SENTRY_DSN', 'envkey_AIGNOSTICS_SENTRY_DEBUG', 'envkey_AIGNOSTICS_SENTRY_SEND_DEFAULT_PII', 'envkey_AIGNOSTICS_SENTRY_SAMPLE_RATE', 'envkey_AIGNOSTICS_SENTRY_TRACES_SAMPLE_RATE', 'envkey_AIGNOSTICS_SENTRY_PROFILES_SAMPLE_RATE', valid inputs are ['file_name', 'directory', 'fail_on_empty', 'sort_keys']
test / test (macos-latest, true)
Node.js 20 is deprecated. The following actions target Node.js 20 but are being forced to run on Node.js 24: SpicyPizza/create-envfile@ace6d4f5d7802b600276c23ca417e669f1a06f6f. For more information see: https://github.blog/changelog/2025-09-19-deprecation-of-node-20-on-github-actions-runners/
test / test (macos-latest, true)
Unexpected input(s) 'envkey_AIGNOSTICS_API_ROOT', 'envkey_AIGNOSTICS_CLIENT_ID_DEVICE', 'envkey_AIGNOSTICS_REFRESH_TOKEN', 'envkey_AIGNOSTICS_SENTRY_ENABLED', 'envkey_AIGNOSTICS_SENTRY_DSN', 'envkey_AIGNOSTICS_SENTRY_DEBUG', 'envkey_AIGNOSTICS_SENTRY_SEND_DEFAULT_PII', 'envkey_AIGNOSTICS_SENTRY_SAMPLE_RATE', 'envkey_AIGNOSTICS_SENTRY_TRACES_SAMPLE_RATE', 'envkey_AIGNOSTICS_SENTRY_PROFILES_SAMPLE_RATE', valid inputs are ['file_name', 'directory', 'fail_on_empty', 'sort_keys']
test / test (macos-15-intel, true)
Node.js 20 is deprecated. The following actions target Node.js 20 but are being forced to run on Node.js 24: SpicyPizza/create-envfile@ace6d4f5d7802b600276c23ca417e669f1a06f6f. For more information see: https://github.blog/changelog/2025-09-19-deprecation-of-node-20-on-github-actions-runners/
test / test (macos-15-intel, true)
Unexpected input(s) 'envkey_AIGNOSTICS_API_ROOT', 'envkey_AIGNOSTICS_CLIENT_ID_DEVICE', 'envkey_AIGNOSTICS_REFRESH_TOKEN', 'envkey_AIGNOSTICS_SENTRY_ENABLED', 'envkey_AIGNOSTICS_SENTRY_DSN', 'envkey_AIGNOSTICS_SENTRY_DEBUG', 'envkey_AIGNOSTICS_SENTRY_SEND_DEFAULT_PII', 'envkey_AIGNOSTICS_SENTRY_SAMPLE_RATE', 'envkey_AIGNOSTICS_SENTRY_TRACES_SAMPLE_RATE', 'envkey_AIGNOSTICS_SENTRY_PROFILES_SAMPLE_RATE', valid inputs are ['file_name', 'directory', 'fail_on_empty', 'sort_keys']
ketryx_report_and_check / ketryx_report_and_check
Node.js 20 is deprecated. The following actions target Node.js 20 but are being forced to run on Node.js 24: Ketryx/ketryx-github-action@719ef26488ed7f9d36a45a6d67d649726d5ece6a. For more information see: https://github.blog/changelog/2025-09-19-deprecation-of-node-20-on-github-actions-runners/
ketryx_report_and_check / ketryx_report_and_check
ketryx-github-action v1 runs on Node.js 20, which is end-of-life. Upgrade to Ketryx/ketryx-github-action@v2 (Node.js 24; self-hosted runners need actions/runner v2.327.1 or later). v1 receives critical fixes only. Set KETRYX_SUPPRESS_V1_DEPRECATION=true to hide this notice. See https://github.com/Ketryx/ketryx-github-action/releases

Artifacts

Produced during runtime
Name Size Digest
audit-results
389 KB
sha256:d1168e311119143eefc3012782f8659ff989ee177e3e5a08913d3264e77fab16
test-results-macos-latest
843 KB
sha256:af91c94d86a742399a24c8520701ec23d67bc0c1097ced9b9bc6479a4a70bc70
test-results-ubuntu-24.04-arm
843 KB
sha256:982ef53557aa7cbde55f5a874bc41613a5ea556835d5e18a483bcfa27c50cc47
test-results-ubuntu-latest
843 KB
sha256:f364f426885d3f9279e2361c3438c29cf6d04f1b7eff6b9ff33594a3470e6653
test-results-windows-latest
843 KB
sha256:0b06ef9c7c4aac6955c462a752856596ec37d704bd0d41961f09fc8546190674