add v2 event type schema and updates endpoints by JoshuaVulcan · Pull Request #25 · PADAS/er-client

JoshuaVulcan · 2026-02-10T23:42:31Z

Summary

Adds _v2_url() helper to both ERClient and AsyncERClient that constructs URLs against the v2.0 API root
Adds three new methods to both sync and async clients:
- get_event_type_schema(value, pre_render=False) -- single event type schema via eventtypes/{value}/schema
- get_event_type_updates(value) -- revision history via eventtypes/{value}/updates
- get_event_type_schemas(pre_render=False) -- bulk schema list via eventtypes/schemas
Teaches AsyncERClient._call() to skip _er_url() when the path is already an absolute URL
8 new tests covering success, pre_render param, 404, and timeout scenarios

Test plan

all 98 tests pass (90 existing + 8 new)

Adds _v2_url() helper to both ERClient and AsyncERClient, which constructs URLs against the v2.0 API root by swapping the version segment in service_root. New methods on both clients: - get_event_type_schema(value, pre_render) -- single event type schema - get_event_type_updates(value) -- revision history for an event type - get_event_type_schemas(pre_render) -- bulk schema list Also teaches AsyncERClient._call() to skip _er_url() when the path is already an absolute URL, enabling the v2 methods to pass full URLs. ERA-12658 Co-authored-by: Cursor <cursoragent@cursor.com>

Replace the brittle `_v2_url()` regex-based v2 URL construction with the cleaner `_api_root(version)` + `base_url` parameter pattern from PR #23. This adds `_api_root()`, updates `_er_url()` to accept a `base_url` param, and threads `base_url` through `_get`, `_post`, `_patch`, and `_call` on both sync and async clients. Reverts the `path.startswith('http')` guard in async `_call()` in favor of the `base_url` approach which is explicit and non-magical. Co-authored-by: Cursor <cursoragent@cursor.com>

JoshuaVulcan · 2026-02-11T16:46:46Z

V2 URL Convention Alignment

Replaced the _v2_url() regex-based v2 URL construction with the _api_root(version) + base_url parameter pattern established in PR #23.

Changes:

Removed _v2_url() from both ERClient and AsyncERClient
Added _api_root(version) method to both clients (strips /api/vX.Y from service_root and rebuilds as {base}/api/{version})
Updated _er_url() to accept an optional base_url parameter
Threaded base_url through _get, _post, _patch, and _call on both sync and async clients
Updated get_event_type_schema(), get_event_type_updates(), get_event_type_schemas() to use base_url=self._api_root('v2.0') instead of constructing full URLs via _v2_url()
Reverted the path.startswith('http') guard in async _call() — the base_url approach is explicit and non-magical

Tests are unchanged since the resulting URLs are identical. This PR is now compatible with PR #23's infrastructure and will merge cleanly once #23 lands.

Copilot

Pull request overview

This PR adds support for three new v2 API endpoints related to event type schemas and updates. The implementation introduces a new _api_root() helper method in both sync and async clients to construct URLs against different API versions, and adds methods to fetch event type schemas (single and bulk) and revision history.

Changes:

Adds _api_root() helper to construct versioned API URLs (v1.0, v2.0, etc.)
Implements three new methods: get_event_type_schema(), get_event_type_updates(), and get_event_type_schemas() in both sync and async clients
Updates _er_url(), _get(), _post(), _patch(), and _call() methods to accept optional base_url parameter for API versioning
Adds comprehensive test coverage (8 tests) for async client implementations

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.

File	Description
erclient/client.py	Adds `_api_root()` helper and three new v2 API methods to both ERClient and AsyncERClient classes; updates internal HTTP methods to support custom base URLs
tests/async_client/test_get_event_type_schema.py	Comprehensive test suite (8 tests) covering success, error, parameter, and timeout scenarios for the new async client methods

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-12T01:25:52Z

erclient/client.py

+    def get_event_type_schema(self, event_type_value, pre_render=False):
+        """
+        Get the schema for a single event type (v2 API).
+
+        :param event_type_value: The event type 'value' identifier (e.g. 'rainfall_rep')
+        :param pre_render: If True, return the pre-rendered schema
+        """
+        return self._get(
+            f'eventtypes/{event_type_value}/schema',
+            base_url=self._api_root('v2.0'),
+            params={'pre_render': pre_render},
+        )
+
+    def get_event_type_updates(self, event_type_value):
+        """
+        Get the revision history for a single event type (v2 API).
+
+        :param event_type_value: The event type 'value' identifier
+        """
+        return self._get(
+            f'eventtypes/{event_type_value}/updates',
+            base_url=self._api_root('v2.0'),
+        )
+
+    def get_event_type_schemas(self, pre_render=False):
+        """
+        Get schemas for all event types in bulk (v2 API).
+
+        :param pre_render: If True, return pre-rendered schemas
+        """
+        return self._get(
+            'eventtypes/schemas',
+            base_url=self._api_root('v2.0'),
+            params={'pre_render': pre_render},
+        )


The new sync client methods get_event_type_schema, get_event_type_updates, and get_event_type_schemas lack test coverage. While there are 8 comprehensive tests for the async versions of these methods, there are no corresponding tests for the sync client. The repository shows a pattern of comprehensive testing for the async client but lacks tests for the sync client entirely. Consider adding test coverage for the sync client methods to match the async client test coverage.

Copilot · 2026-02-12T01:25:53Z

tests/async_client/test_get_event_type_schema.py

+import re
+


The re module is imported but never used in this test file. Consider removing this unused import.

Suggested change

import re

Copilot · 2026-02-12T01:25:53Z

tests/async_client/test_get_event_type_schema.py

+            return_value=httpx.Response(httpx.codes.OK, json={"data": schema_response})
+        )
+        result = await er_client.get_event_type_schema("rainfall_rep", pre_render=True)
+        assert route.called


Variable result is not used.

Suggested change

assert route.called

assert route.called

assert result == schema_response

Copilot · 2026-02-12T01:25:53Z

tests/async_client/test_get_event_type_schema.py

+        route = respx_mock.get("/eventtypes/schemas").mock(
+            return_value=httpx.Response(httpx.codes.OK, json=schemas_bulk_response)
+        )
+        result = await er_client.get_event_type_schemas(pre_render=True)


Variable result is not used.

Suggested change

result = await er_client.get_event_type_schemas(pre_render=True)

await er_client.get_event_type_schemas(pre_render=True)

Co-authored-by: Cursor <cursoragent@cursor.com>

chrisdoehring · 2026-03-13T18:17:34Z

erclient/client.py

+    def get_event_type_schema(self, event_type_value, pre_render=False):
+        """
+        Get the schema for a single event type (v2 API).
+
+        :param event_type_value: The event type 'value' identifier (e.g. 'rainfall_rep')
+        :param pre_render: If True, return the pre-rendered schema
+        """
+        return self._get(
+            f'eventtypes/{event_type_value}/schema',
+            base_url=self._api_root('v2.0'),
+            params={'pre_render': pre_render},
+        )
+
+    def get_event_type_updates(self, event_type_value):
+        """
+        Get the revision history for a single event type (v2 API).
+
+        :param event_type_value: The event type 'value' identifier
+        """
+        return self._get(
+            f'eventtypes/{event_type_value}/updates',
+            base_url=self._api_root('v2.0'),
+        )
+
+    def get_event_type_schemas(self, pre_render=False):
+        """
+        Get schemas for all event types in bulk (v2 API).
+
+        :param pre_render: If True, return pre-rendered schemas
+        """
+        return self._get(
+            'eventtypes/schemas',
+            base_url=self._api_root('v2.0'),
+            params={'pre_render': pre_render},
+        )


Is this indicative of v1 EOL?
And you might want to use the VERSION_2_0 constant for these.

JoshuaVulcan requested review from chrisdoehring and chrisj-er February 10, 2026 23:42

JoshuaVulcan added autoreviewing PR is currently being auto-reviewed and removed autoreviewing PR is currently being auto-reviewed labels Feb 11, 2026

JoshuaVulcan requested a review from Copilot February 12, 2026 01:20

Copilot started reviewing on behalf of JoshuaVulcan February 12, 2026 01:21 View session

Copilot AI reviewed Feb 12, 2026

View reviewed changes

Merge main to resolve conftest and infra conflicts

1ebdc62

Co-authored-by: Cursor <cursoragent@cursor.com>

JoshuaVulcan requested a review from a team as a code owner February 12, 2026 01:33

Merge main into ERA-12658/v2-event-type-schema-updates

6d8aeab

chrisdoehring reviewed Mar 13, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add v2 event type schema and updates endpoints#25

add v2 event type schema and updates endpoints#25
JoshuaVulcan wants to merge 4 commits intomainfrom
ERA-12658/v2-event-type-schema-updates

JoshuaVulcan commented Feb 10, 2026 •

edited by atlassian bot

Loading

Uh oh!

JoshuaVulcan commented Feb 11, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Feb 12, 2026

Uh oh!

Copilot AI Feb 12, 2026

Uh oh!

Copilot AI Feb 12, 2026

Uh oh!

Copilot AI Feb 12, 2026

Uh oh!

chrisdoehring Mar 13, 2026 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	assert route.called
	assert route.called
	assert result == schema_response

	result = await er_client.get_event_type_schemas(pre_render=True)
	await er_client.get_event_type_schemas(pre_render=True)

Conversation

JoshuaVulcan commented Feb 10, 2026 • edited by atlassian bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Test plan

Uh oh!

JoshuaVulcan commented Feb 11, 2026

V2 URL Convention Alignment

Changes:

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

chrisdoehring Mar 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

JoshuaVulcan commented Feb 10, 2026 •

edited by atlassian bot

Loading

chrisdoehring Mar 13, 2026 •

edited

Loading