Skip to content

Conversation

@Paul-Joel
Copy link
Contributor

Motivation and Context

Code modifies the existing 'instrument' proxy endpoint to retrieve the validator_version from CIR via the v3/ci_metadata endpoint

What has changed

Where the instrument endpoint previously took the validator_version from the CIR retrieve_collection_instrument endpoint return, it now makes an additional call to the CIR /v3/ci_metadata endpoint to get the instruments metadata, and then uses the contained validator_version value.

How to test?

  1. Set the port number part of CIR_API_BASE_URL in your local .env file to 3030
  2. Locally start Proxy and Converter
  3. Pull and run the latest version of eq_cir_fastapi via Docker, following the instructions in the FastAPI repo
  4. Using the /docs url, load a questionnaire schema via the /v2/publish_collection_instrument endpoint
  5. From the 200 return metadata, copy the guid value.
  6. Using the url http://localhost:5050/instrument/guid?version=10.0.0, run proxy and confirm a successful return, replacing the guid with the one copied in step 5

Note this can also be run locally with eq-runner-mock-cir once the new endpoint is merged, by skipping step 1

Links

https://github.com/ONSdigital/eq-cir-fastapi
https://officefornationalstatistics.atlassian.net/browse/EQS-509

@Paul-Joel Paul-Joel marked this pull request as ready for review December 12, 2025 17:00
@Paul-Joel Paul-Joel requested review from a team as code owners December 12, 2025 17:00
petechd
petechd previously approved these changes Jan 29, 2026
@Paul-Joel Paul-Joel merged commit a84ed14 into main Jan 30, 2026
7 checks passed
@Paul-Joel Paul-Joel deleted the EQS-509-Get-validator_version-from-CIR branch January 30, 2026 13:50
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.

4 participants