Skip to content

About

Open Targets Platform API

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

Open Targets nextgen Platform API

Rust GraphQL API for Open Targets Platform and Partner Preview Platform.

Development

The repository pins Rust 1.99.0 in rust-toolchain.toml, matching the minimum Rust version in Cargo.toml. Rustup selects the pinned toolchain for Cargo commands, including the GraphQL pre-commit hook. Install the toolchain before committing:

rustup toolchain install 1.99.0 --profile minimal --component clippy
    cargo watch -c -w src -x 'run --features product-platform'

Note

By default, Zed will work with the product-platform feature enabled. This means it will behave as if we're compiling the API for platform product. To work on ppp, change Zed's settings to:

{
  "rust-analyzer": {
     "initialization_options": {
         "cargo": {
            "features": ["ppp"]

Timeout configuration

clickhouse_max_execution_time and opensearch_timeout accept nonnegative Jiff duration strings, such as "30s", "500ms", "1h 30m", or ISO 8601 "PT30S". The same syntax applies to the PLATFORM_API_ environment overrides. When omitted, ClickHouse defaults to 0s (no execution limit) and OpenSearch defaults to 10s.

Following the migration from humantime, units of days or larger are no longer accepted for these fixed timeouts. Use "24h" instead of "1d"; months and years are not supported.

Build

Exactly one product feature must be enabled:

    cargo build --release --features product-platform
    cargo build --release --features product-ppp

Docker (PRODUCT defaults to platform):

    docker build -t platform-api .
    docker build --build-arg PRODUCT=ppp -t platform-api-ppp .

Releases

Images are built by build-images.yaml, which is called by:

  • build-dev.yaml, on pushing a vX.Y.Z-* tag. Pushes <version>.
  • build-release.yaml, on publishing a GitHub release. Pushes <version>, plus latest unless it's a pre-release.

Every build includes both products, each to its own image:

Product Image
platform platform-api-nextgen
ppp platform-api-nextgen-ppp

Both images share the tag's version. Each product is deployed independently.

GraphQL schema tracking

Changes to Rust types can change the public GraphQL API: fields can disappear, argument types can change, and new fields can become available. Schema tracking makes API changes visible during review and provides schema release notes.

The idea is to keep a readable API snapshot alongside the Rust code. Before every commit, a local hook generates schema.graphql from the Platform Rust types and includes the snapshot in the commit. GitHub CI compares committed snapshots with GraphQL Inspector and reports breaking, potentially dangerous, and non-breaking changes in PRs. Publishing a release generates schema release notes from the previous and current release snapshots.

Schema reports are informational and require no approval.

Schema tracking covers product-platform.

Set up

Install the Rust toolchain described under Development, then install the commit hook:

uv tool install pre-commit
pre-commit install

Commit API changes

Stage the intended Rust changes and commit normally. The hook generates schema.graphql and automatically stages the generated snapshot in the same commit. The hook creates schema.graphql from the local Rust code when the snapshot is missing and refreshes the snapshot on every commit.

Schema export runs without starting the API server or connecting to databases. Export failures stop the commit before replacing the snapshot. Schema changes never block the commit.

To regenerate and stage the schema from the current working tree manually:

pre-commit run graphql-schema --all-files

Read PR reports

Schema CI compares committed snapshots with GraphQL Inspector:

Event Comparison
PR targeting main Latest fetched main commit → PR head commit
Push to main main before the push → pushed commit
Development-branch push without a PR to main No schema comparison

Pushing to a branch with an open PR targeting main triggers the PR comparison. PRs targeting other branches, scheduled runs, and manual CI runs skip schema jobs. CI reads schema.graphql directly from Git; CI does not compile Rust or modify committed snapshots. Installing the commit hook keeps the snapshots current.

Reports appear in workflow logs, the job summary, and the graphql-schema-release-notes artifact. For same-repository PRs, CI also updates the PR description between <!-- graphql-schema-notes:start --> and <!-- graphql-schema-notes:end -->. Description text outside the markers remains unchanged. Fork and Dependabot PRs use the job summary and artifact because restricted workflow tokens cannot update PR descriptions.

No differences produces a “No schema changes” report. Until the selected main commit contains schema.graphql, PR and push comparisons download the baseline from https://api.platform.opentargets.xyz/latest/graphql/schema. Reports identify the deployment fallback and download time. Once main contains schema.graphql, comparisons use the committed main snapshot. A missing snapshot in the PR or pushed commit produces a “Schema comparison unavailable” report naming the missing side. Release comparisons require saved snapshots from both release tags. Schema jobs are non-blocking, including reports containing breaking changes. Execution errors remain visible in workflow logs. Other CI checks operate independently.

Read release notes

Publishing a GitHub release triggers a comparison between the saved schemas in the previous and new release tags. Stable releases compare with the previous published stable release. Prereleases compare with the previous published release, including prereleases. Release publication timestamps determine the previous release.

CI adds the schema report to the release description between the GraphQL schema markers, preserving surrounding release text. The job summary and artifact also contain the report. Schema reporting runs independently of release image builds. The first release reports the absence of a previous release; missing historical snapshots produce an unavailable-comparison report.

About

Open Targets Platform API

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages