Skip to content

Terminology Renames - #59

Merged
ThanKarab merged 3 commits into
masterfrom
feat/terminology_refactor_v2
Nov 17, 2026
Merged

ThanKarab merged 3 commits into
masterfrom
feat/terminology_refactor_v2

Conversation

@ThanKarab

Copy link
Copy Markdown
Contributor

Summary

Renames backend terminology to Study → Analysis Group → Analysis, including APIs, DTOs, Java packages, persistence, tests, and documentation.

Preserves the existing preview/run/save workflow, execution results, ownership, sharing, authorization, timestamps, ordering, and memberships. Separates platform Analysis management from Exaflow integration through AnalysisExecutionService.

Breaking API changes

Clients must switch to the new contract. No deprecated route or field aliases are provided.

Previous New
/services/experiments /services/analyses
/services/experiment-folders /services/studies
Nested /sets routes Nested /groups routes
Membership /set routes Membership /group routes
Complete execution payload analysis analysisRequest
experiments analyses
totalExperiments totalAnalyses
folders studies
sets groups
experimentIds analysisIds
experimentUuid analysisId
folderId studyId
setId groupId

Preview and run now accept { name, analysisRequest }. Save continues to accept { runId, name }.

Root Analysis uuid, Study/group id, pagination fields currentPage and totalPages, and existing identifier values remain unchanged.

Backend Pathology exceptions and messages now use Data Model terminology. Data-model listing retains 404 for no available models and 403 for no accessible models; clients should use status codes in that request context rather than match message text.

Configuration renames

Deployment overrides must use the new names. Old names have no fallback aliases.

Previous New
EXPERIMENT_RUN_DRAFT_TTL ANALYSIS_RUN_DRAFT_TTL
experiments.run-draft-ttl analyses.run-draft-ttl
authentication.all_experiments_allowed_claim authentication.all_analyses_allowed_claim

Preserve each deployment’s configured TTL; the default remains PT24H. Move custom claim-setting overrides to the new property.

authentication:
  all_analyses_allowed_claim: research_experiment_all

analyses:
  run-draft-ttl: ${ANALYSIS_RUN_DRAFT_TTL:PT24H}

research_experiment_all is intentionally unchanged. It is the existing external authorization authority; Keycloak roles, token authorities, and access grants must remain intact.

Database and deployment

Adds Flyway V6 without modifying shipped migrations:

  • Renames tables to analysis, analysis_run, study, analysis_group, and study_member.
  • Renames complete-request columns to analysis_request.
  • Renames membership references, position columns, constraints, indexes, and the dataset-authorization function.
  • Preserves stored records and request/result text, including unsaved runs.

Deploy with the matching UI and renamed configuration. Old backend instances cannot run against the V6 schema. Rollback requires restoring the pre-migration database and matching application/configuration versions together.

The Exaflow endpoint, unwrapped execution request structure, nested algorithm, algorithm_id, and result formats remain unchanged.

Validation

  • 200 unit/HTTP tests passed
  • 4 PostgreSQL integration tests passed, covering fresh/populated migrations, retained runs, authorization parity, and Study/group operations
  • Clean Maven package build passed
  • Added PostgreSQL CI coverage and deployment/rollback documentation

@KFilippopolitis KFilippopolitis left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@ThanKarab
ThanKarab force-pushed the feat/terminology_refactor_v2 branch from 29fbe7e to b937693 Compare November 17, 2026 10:27
@ThanKarab
ThanKarab merged commit 3e3b5aa into master Nov 17, 2026
15 checks passed
@ThanKarab
ThanKarab deleted the feat/terminology_refactor_v2 branch November 17, 2026 11:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants