update rules samples#1138
Draft
eschultink wants to merge 16 commits into
Draft
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates documentation rule samples and example API responses across multiple sources (Slack, Google Workspace, Cursor, ChatGPT Enterprise, Windsurf), primarily to standardize formatting and expand/align schema/rule coverage for additional endpoints and fields.
Changes:
- Added/updated YAML rule definitions (endpoints, transforms, and response schemas) for Slack Discovery, Google Workspace (Calendar/Gmail/Meet/Gemini), and Cursor.
- Added new “original” and “sanitized” example API response JSON files for the above sources.
- Reformatted several existing sanitized JSON examples for consistent JSON style.
Reviewed changes
Copilot reviewed 36 out of 46 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/sources/windsurf/example-api-responses/sanitized/UserPageAnalytics.json | JSON formatting normalization for sanitized example. |
| docs/sources/slack/example-api-responses/sanitized/discovery-users-list.json | New sanitized Slack discovery users list example. |
| docs/sources/slack/example-api-responses/sanitized/discovery-user-conversations.json | New sanitized Slack discovery user conversations example. |
| docs/sources/slack/example-api-responses/sanitized/discovery-enterprise-info.json | New sanitized Slack discovery enterprise info example. |
| docs/sources/slack/example-api-responses/sanitized/discovery-conversations-recent.json | New sanitized Slack discovery recent conversations example. |
| docs/sources/slack/example-api-responses/sanitized/discovery-conversations-list.json | New sanitized Slack discovery conversations list example. |
| docs/sources/slack/example-api-responses/sanitized/discovery-conversations-info.json | New sanitized Slack discovery conversations info example. |
| docs/sources/slack/example-api-responses/sanitized/discovery-conversations-history.json | New sanitized Slack discovery conversations history example. |
| docs/sources/slack/example-api-responses/original/discovery-users-list.json | New original Slack discovery users list example. |
| docs/sources/slack/example-api-responses/original/discovery-user-conversations.json | New original Slack discovery user conversations example. |
| docs/sources/slack/example-api-responses/original/discovery-enterprise-info.json | New original Slack discovery enterprise info example. |
| docs/sources/slack/example-api-responses/original/discovery-conversations-recent.json | New original Slack discovery recent conversations example. |
| docs/sources/slack/example-api-responses/original/discovery-conversations-list.json | New original Slack discovery conversations list example. |
| docs/sources/slack/example-api-responses/original/discovery-conversations-info.json | New original Slack discovery conversations info example. |
| docs/sources/slack/example-api-responses/original/discovery-conversations-history.json | New original Slack discovery conversations history example. |
| docs/sources/slack/discovery.yaml | New Slack discovery rules + schemas for multiple endpoints. |
| docs/sources/google-workspace/google-meet/google-meet_no-app-ids.yaml | New Meet rules variant (no-app-ids) including transforms and schemas. |
| docs/sources/google-workspace/google-meet/google-meet.yaml | New Meet rules variant including transforms, path parameter schema, and response schema. |
| docs/sources/google-workspace/google-meet/example-api-responses/sanitized_no-app-ids/admin_reports_v1_activity_users_all_applications_meet.json | New sanitized Meet example (no-app-ids). |
| docs/sources/google-workspace/google-meet/example-api-responses/sanitized/admin_reports_v1_activity_users_all_applications_meet.json | New sanitized Meet example (with app ids). |
| docs/sources/google-workspace/gmail/gmail.yaml | Reordered transforms and added response schemas for Gmail endpoints. |
| docs/sources/google-workspace/gmail/example-api-responses/sanitized/messages.json | JSON formatting normalization for sanitized messages list example. |
| docs/sources/google-workspace/gmail/example-api-responses/sanitized/message.json | JSON formatting normalization for sanitized message example. |
| docs/sources/google-workspace/gemini-in-workspace-apps/gemini-in-workspace-apps_no-app-ids.yaml | Schema tweak (intValue type) for Gemini rules (no-app-ids). |
| docs/sources/google-workspace/gemini-in-workspace-apps/gemini-in-workspace-apps.yaml | Parameter schema key change + schema tweak (intValue type) for Gemini rules. |
| docs/sources/google-workspace/gemini-in-workspace-apps/example-api-responses/sanitized_no-app-ids/admin_reports_v1_activity_users_{userKey}_applications_gemini_in_workspace_apps.json | JSON formatting normalization for sanitized Gemini example (no-app-ids). |
| docs/sources/google-workspace/gemini-in-workspace-apps/example-api-responses/sanitized/admin_reports_v1_activity_users_{userKey}_applications_gemini_in_workspace_apps.json | JSON formatting normalization for sanitized Gemini example. |
| docs/sources/google-workspace/calendar/example-api-responses/sanitized/event.json | JSON formatting + content adjustments for sanitized Calendar event example. |
| docs/sources/google-workspace/calendar/example-api-responses/sanitized/calendarList.json | Simplified + reformatted sanitized Calendar list example. |
| docs/sources/google-workspace/calendar/example-api-responses/sanitized/calendar.json | New sanitized Calendar “get calendar” example. |
| docs/sources/google-workspace/calendar/example-api-responses/original/calendar.json | New original Calendar “get calendar” example. |
| docs/sources/google-workspace/calendar/calendar.yaml | Major Calendar rules update: endpoints, query params, transforms, and detailed schemas. |
| docs/sources/cursor/example-api-responses/sanitized/team-members.json | JSON formatting + additional fields in sanitized Cursor team members example. |
| docs/sources/cursor/example-api-responses/sanitized/filtered-usage-events.json | JSON formatting + additional fields in sanitized Cursor usage events example. |
| docs/sources/cursor/example-api-responses/sanitized/daily-usage-data.json | JSON formatting normalization for sanitized daily usage example. |
| docs/sources/cursor/example-api-responses/original/team-members.json | Added fields to original Cursor team members example. |
| docs/sources/cursor/example-api-responses/original/filtered-usage-events.json | Minor formatting + added fields to original Cursor usage events example. |
| docs/sources/cursor/cursor.yaml | Cursor rules update: allowedMethods, added pseudonymization path, schema additions. |
| docs/sources/chatgpt-enterprise/example-api-responses/sanitized/users.json | JSON formatting normalization for sanitized users example. |
| docs/sources/chatgpt-enterprise/example-api-responses/sanitized/projects.json | JSON formatting normalization for sanitized projects example. |
| docs/sources/chatgpt-enterprise/example-api-responses/sanitized/conversations.json | JSON formatting + structure adjustments for sanitized conversations example. |
| docs/sources/chatgpt-enterprise/example-api-responses/sanitized/conversation-messages.json | JSON formatting normalization for sanitized conversation messages example. |
| docs/sources/chatgpt-enterprise/example-api-responses/sanitized/automations.json | JSON formatting normalization for sanitized automations example. |
| docs/sources/chatgpt-enterprise/example-api-responses/original/conversations.json | Adjusted original conversations example structure (removed embedded file metadata block). |
Comments suppressed due to low confidence (1)
docs/sources/google-workspace/gemini-in-workspace-apps/gemini-in-workspace-apps.yaml:26
pathParameterSchemas.userKeyusesor, butoris marked deprecated incom.avaulta.gateway.rules.ParameterSchema(useanyOfinstead;oris slated for removal perParameterSchemaUtils). Since this PR changesanyOf->or, it increases future break risk; please keep/useanyOfhere (and elsewhere) going forward.
pathParameterSchemas:
userKey:
or:
- type: "string"
enum:
- "all"
- type: "integer"
pattern: "^[0-9]+$"
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - !<redactExceptPhrases> | ||
| jsonPaths: | ||
| - "$.items[*].summary" | ||
| - "$.items[*]summary" |
| email: | ||
| type: "string" | ||
| id: | ||
| type: "integer" |
Member
Author
There was a problem hiding this comment.
@copilot is that correct? is schema filter applied AFTER data transform from proxy?
Comment on lines
+266
to
+270
| is_member: | ||
| type: "boolean" | ||
| is_moved: | ||
| type: "boolean" | ||
| is_mpim: |
Contributor
|
@eschultink I've opened a new pull request, #1140, to work on those changes. Once the pull request is ready, I'll request review from you. |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
eschultink
commented
Mar 18, 2026
Member
Author
There was a problem hiding this comment.
ugh, big changes/re-ordering of endpoints makes this a challenge to read. need to carefully review the output data.
# Conflicts: # docs/sources/zoom/example-api-responses/sanitized/list-user-meetings.json # docs/sources/zoom/example-api-responses/sanitized/list-users.json # docs/sources/zoom/example-api-responses/sanitized/meeting-details.json # docs/sources/zoom/example-api-responses/sanitized/past-meeting-participants.json # docs/sources/zoom/example-api-responses/sanitized/report-meeting-participants.json # docs/sources/zoom/example-api-responses/sanitized/report-user-meetings.json # docs/sources/zoom/example-api-responses/sanitized/user-settings.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
draft for now, as a bunch of style updates that we need to fix styling unification.
Fixes
Features
Logistics
Change implications
CHANGELOG.mdanything that will show up interraform plan/applythat isn'tobviously a no-op?
alpha, requires major versionchange: No breaking changes are introduced with this update. The changes are backward-compatible and aim to enhance clarity and usability of examples.