aodocs / endpoints-partialresponse Goto Github PK

Currently, the "checkFieldsExpression=false|true" servlet parameter allows an implementor to return an error an an API request containing an invalid field expression is received.

There should be a way to have more control over the action when receiving an invalid field expression.
For example:

• checkFieldsExpression=false => do nothing (current implementation)
• checkFieldsExpression=log => logs as warn in server logs
• checkFieldsExpression=headerOutput => same as "log", and returns an error in the response header "X-Endpoints-invalidFieldsExpression" so the requestor can check what is wrong
• checkFieldsExpression=true => return an error (current implementation)

Example:

• Source document: https://content.googleapis.com/discovery/v1/apis/drive/v3/rest
• Fields expression: schemas/*/id/*
• Current projects response: {}
• Google response:

{"schemas":{"About":{"id":"About"},"Change":{"id":"Change"},"ChangeList":{"id":"ChangeList"},"Channel":{"id":"Channel"},"Comment":{"id":"Comment"},"CommentList":{"id":"CommentList"},"File":{"id":"File"},"FileList":{"id":"FileList"},"GeneratedIds":{"id":"GeneratedIds"},"Permission":{"id":"Permission"},"PermissionList":{"id":"PermissionList"},"Reply":{"id":"Reply"},"ReplyList":{"id":"ReplyList"},"Revision":{"id":"Revision"},"RevisionList":{"id":"RevisionList"},"StartPageToken":{"id":"StartPageToken"},"TeamDrive":{"id":"TeamDrive"},"TeamDriveList":{"id":"TeamDriveList"},"User":{"id":"User"}}}