Zoom rules with YAML by aperez-worklytics · Pull Request #1078 · Worklytics/psoxy

aperez-worklytics · 2026-01-02T08:35:52Z

Using Zoom rules from generated ones. Some endpoints have been removed as they are not used.

As draft, until discuss field revision.

Fixes

paste links to issues/tasks in project management

Features

Zoom: use YAML rules

Logistics

paste links to issues/tasks in project management

Change implications

dependencies added/changed? no
something important to note in future release notes?
- NOTE in CHANGELOG.md anything that will show up in terraform plan/apply that isn't
  obviously a no-op? yes; zoom rules updated
- breaking changes? if in module/example that is NOT marked alpha, requires major version
  change no

Bumps [org.apache.httpcomponents.client5:httpclient5](https://github.com/apache/httpcomponents-client) from 5.4.1 to 5.4.3. - [Changelog](https://github.com/apache/httpcomponents-client/blob/rel/v5.4.3/RELEASE_NOTES.txt) - [Commits](apache/httpcomponents-client@rel/v5.4.1...rel/v5.4.3) --- updated-dependencies: - dependency-name: org.apache.httpcomponents.client5:httpclient5 dependency-version: 5.4.3 dependency-type: direct:production ... Signed-off-by: dependabot[bot] <support@github.com>

…y-core/org.apache.httpcomponents.client5-httpclient5-5.4.3 bump apache httpclient5 from 5.4.1 to 5.4.3

* Update rules * Support example with POST

* apache commons codec to 1.19.0 * more dep updates

* add logic to keep lambdas warm * fix style * init public keys in mem for webhook collectors on start-up

* aws replace tool * add documentation

* improve webhook collector mode configuration * support webhook output prefix * fix style * fix path stuff * fix missed rename * fix various test issues

* deal with empty header case more correctly; that's quite clearly a bug * add test of empty CC case

# Conflicts: # infra/examples-dev/aws/google-workspace.tf # infra/examples-dev/aws/main.tf # infra/examples-dev/aws/msft-365.tf # infra/examples-dev/gcp/google-workspace.tf # infra/examples-dev/gcp/main.tf # infra/examples-dev/gcp/msft-365.tf # infra/modules/aws-host/variables.tf # infra/modules/worklytics-connector-specs/main.tf # java/core/src/main/java/co/worklytics/psoxy/gateway/impl/HealthCheckRequestHandler.java # java/pom.xml # tools/init-tfvars.sh

Copilot

Pull request overview

This PR migrates Zoom rules from Java-based definitions to YAML configuration, adding response schemas for better API contract enforcement while removing endpoints and fields that are not used.

Key Changes:

Replaced hardcoded Java Zoom rule definitions with YAML-based configuration
Removed /users/{userId}/settings and /report/meetings/{meetingId} endpoints
Added response schemas and allowed query parameters to endpoint definitions

Reviewed changes

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

Show a summary per file

File	Description
`java/core/src/main/java/co/worklytics/psoxy/rules/zoom/PrebuiltSanitizerRules.java`	Replaced hardcoded endpoint rules with YAML file loading
`docs/sources/zoom/zoom.yaml`	Added comprehensive YAML rule definitions with response schemas and query parameter controls
`java/core/src/test/java/co/worklytics/psoxy/rules/zoom/ZoomRulesTests.java`	Removed tests for deprecated endpoints and disabled YAML length validation test
`docs/sources/zoom/example-api-responses/sanitized/*.json`	Updated sanitized examples to reflect removed fields (`pmi`, `phone_number`, etc.)
`docs/sources/zoom/example-api-responses/original/*.json`	Removed original examples for deprecated endpoints
`CHANGELOG.md`	Documented Zoom rules update for v0.5.16

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

Copilot · 2026-01-02T08:36:32Z

docs/sources/zoom/zoom.yaml

+          type: "string"
+        uuid:
+          type: "string"
+  - pathTemplate: "/v2/past_meetings/{occurrenceUuid}/instances"


The path parameter is named {occurrenceUuid} in this endpoint but other endpoints use {meetingId} or {userId}. The Java test at line 36 still references /v2/past_meetings/MEETING_ID/instances. This inconsistency between the YAML parameter name and test URL suggests the parameter should be {meetingId} for consistency, unless the API specifically requires UUID format here.

Copilot · 2026-01-02T08:36:32Z

docs/sources/zoom/zoom.yaml

+          type: "integer"
+        total_records:
+          type: "integer"
+  - pathTemplate: "/v2/past_meetings/{occurrenceUuid}/participants"


Similar to the instances endpoint, this uses {occurrenceUuid} while the Java test at line 47-49 uses MEETING_ID. The parameter naming should be consistent across related endpoints unless there's a specific API requirement for UUID format.

Copilot · 2026-01-02T08:36:32Z

docs/sources/zoom/zoom.yaml

+            $ref: "#/definitions/MeetingParticipant"
+        total_records:
+          type: "integer"
+  - pathTemplate: "/v2/report/meetings/{occurrenceUuid}/participants"


This endpoint also uses {occurrenceUuid} but the corresponding Java tests at lines 53-55 reference /v2/report/meetings/{meetingId}/participants. The parameter should consistently be named {meetingId} across all similar endpoints.

Suggested change

- pathTemplate: "/v2/report/meetings/{occurrenceUuid}/participants"

- pathTemplate: "/v2/report/meetings/{meetingId}/participants"

Copilot · 2026-01-02T08:36:33Z

java/core/src/test/java/co/worklytics/psoxy/rules/zoom/ZoomRulesTests.java

+    @Test
+    @Override
+    @Disabled
+    public void yamlLength() {
+        // Do nothing, as response schema is bigger than we allow for advanced parameters
+    }


The YAML length validation test has been disabled. If the response schema exceeds allowed limits for advanced parameters, this should be addressed rather than disabling the validation. Consider either: 1) splitting the schema into smaller parts, 2) increasing the limit if justified, or 3) documenting why this specific case requires an exception.

aperez-worklytics · 2026-01-02T08:38:09Z

docs/sources/zoom/example-api-responses/original/past-meeting-participants.json

      "id": "jjd93a2337",
      "name": "Joe Surname",
-      "user_email": "joe@example.com",
-      "pmi": 111111111


These pmi are not present in the responde model from API and not used in our source model. See https://developers.zoom.us/docs/api/meetings/#tag/meetings/get/past_meetings/{meetingId}/participants

ok, yeah - either this was present in the example json at some point, or we put it in there just to be SURE would be redacted if ever appeared in some zoom versions.

but the responseSchema approach achieves that now.

aperez-worklytics · 2026-01-02T08:42:44Z

docs/sources/zoom/example-api-responses/original/user-settings.json

Not used. Files, test and endpoint dropped.

aperez-worklytics · 2026-01-02T08:45:38Z

docs/sources/zoom/example-api-responses/sanitized/list-user-meetings.json

  "total_records":4,
  "meetings":[
    {
-      "uuid":"mlghmfghlBBB",


Same: not used and not present https://developers.zoom.us/docs/api/meetings/#tag/meetings/get/users/{userId}/meetings

aperez-worklytics · 2026-01-02T08:46:05Z

docs/sources/zoom/example-api-responses/sanitized/list-users.json

      "email":"t~8ZuLJANBU0hIFqmaE8RjwHZqRb4MezRyGZ6rLZUkKSg@example.com",
      "type":2,
      "pmi":"p~LKW3WIP3bZzEQFelvQBi0lpLDZtk-1qJbWe3rHfhYhdfeki-8voee3S0wopon6Y3",
-      "phone_number":"t~gYkykBgGMDuc3PCagpgnLxf71Bde2_7QuMV41oIRypc",


Not in the model

eschultink · 2026-01-04T16:26:11Z

history might benefit from rebasing this against latest rc-

eschultink · 2026-01-04T16:28:11Z

docs/sources/zoom/example-api-responses/original/past-meeting-participants.json

      "id": "jjd93a2337",
      "name": "Joe Surname",
-      "user_email": "joe@example.com",
-      "pmi": 111111111


ok, yeah - either this was present in the example json at some point, or we put it in there just to be SURE would be redacted if ever appeared in some zoom versions.

but the responseSchema approach achieves that now.

eschultink · 2026-01-04T16:31:18Z

docs/sources/zoom/example-api-responses/sanitized/report-user-meetings.json

  "page_number":1,
  "page_size":30,
  "total_records":20,
-  "from":"2020-07-14",


i guess we infer this from the API request? but that said I don't see a point to dropping it. Having it in there gives us flexibility to re-parse API responses without having the original request context.

there's value for that on both our side, as well as if customers use a side-output to capture all API responses.

eschultink · 2026-01-04T16:32:49Z

java/core/src/test/java/co/worklytics/psoxy/rules/zoom/ZoomRulesTests.java

+    @Test
+    @Override
+    @Disabled
+    public void yamlLength() {


🤔 we do need to be certain that, in gzip'd form, it fits within an advanced AWS SSM parameter.

dependabot bot and others added 18 commits October 28, 2025 18:17

prep v0.5.12

435a3fe

Merge pull request #1033 from Worklytics/dependabot/maven/java/gatewa…

4f1f9a1

…y-core/org.apache.httpcomponents.client5-httpclient5-5.4.3 bump apache httpclient5 from 5.4.1 to 5.4.3

Salesforce rules refresh (#1039)

09d846d

* Update rules * Support example with POST

bump many dependencies (#1038)

3db1ba1

* apache commons codec to 1.19.0 * more dep updates

webhook collector auth perf (#1036)

1cee218

* add logic to keep lambdas warm * fix style * init public keys in mem for webhook collectors on start-up

aws replay tool (#1034)

83e6fc4

* aws replace tool * add documentation

webhook collector output prefix support (#1035)

f3d556f

* improve webhook collector mode configuration * support webhook output prefix * fix style * fix path stuff * fix missed rename * fix various test issues

gmail empty header fix (#1040)

e4437dc

* deal with empty header case more correctly; that's quite clearly a bug * add test of empty CC case

Base rules

6b2873a

Meeting details

0ac4b59

Report meetings

4e25621

Using YAML instead of code rules

5a6db2d

Updated tests

6578689

Drop not used endpoints

fa56173

Updated zoom rules

d14dd4e

Updated CHANGELOG.md

4597fac

aperez-worklytics requested review from Copilot and eschultink January 2, 2026 08:35

aperez-worklytics self-assigned this Jan 2, 2026

Copilot AI reviewed Jan 2, 2026

View reviewed changes

aperez-worklytics commented Jan 2, 2026

View reviewed changes

eschultink approved these changes Jan 4, 2026

View reviewed changes

Base automatically changed from rc-v0.5.16 to main January 29, 2026 18:27

eschultink changed the base branch from main to rc-v0.5.17 January 29, 2026 20:28

Base automatically changed from rc-v0.5.17 to main February 10, 2026 20:53

eschultink changed the base branch from main to rc-v0.5.18 February 10, 2026 21:09

	- pathTemplate: "/v2/report/meetings/{occurrenceUuid}/participants"
	- pathTemplate: "/v2/report/meetings/{meetingId}/participants"

Conversation

aperez-worklytics commented Jan 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Fixes

Features

Logistics

Change implications

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Jan 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 2, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 2, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

eschultink commented Jan 4, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

aperez-worklytics commented Jan 2, 2026 •

edited

Loading