[DOCS-15167] The parameter type is not included in the docs for the Realm Admin API section Logs Created: 10/Mar/22  Updated: 04/Jan/23  Resolved: 11/Mar/22

Status: Closed
Project: Documentation
Component/s: Realm
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Major - P3
Reporter: Josman Perez Exposito Assignee: Nathan Contino (Inactive)
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Participants:
Days since reply: 1 year, 47 weeks, 6 days ago
Story Points: 2

 Description   

Hello team,

In the documentation for Logs in the Admin API for Realm, there is no mention of the parameter type which can hold different values in relation to what type of logs we want to retrieve.

Some of the values could be the following, but there is more

AUTH_TRIGGER,DB_TRIGGER,SCHEDULED_TRIGGER,GRAPHQL,SYNC_CONNECTION_START,SYNC_CONNECTION_END,SYNC_SESSION_START,SYNC_SESSION_END,SYNC_CLIENT_WRITE,SYNC_ERROR,SYNC_OT

Also the parameter type error_only it specified to be a boolean but the response will not depend on the boolean value but on the mere presence of this parameter in the query. So, if you don't want the errors to be returned in the response you need to remove error_only altogether instead of assigning a value of false. I think this is confusing and not accurate with the description of this parameter in the docs.

Thanks!

 


Generated at Thu Feb 08 08:12:11 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.