Correct events.list schema: type filter values and count maximum - #2
Open
brodkin wants to merge 1 commit into
Open
Correct events.list schema: type filter values and count maximum#2brodkin wants to merge 1 commit into
brodkin wants to merge 1 commit into
Conversation
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.
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.
Summary
The
events.listschema documents twoquery_paramsincorrectly. Since the tool instructs agents to runegnyte schema <op>and trust it instead of external documentation, these errors lead agents to build requests the API rejects.type
The schema describes the
typefilter as pipe-separatedcreate|move|delete|edit|lock|unlock|restore. The events API rejects every one of those values:create,move,deleteand similar areactionvalues that appear on each returned event, not values thetypeparameter accepts. The valid categories arefile_system,note, andpermission_change, which matches Egnyte's Events API documentation. A filter such astype=create|movereturns an error rather than the intended events.count
The
countdescription statesdefault 20with no maximum. The API enforces a maximum of 100:The
searchandsearch advancedoperations already documentmax 100. This change bringsevents.listin line.Changes
typedescription corrected to the categories the API accepts, with a note that action values are not valid there.countdescription now states the maximum of 100.typevalue.