From 22540223c43342473d7d428dffeeab9d94afb55c Mon Sep 17 00:00:00 2001 From: Pjotr Date: Thu, 8 Oct 2026 11:24:58 +0000 Subject: * src/response.rs: wrap every success response in one envelope. Breaking: every success body is now {"data", "meta": {"state", "took_ms", "request_id"}, "notes", "next"}; clients read `data`. Only `/` (plain text) and `/openapi.json` are unwrapped. * src/response.rs (Envelope, Meta, State, Ctx, RequestInfo): handlers take Ctx first and build the response with ctx.envelope(data), so timing and the request id are never filled in by hand. `state` is `complete` or `partial`; notes are server-authored only; `next` are concrete relative hrefs (path_segment percent-encodes names). * src/routes/*.rs, src/lib.rs (version): every handler returns Envelope<..> with next links; /search is `partial` when the locus lookup fails or a sorted 1000-hit window may be truncated, and /publications/{pubmed_id}/traits when datasets were left out for authorization. * src/error.rs (ApiError): add `took_ms`, an RFC 7807 extension member. * src/auth.rs (AuthToken): the 401 now carries request_id and took_ms (it never had a request_id); Ctx stores RequestInfo in the request extensions for it. * tests: common::data / envelope_data parse every success body through the envelope; tests/envelope.rs and test/python/test_envelope.py check the shape, errors, and that every `next` link resolves; tests/envelope_partial.rs checks the `partial` search without a database; tests/openapi.rs fails if a JSON success response is not an Envelope_* schema. * README.md, docs/SKILL.md, docs/gn-auth.md, RELEASE_NOTES.md: document the envelope and took_ms on errors. Co-Authored-By: Claude Sonnet 5.5 --- test/python/test_version.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'test/python/test_version.py') diff --git a/test/python/test_version.py b/test/python/test_version.py index 2fb46e9..32f08d5 100644 --- a/test/python/test_version.py +++ b/test/python/test_version.py @@ -4,7 +4,7 @@ import http.client import json import unittest -from server_test_case import HOST, PORT, ServerTestCase +from server_test_case import HOST, PORT, ServerTestCase, envelope_data class VersionTest(ServerTestCase): @@ -18,7 +18,7 @@ class VersionTest(ServerTestCase): conn.close() self.assertEqual(response.status, 200) - record = json.loads(body) + record = envelope_data(body) self.assertEqual(record["name"], "GeneNetwork4") self.assertEqual(record["short_name"], "GN4AI") self.assertEqual(record["version"], 4.0) -- cgit 1.4.1