Skip to content

Correct events.list schema: type filter values and count maximum - #2

Open
brodkin wants to merge 1 commit into
egnyte:masterfrom
brodkin:fix/events-schema-accuracy
Open

Correct events.list schema: type filter values and count maximum#2
brodkin wants to merge 1 commit into
egnyte:masterfrom
brodkin:fix/events-schema-accuracy

Conversation

@brodkin

@brodkin brodkin commented Jul 23, 2026

Copy link
Copy Markdown

Summary

The events.list schema documents two query_params incorrectly. Since the tool instructs agents to run egnyte schema <op> and trust it instead of external documentation, these errors lead agents to build requests the API rejects.

type

The schema describes the type filter as pipe-separated create|move|delete|edit|lock|unlock|restore. The events API rejects every one of those values:

$ egnyte events list --json '{"id":<id>,"type":"create"}'
HTTP 400: 'create' is not a valid parameter value. Must be one of: [file_system, note, permission_change]

create, move, delete and similar are action values that appear on each returned event, not values the type parameter accepts. The valid categories are file_system, note, and permission_change, which matches Egnyte's Events API documentation. A filter such as type=create|move returns an error rather than the intended events.

count

The count description states default 20 with no maximum. The API enforces a maximum of 100:

$ egnyte events list --json '{"id":<id>,"count":1000}'
HTTP 400: Value must be between 1 and 100

The search and search advanced operations already document max 100. This change brings events.list in line.

Changes

  • type description corrected to the categories the API accepts, with a note that action values are not valid there.
  • count description now states the maximum of 100.
  • Example updated to use a valid type value.

The events.list schema documented the `type` filter as accepting
create|move|delete|edit|lock|unlock|restore. The events API rejects all of
these with HTTP 400. Those are per-event `action` values; the `type`
parameter accepts event categories only: file_system, note, or
permission_change. Because agents are instructed to trust the schema over
external docs, this caused a filtered query to fail or return nothing.

Also document the count maximum (100), which the API enforces and the
search operations already state, and update the example to use a valid
type value.
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.

1 participant